Documentation Sync
Overview
Documentation drift is a major problem. Use this skill to ensure that the project index and agent guidance files are always up-to-date with the codebase.
Workflow
- •
Detect Changes:
- •Ideally run after major feature implementation or refactoring.
- •Compare current file structure with
project-index.md.
- •
Run Indexer:
- •Execute the
project-indexskill again. - •Verify that new modules/directories are captured.
- •Ensure deleted files are removed from documentation.
- •Execute the
- •
Update Guidance:
- •Check
agent-*.mdfiles in domain directories. - •Update any obsolete instructions.
- •Add new patterns discovered during implementation.
- •Check
- •
Verify Links:
- •Ensure all links in
README.mdandAGENTS.mdpoint to valid locations.
- •Ensure all links in
Output
- •Updated
project-index.md. - •Updated domain-specific agent guides.
- •Confirmation of documentation sync.