What problem does it solve?
This Skill streamlines the creation, maintenance, and quality assurance of technical documentation, ensuring it stays synchronized with code and adheres to best practices.
Core Features & Use Cases
- Documentation as Code: Integrates documentation into your development workflow, treating it like code.
- Diagram Generation: Creates various diagrams (ERDs, sequence, gitgraph) using Mermaid syntax directly from Markdown.
- Doc Sync Audits: Identifies gaps and inconsistencies between your codebase and its documentation.
- Use Case: When you update an API endpoint, use this Skill to automatically audit if the corresponding documentation has been updated, generate a sequence diagram for the new interaction, and ensure the documentation follows the established style guide.
Quick Start
Use the technical-docs skill to audit documentation coverage for the current codebase.