documentation-templates

Generate standardized templates for READMEs, API docs, and ADRs.

Updated Jan 8, 2026

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

Ready to run

npx skills add https://github.com/VoTruongDanh/AI_Cafe --skill documentation-templates-votruongdanh

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation-templates
Source: https://github.com/VoTruongDanh/AI_Cafe/tree/main/ai-service/.agent/skills/documentation-templates
Command: npx skills add https://github.com/VoTruongDanh/AI_Cafe --skill documentation-templates-votruongdanh

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides standardized templates and guidelines for creating comprehensive and AI-friendly project documentation, ensuring consistency and clarity across your codebase.

Core Features & Use Cases

Standardized Templates: Offers pre-defined structures for READMEs, API documentation, code comments, changelogs, and Architecture Decision Records (ADRs).
AI-Friendly Guidelines: Includes recommendations for creating documentation that is easily parsable and understandable by AI agents and crawlers.
Use Case: When starting a new project, use these templates to quickly set up well-structured documentation that adheres to best practices, making it easier for team members and AI tools to understand the project.

Quick Start

Generate a README file using the provided template for a new software project.

Frequently Asked Questions about documentation-templates

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

FAQPage Schema

How do I structure project documentation to be easily parsable by AI agents?▼

To make project documentation AI-friendly, use standardized templates that provide clear structures for code comments, API documentation, and READMEs. This Skill offers guidelines specifically designed to ensure your documentation is scannable, example-driven, and easily understood by AI crawlers.

What is the best way to standardize README files and ADRs across a software engineering team?▼

The best way to standardize README files and ADRs is to apply predefined structure templates across your codebase. This Skill provides standardized templates for various documentation types, ensuring consistency, clarity, and improved maintainability for your software engineering contexts.

When do I need to create Architecture Decision Records and how do I format them?▼

You need to create Architecture Decision Records when making significant architectural choices to ensure team alignment. You format them using standardized templates that provide clear, example-driven structures, which this Skill supplies specifically for software engineering and product management use cases.

Does this documentation generation approach work for both API docs and changelogs?▼

Yes, this documentation generation approach works for both API docs and changelogs. It provides pre-defined structures and guidelines for multiple project documentation types, ensuring your API documentation and changelogs remain consistent and maintainable.

What are the limitations of using basic templates for code comments and API documentation?▼

The limitation of using basic templates for code comments and API documentation is their fundamental structural depth. While they provide standardized, scannable formats to improve discoverability, they offer basic implementation logic rather than complex, deeply customized documentation generation pipelines.