documentation-standards

What problem does it solve?

This Skill provides a comprehensive set of guidelines and templates to ensure all project documentation is clear, consistent, maintainable, and adheres to best practices across READMEs, code comments, API docs, changelogs, and architecture descriptions.

Core Features & Use Cases

• Standardized READMEs: Offers a robust template and checklist for effective project overviews.
• Effective Code Comments: Guides on when and how to write comments, emphasizing the "why" over the "what."
• Structured API Docs: Provides conventions for JSDoc and Python docstrings, including examples and parameter/return documentation.
• Changelog Best Practices: Adheres to Keep a Changelog format for clear release notes.
• Architecture Documentation: Introduces C4 model levels and ADRs for capturing design decisions.
• Runbook Guidelines: Outlines a clear format for operational guides.
• Technical Writing Principles: Covers audience awareness, active voice, progressive disclosure, and formatting rules.
• Use Case: A new developer joins a project and needs to understand how to document their code, update the README, and contribute to the changelog. This Skill provides all the necessary standards and examples.

Quick Start

Review the README template and checklist to ensure your project's README follows best practices.