Documentation Architect

Acerca de

This skill transforms the way developers document their projects by enforcing the Diataxis framework and the 'Eight Rules' of documentation. It automatically organizes content into specialized directories for tutorials, how-tos, reference, and concepts, while ensuring all documents are interlinked for maximum discoverability. By mandating real, runnable code examples and filtering out ephemeral information like status reports, the skill helps teams maintain a permanent, high-value knowledge base that reduces technical debt and improves developer onboarding.

Características Principales

• Enforces Diataxis framework (Tutorials, How-To, Reference, Explanation)
• Ensures cross-linking and discoverability via mandatory index management
• Automates document organization and pathing within the docs/ directory
• Filters out temporal data like status reports to prevent documentation rot
• Validates real, runnable code examples to replace 'foo/bar' placeholders
• 0 GitHub stars

Casos de Uso

• Converting messy internal notes into structured tutorials and API references
• Implementing document-driven development using [PLANNED] markers for upcoming features
• Creating a comprehensive project README and structured technical documentation site