documentation-patterns

Standardize README and API documentation by applying audience-aware templates that enforce specific formatting rules. The Skill provides reusable patterns in its references directory to guide authors in structuring content for the correct reader type.

Keep architecture documentation accurate by referencing file paths instead of copying code snippets directly. Copied code rots when the source changes, so the Skill enforces patterns that treat the codebase as the single source of truth.

You need different documentation patterns when targeting distinct audiences like new users, integrators, and maintainers. The Skill defines problem-focused sections for READMEs, API references, and architecture docs to prevent mixing formats.

Write concise inline docstrings using active voice and specific, problem-focused templates. The Skill enforces patterns that cut filler words and provide working examples rather than lengthy explanations for contributors.

Yes, you can apply these documentation templates to existing projects. The Skill provides structured patterns for READMEs, API references, architecture docs, and inline docs to standardize mixed formats into an audience-aware structure.