doc-improve

What problem does it solve?

This Skill provides a comprehensive review of existing documentation files, ensuring they remain accurate, up-to-date, and clear for all readers.

Core Features & Use Cases

• Content Review: Substantive review of documentation for factual accuracy, redundancy, staleness, and reader context.
• Type-Specific Analysis: Different types of documentation, such as rules, architecture, and guides, are reviewed with specific criteria.
• Code-Driven Verification: Every factual claim in the documentation is verified against the corresponding codebase.
• Redundancy Detection: Identifies and addresses redundancy with sibling documents.
• Currency Check: Ensures documentation reflects the current state of the codebase.
• Format and Style Guidelines: Adherence to the project's documentation standards and formats.
• Output Reporting: Provides a detailed report with findings and suggested changes.

Quick Start

Run the doc-improve skill on a specific documentation file or directory using the command: /we:doc-improve path/to/file.md