documentation-templates

Standardize README, API, changelog, ADR, and AI-friendly documentation templates.

Updated Aug 22, 2025

Search Tags:#architecture #templates #documentation #adr #readme #code-comments #api-docs

Ready to run

npx skills add https://github.com/AnthonyCongHieu/voice_tool --skill documentation-templates-anthonyconghieu

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation-templates
Source: https://github.com/AnthonyCongHieu/voice_tool/tree/main/voice_tools_v1/.agent/skills/documentation-templates
Command: npx skills add https://github.com/AnthonyCongHieu/voice_tool --skill documentation-templates-anthonyconghieu

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation templates provide consistent structure and guidance for README, API docs, code comments, and AI-friendly documentation, reducing onboarding time and maintenance overhead.

Core Features & Use Cases

README Structure template with essential sections: Title, Quick Start, Features, Configuration, Documentation, License.
API Documentation Structure with per-endpoint blocks, parameters, responses, and examples.
Code Comment Guidelines and Changelog Template to standardize practices across the codebase.
Architecture Decision Records (ADR) and AI-friendly documentation templates for scalable collaboration.
Structure Principles for scannable, example-driven, and up-to-date docs.

Quick Start

Apply these templates to establish consistent documentation across your project and accelerate onboarding.

Frequently Asked Questions about documentation-templates

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

What is the best way to standardize README structure and API documentation across a software team?▼

Architecture Decision Records (ADR) document architecture decisions to provide scalable collaboration and historical context for software projects. Standardized ADR templates streamline project documentation tasks by capturing decisions consistently throughout the development lifecycle.

Can I use these templates to generate code comment guidelines and changelogs?▼

AI-friendly documentation templates structure content for scalable collaboration and machine readability. Standardized templates ensure documentation remains scannable, example-driven, and up-to-date, streamlining project documentation tasks for both human and AI consumption across teams.

How do I write an Architecture Decision Record for a new software project?▼

What sections should a README template include for clear project documentation?▼

A README template should include essential sections: Title, Quick Start, Features, Configuration, Documentation, and License. Standardized documentation templates provide this structure to streamline project documentation and accelerate onboarding across software projects.

Does this documentation template approach work for API references and endpoint blocks?▼

Yes, the API documentation structure template defines per-endpoint blocks with parameters, responses, and examples. Standardized templates streamline project documentation tasks by generating consistent API references throughout the development lifecycle.

Why do I need standardized templates for AI-friendly documentation?▼