documentation-templates

To create a standardized README, apply a predefined structural template that captures all necessary project information consistently. This ensures your main documentation file starts with a clear, uniform structure right from project kickoff.

An Architecture Decision Record (ADR) documents significant architectural choices. You need an ADR template to standardize how these decisions are recorded, ensuring consistent documentation practices and clear rationale tracking across your software development projects.

To format API references for AI crawlers and RAG systems, follow AI-friendly documentation guidelines that optimize content structure for machine parsing. These guidelines ensure your API endpoint descriptions are easily ingested by automated retrieval systems.

Yes, this approach works for code comments and changelogs by providing standardized templates and structural guidelines for various documentation types. It facilitates consistent documentation practices across all software development artifacts, ensuring clarity and uniformity.

The best way to structure project documentation is to apply standardized templates for READMEs, API references, and requirement documents whenever starting a new feature. This ensures all necessary information is captured in a consistent format across the entire project.

Yes, you can use these templates without external dependencies. The Skill provides structural guidelines and pre-defined formats for documentation types like code comments and ADRs without requiring additional libraries or tools to implement the standardized structures.