documentation-patterns

Standardize README structure by applying reusable documentation patterns that define section order, content requirements, and cross-references. This enforces consistency across teams using predefined templates for each document type.

Organize architecture decision records by applying the MADR pattern, a standardized markdown format for ADRs. This provides clear guidance on structuring decisions to keep architecture documentation consistent and navigable.

Keep a Changelog works by providing a standardized pattern for organizing release notes and modifications. It enforces consistent content rules and section ordering, ensuring all project updates are documented uniformly.

Yes, you can apply these documentation patterns to API docs and architecture records simultaneously. The skill enforces standardized conventions for both, ensuring consistent structure and cross-references across all document types.

No dependencies are required to apply these markdown documentation patterns. The skill provides a standalone set of structural rules for READMEs, ADRs, and changelogs, allowing you to build a project skeleton without external tools.

Avoid standardized documentation templates when your project requires highly custom, unconventional structures that deviate from established ADR, API, and changelog conventions. Rigid templates may restrict necessary flexibility in those specific cases.