Can it update files outside of the source code?

Yes, if your project has a dedicated /docs folder, the skill will check for and update corresponding markdown files that relate to the modified code.

Will it modify my project's README file?

No, the skill is explicitly instructed to ignore README.md, CHANGELOG.md, and LICENSE files to prevent unwanted changes to high-level project information.

Does it support multiple programming languages?

Yes, it detects the documentation style based on file extensions and existing patterns in the code, such as JSDoc for JavaScript or PHPDoc for PHP.

How does the skill identify which documentation needs updating?

The skill runs a git diff command to find uncommitted changes in your local environment, ensuring only the most recent modifications are documented.

Documentation Updater

Name: Documentation Updater
Author: anilcancakir

byanilcancakir

•

Learning & Documentation

Automatically updates inline code documentation and external markdown files based on your uncommitted git changes.

The Documentation Updater skill automates the tedious task of keeping technical documentation in sync with code changes. By analyzing uncommitted modifications via Git, it identifies new or altered functions, classes, and methods to generate or update relevant docblocks. The skill intelligently matches existing project styles—such as JSDoc or PHPDoc—and can even synchronize changes with external files in your repository's documentation folder, ensuring your project's reference material never falls behind your implementation.

Key Features

01Detects and matches existing documentation styles like JSDoc and PHPDoc

02Synchronizes external markdown files within the /docs directory

033 GitHub stars

04Identifies modified files automatically using git diff integration

05Updates inline docblocks for functions, classes, and methods

06Provides a detailed report of all added or updated documentation blocks

Use Cases

01Standardizing documentation patterns across a multi-language codebase

02Refreshing API documentation immediately after refactoring code

03Ensuring internal technical docs stay accurate during rapid feature development

Key Features

01Detects and matches existing documentation styles like JSDoc and PHPDoc

02Synchronizes external markdown files within the /docs directory

033 GitHub stars

04Identifies modified files automatically using git diff integration

05Updates inline docblocks for functions, classes, and methods

06Provides a detailed report of all added or updated documentation blocks

Use Cases

01Standardizing documentation patterns across a multi-language codebase

02Refreshing API documentation immediately after refactoring code

03Ensuring internal technical docs stay accurate during rapid feature development