documentation-templates

Generate README, API reference, ADR, architecture doc, changelog templates with standardized Markdown frontmatter.

8.1k|1.5k|Updated Jan 14, 2026
One-click install
npx skills add https://github.com/vudovn/antigravity-kit --skill documentation-templates-vudovn
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation-templates
Source: https://github.com/vudovn/antigravity-kit/tree/main/.agent/skills/documentation-templates
Command: npx skills add https://github.com/vudovn/antigravity-kit --skill documentation-templates-vudovn

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation inconsistencies across projects lead to confusion and maintenance overhead. This Skill provides ready-to-use templates and structure guidelines for README, API docs, code comments, ADRs, and architecture docs.

Core Features & Use Cases

  • Ready-to-fill templates for common document types (README, API reference, Changelog, ADRs, architecture docs).
  • Guidelines for structure, style, and AI-friendly documentation to improve clarity and searchability.
  • Use Case: A team wants a consistent onboarding doc and API reference; apply these templates to generate standardized docs quickly.

Quick Start

Copy the templates into your project and customize them to fit your conventions and branding.

Frequently Asked Questions about documentation-templates

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

FAQPage Schema
How do I standardize README and API documentation across multiple software projects?

You can standardize README and API documentation by applying ready-to-use templates that enforce a structured frontmatter with mandatory fields and standardized Markdown sections, ensuring consistency across all your software projects.

What is the best way to create AI-friendly architecture docs and code comments?

Creating AI-friendly architecture docs and code comments requires structured Markdown templates with standardized sections and guidelines that improve clarity and searchability for automated processing and retrieval.

Do I need any specific dependencies to generate standardized changelogs and ADRs?

No dependencies are required to generate standardized changelogs and ADRs. You can simply copy the provided ready-to-fill templates directly into your project and customize them to fit your conventions.

Can I use these documentation templates for onboarding new developers to my codebase?

Yes, you can use these templates for onboarding new developers by generating a consistent onboarding doc and API reference quickly, which standardizes project knowledge and reduces confusion across your team.

When do I need to use structured frontmatter with mandatory fields in my documentation?

You need structured frontmatter with mandatory fields when automating the creation of consistent documentation, as it enforces standardized metadata capture across READMEs, API references, and architecture docs.