documentation-templates

Standardize project README and API documentation by applying priority-ordered outlines covering Quick Start, Features, Configuration, and per-endpoint formatting with parameters, responses, and examples. This ensures consistent onboarding materials and contributor guidance across software repositories.

Format code comments for RAG indexing using JSDoc and TSDoc comment templates alongside llms.txt and MCP-ready structures. This approach creates searchable context that enables AI tools to discover and retrieve documentation content efficiently during retrieval-augmented generation workflows.

Create architecture decision records using ADR structure and standardize changelogs using Keep a Changelog style conventions. These templates record architectural decisions and document version changes consistently, making maintenance and contributor onboarding significantly easier for software repositories.

These documentation templates work for existing codebases by asking an AI to generate README files, API docs skeletons, and code comment examples using the standardized guidelines. They constrain outputs to scannable sections and template formats suitable for repositories needing consistent contributor guidance.

Standardized documentation structure supports YAML frontmatter-driven discovery needs by constraining outputs to scannable sections and template formats. This enables operational consistency and makes documentation discoverable for both human contributors and automated indexing systems.

Documentation generation requires IPPD Shadow-Logging with UIP-V15 provenance headers, producing a SELT Shadow Log for every execution. This mandatory provenance consistency ensures all template-generated documentation outputs are traceable and operationally auditable across the repository.