Technical Documentation Standards
Enforces high-quality documentation practices through intent-first commenting, structured READMEs, and formalized architectural records.
This skill provides a comprehensive framework for maintaining high-quality technical documentation across any software project. It guides AI agents to prioritize 'intent-first' comments that explain the rationale behind logic, ensuring that codebase maintainability is preserved over time. By standardizing README structures, managing Architectural Decision Records (ADRs), and integrating Mermaid.js for diagrams, the skill ensures that project documentation is as robust and synchronized as the code itself. It is particularly useful for teams looking to eliminate stale documentation and adopt professional standards for API contracts and developer onboarding.