documentation-templates

Create and maintain AI-friendly documentation templates for software projects.

132|22|Updated Dec 18, 2025

Search Tags:#templates #documentation #code comments #ADR #API docs #README #AI-friendly

Ready to run

npx skills add https://github.com/xenitV1/Antigravity-Workflows --skill documentation-templates-xenitv1

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation-templates
Source: https://github.com/xenitV1/Antigravity-Workflows/tree/main/skills/documentation-templates
Command: npx skills add https://github.com/xenitV1/Antigravity-Workflows --skill documentation-templates-xenitv1

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides standardized templates for README, API docs, code comments, ADRs, and changelog structures to ensure consistent, high-quality documentation across projects.

Core Features & Use Cases

Templates for README structures, API documentation, code comments, ADRs, and changelogs to accelerate documentation work.
Guidelines for AI-friendly documentation, enhanced readability, and RAG indexing support.
Use Case: Onboarding a new project or team with ready-to-use documentation templates to reduce setup time and improve collaboration.

Quick Start

Copy or adapt the templates into your project docs/ directory, tailor section titles to your project, and reference the templates when creating new docs (README, API docs, ADRs, and changelog).

Frequently Asked Questions about documentation-templates

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

FAQPage Schema

How do I create consistent documentation templates for my project?▼

Documentation templates standardize structure across README, API docs, code comments, ADRs, and changelogs. Use ready-made templates tailored to your project's needs, copy them into your docs/ directory, and reference them when creating new documentation to ensure consistency and reduce setup time.

What should I include in API documentation and README files?▼

API documentation and README templates provide standardized sections for structure, usage examples, installation steps, and configuration. The templates include guidance for clear organization, making it easier for teams to onboard and for AI systems to parse and index your docs accurately.

How do I make documentation work better with AI and RAG indexing?▼

AI-friendly documentation follows structural guidelines for frontmatter, consistent section hierarchy, and standardized formatting. These templates embed best practices for readability and RAG indexing, enabling AI systems to extract and reference your documentation more effectively.

Can I use these templates for code comments and architectural decisions?▼

Yes. The templates cover code comments and Architecture Decision Records (ADRs) alongside API docs and changelogs. Each template provides section guidance and formatting standards so all documentation types follow the same structural principles across your project.

What's the fastest way to document a new project or onboard a team?▼

Copy the provided templates into your docs/ directory and adapt section titles to match your project. This accelerates documentation creation for new projects and teams, establishes shared standards upfront, and reduces time spent on documentation design and formatting decisions.

Do these templates work with changelogs and version history?▼

Yes. Changelog templates standardize how you track releases, updates, and version history. The templates ensure consistent formatting and structure, making it easier for users and AI systems to track changes across project versions.