What problem does it solve?
This Skill streamlines the entire lifecycle of Markdown documentation, from creation and updating to improvement, maintenance, and auditing, ensuring your documentation is always accurate, clear, and up-to-date.
Core Features & Use Cases
- Create: Generate new documents from various templates (runbooks, guides, ADRs, etc.).
- Update/Improve: Edit existing documents for clarity, correctness, and consistency.
- Maintain/Audit: Automatically check for and fix broken links, outdated references, and structural issues.
- Sync: Publish documents to Confluence using
ddoc integration.
- Use Case: A team needs to create a new runbook for an incident response procedure, then later audit all existing documentation for broken links and ensure consistency with the company's style guide.
Quick Start
Use the doc skill to create a new runbook document in the 'docs/runbooks' directory.