← ClaudeAtlas

documentation-guidelisted

Documentation standards enforcing Keep a Changelog format, README structure, ADR templates, and Google-style docstrings. Use when writing CHANGELOG entries, updating READMEs, or documenting APIs. TRIGGER when: changelog, readme, documentation, docstring, ADR, API docs. DO NOT TRIGGER when: code-only changes, test files, config updates without API changes.
akaszubski/autonomous-dev · ★ 29 · Data & Documents · score 68
Install: claude install-skill akaszubski/autonomous-dev
# Documentation Guide Enforcement Skill Ensures all documentation is consistent, current, and complete. Used by the doc-master agent. ## Keep a Changelog Format All CHANGELOG entries MUST follow [Keep a Changelog](https://keepachangelog.com/) format. ### Categories (in this order) - **Added** — new features - **Changed** — changes to existing functionality - **Deprecated** — soon-to-be removed features - **Removed** — removed features - **Fixed** — bug fixes - **Security** — vulnerability fixes ### Structure ```markdown # Changelog ## [Unreleased] ### Added - New authentication module (#123) ### Fixed - Token expiry off-by-one error (#124) ## [1.2.0] - 2026-02-15 ### Added - Batch processing support (#100) ``` The `[Unreleased]` section MUST always exist at the top for accumulating changes. --- ## README Required Sections Every README.md MUST contain these sections in order: 1. **Overview** — 1-2 sentence project description 2. **Installation** — How to install/set up 3. **Usage / Quick Start** — Minimal working example 4. **Commands Table** — Available commands with descriptions 5. **Configuration** — Config files, env vars, options 6. **Contributing** — How to contribute, link to CONTRIBUTING.md --- ## Docstring Format: Google Style All public functions MUST have Google-style docstrings. ```python def process_data( data: List[Dict], *, validate: bool = True, ) -> ProcessResult: """Process input data with optional validation. Args: