documentation-templates

What problem does it solve?

This Skill addresses the challenge of inconsistent and hard-to-maintain project documentation by providing standardized templates and guidelines for various documentation types.

Core Features & Use Cases

• Standardized Templates: Offers pre-defined structures for READMEs, API documentation, code comments, changelogs, and Architecture Decision Records (ADRs).
• AI-Friendly Formats: Includes guidelines for creating llms.txt and RAG-optimized documentation to improve AI comprehension and utility.
• Use Case: A new developer joins a project and needs to understand how to document their code and contribute effectively. They can refer to these templates to ensure their documentation is clear, consistent, and follows best practices.

Quick Start

Use the documentation-templates skill to generate a README structure for a new project.