documentation-templates

Documentation templates and structure guidelines. README, API docs, code comments, and AI-friendly documentation.

Content Preview
---
name: documentation-templates
description: "Documentation templates and structure guidelines. README, API docs, code comments, and AI-friendly documentation."
risk: unknown
source: community
date_added: "2026-02-27"
---

# 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** | Ru
How to Use

Recommended: Install to project (local)

mkdir -p .claude/skills
curl -o .claude/skills/documentation-templates.md \
  https://raw.githubusercontent.com/sickn33/antigravity-awesome-skills/main/skills/documentation-templates/SKILL.md

Skill is scoped to this project only. Add .claude/skills/ to your .gitignoreif you don't want to commit it.

Alternative: Clone full repo

git clone https://github.com/sickn33/antigravity-awesome-skills

Then reference at skills/documentation-templates/SKILL.md

Related Skills