What is required for each feature entry in the documentation?

The skill looks for a name, description, how-to-use instructions, prerequisites, configuration options, examples, and known limitations.

How does the skill detect that a feature has changed?

The skill uses git diff to monitor changes in specific directories like components, pages, and config folders, as well as searching for feature-specific keywords within the code.

Which documentation files does it check?

It checks common locations such as docs/features.md, FEATURES.md, user-guide.md, and the Features section of your README.md.

What happens when documentation drift is detected?

The skill will pause the current work and trigger a 'PAUSED' status, requiring a documentation audit to synchronize the docs before continuing the development task.

Can I use this for backend-only projects?

While primarily designed for user-facing features, it can be skipped for internal backend changes, infrastructure updates, or test-only modifications.

Features Documentation Sync

Name: Features Documentation Sync
Author: troykelly

bytroykelly

•

学習とドキュメンテーション

Automatically synchronizes user-facing feature changes with project documentation to prevent documentation drift.

概要

This skill serves as a rigorous guardrail for software development by ensuring that every user-visible change—from new UI components to modified configuration settings—is accurately reflected in project documentation. It actively monitors code changes in UI directories, feature flags, and settings files, pausing the development workflow if it detects that documentation has fallen behind. By enforcing a standardized protocol for feature descriptions and user guides, it ensures that your product remains discoverable and easy to use for all end-users.

主な機能

Enforces standardized documentation templates with usage guides and examples
Supports multiple documentation locations including docs/ and root-level READMEs
Scans UI components, feature flags, and config files for undocumented changes
5 GitHub stars
Automated drift detection between source code and documentation files
Integrates with documentation-audit skills for automated updates

ユースケース

Maintaining an up-to-date user guide during rapid feature iterations
Ensuring new UI elements are explained to end-users before a production release
Auditing legacy codebases to identify and document hidden features

概要

主な機能

Enforces standardized documentation templates with usage guides and examples
Supports multiple documentation locations including docs/ and root-level READMEs
Scans UI components, feature flags, and config files for undocumented changes
5 GitHub stars
Automated drift detection between source code and documentation files
Integrates with documentation-audit skills for automated updates

ユースケース

Maintaining an up-to-date user guide during rapid feature iterations
Ensuring new UI elements are explained to end-users before a production release
Auditing legacy codebases to identify and document hidden features