Does it provide a summary of what was changed?

Yes, every execution concludes with a Documentation Update Report showing which files were modified, lines added, and lines deleted.

Can it extract API documentation from my code?

Yes, it is designed to scan your source code and extract relevant information to update your API.md file automatically.

How does the Documentation Updater know when to run?

The skill triggers automatically after feature implementations, before releases, or when you use commands like 'update docs' or '更新文件'.

Which documentation files are supported?

It supports standard project files like README.md, CHANGELOG.md, API.md, and ARCHITECTURE.md, as well as Memory Bank files like progress.md and decisionLog.md.

Documentation Updater

Name: Documentation Updater
Author: u9401066

byu9401066

Content Management

Synchronizes project documentation with code changes to ensure READMEs, changelogs, and API docs stay consistently up-to-date.

About

The doc-updater skill automates the maintenance of technical documentation by monitoring code changes and identifying necessary updates across various file types. It effectively handles everything from README instructions and CHANGELOG versioning to API documentation extraction and internal ARCHITECTURE guides. By integrating with Memory Bank files like activeContext and progress.md, it ensures that project state and development history are accurately recorded without manual overhead, making it an essential tool for maintaining high-quality, professional documentation throughout the software development lifecycle.

Key Features

Automatic synchronization of README and CHANGELOG files with new features
0 GitHub stars
API documentation extraction directly from source code implementation
Memory Bank integration for tracking project progress and decision logs
Multi-language support for command triggers in English and Chinese
Detailed update reports outlining specific changes and modified line counts

Use Cases

Generating and refreshing API documentation before a new version release
Automatically updating the README and CHANGELOG after a feature branch is merged
Syncing internal Memory Bank context files during intense coding sessions to maintain state

About

Key Features

Automatic synchronization of README and CHANGELOG files with new features
0 GitHub stars
API documentation extraction directly from source code implementation
Memory Bank integration for tracking project progress and decision logs
Multi-language support for command triggers in English and Chinese
Detailed update reports outlining specific changes and modified line counts

Use Cases

Generating and refreshing API documentation before a new version release
Automatically updating the README and CHANGELOG after a feature branch is merged
Syncing internal Memory Bank context files during intense coding sessions to maintain state