What problem does it solve?
This skill ensures all project documentation is consistently structured, styled, and maintained, eliminating fragmented information and reducing the effort required to keep documentation up-to-date and discoverable.
Core Features & Use Cases
- Convention-Driven Documentation: Automatically loads and applies project rules for documentation structure, templates, and writing style.
- INDEX.md Maintenance: Guides on how to update the central documentation index, ensuring new documents are always discoverable and integrated.
- Quality Gate: Acts as a final check to ensure all documentation, whether created manually or from research reports, meets project standards.
- Use Case: After implementing a new API, activate this skill to generate its documentation. It will guide you to create the file in the correct
docs/ subdirectory, use the right template, and automatically update docs/INDEX.md, ensuring consistency and discoverability.
Quick Start
Activate the documentation-writer skill to create new documentation for the PaymentGateway integration, ensuring it follows the project's structure and updates docs/INDEX.md.