Documentation Templates

This is a reference card for documentation structure, not a generator. You get templates for READMEs, API docs, changelogs, ADRs, and the newer AI-friendly formats like llms.txt. The README template prioritizes quick start over installation philosophy, which is correct. The API documentation uses a consistent table format per endpoint. Most useful is probably the "when to comment" table that separates why from what, and the AI-friendly documentation section that acknowledges 2025 reality with MCP-ready formatting and clear hierarchies for RAG indexing. Use this when you're staring at a blank documentation file and need a proven structure to fill in.

skills.sh installs: 1.4K
GitHub stars: 43.1K
last updated: Jul 14, 2026

View on GitHub

Install

$ npx -y skills add sickn33/antigravity-awesome-skills --skill documentation-templates --agent claude-code

Installs into .claude/skills of the current project.

Files

Documentation Templates

Templates and structure guidelines for common documentation types.

1. README Structure

Essential Sections (Priority Order)

Section	Purpose
Title + One-liner	What is this?
Quick Start	Running in <5 min
Features	What can I do?
Configuration	How to customize
API Reference	Link to detailed docs
Contributing	How to help
License	Legal

README Template

# Project Name

Brief one-line description.

## Quick Start

[Minimum steps to run]

## Features

- Feature 1
- Feature 2

## Configuration

| Variable | Description | Default |
|----------|-------------|---------|
| PORT | Server port | 3000 |

## Documentation

- API Reference
- Architecture

## License

[Link to the actual project license; do not infer MIT]

2. API Documentation Structure

Per-Endpoint Template

## GET /users/:id

Get a user by ID.

**Parameters:**
| Name | Type | Required | Description |
|------|------|----------|-------------|
| id | string | Yes | User ID |

**Response:**
- 200: User object
- 404: User not found

SKILL.md on GitHub