What problem does it solve?
This Skill provides a comprehensive set of templates and guidelines to ensure consistent, high-quality documentation across projects, making them easier to understand, maintain, and use.
Core Features & Use Cases
- Standardized READMEs: Offers a structured template for project overviews, quick starts, and feature lists.
- API Documentation: Provides a per-endpoint template for clear API specifications.
- Code Commenting: Includes guidelines and templates for effective JSDoc/TSDoc comments.
- Changelog & ADRs: Offers templates for tracking changes and architectural decisions.
- AI-Friendly Docs: Outlines strategies for creating documentation that AI agents can easily process.
- Use Case: A new developer joins a project and needs to understand its structure and APIs. They can refer to the standardized README and API documentation templates to quickly get up to speed.
Quick Start
Use the documentation-templates skill to generate a README structure for a new project.