# documentation-templates

This skill provides outlines and templates for READMEs, API references, code comments, and project records. Use it when starting documentation or bringing existing pages into a clearer structure.

- skill · `type=skill` · Claude Code · 305 installs
- Author: davila7
- License: not stated · policy=link-only · description only; the file stays with the author
- Source: https://github.com/davila7/claude-code-templates/tree/HEAD/cli-tool/components/skills/document-processing/documentation-templates
- Updated: 2026-10-24
- HTML: https://affpapa.org/en/nevibecode/skills/documentation-templates

## What it does

The skill includes starting formats for a README, individual API endpoints, JSDoc/TSDoc comments, a changelog, and architecture decision records. Its README outline covers project purpose, setup, configuration, and documentation links. Endpoint entries have slots for parameters, response cases, and a request example. Comment guidance distinguishes explanations of complex behavior or API contracts from comments that merely restate the code.

A separate section covers `llms.txt` and documentation prepared for RAG indexing. It recommends a clear heading hierarchy, JSON/YAML samples, Mermaid diagrams, and sections that make sense on their own. Treat the formats as starting points and adapt them to the project. The skill is allowed to use `Read`, `Glob`, and `Grep`, so its listed tools support inspecting and searching files, not writing them.

## Install

### Claude Code (native platform)

1. **claude-code-templates**
```bash
npx claude-code-templates@latest --skill document-processing/documentation-templates
```

2. **Skills CLI (Vercel)**
```bash
npx skills add davila7/claude-code-templates --skill documentation-templates -a claude-code
```

3. **Manually: put the files in place**
- File: `~/.claude/skills/documentation-templates/SKILL.md` — Copy the whole skill folder; for one project use .claude/skills/documentation-templates/

### Codex

**Manually: put the files in place**
- File: `.agents/skills/documentation-templates/SKILL.md` — For all projects use ~/.agents/skills/

### Cursor

**Manually: put the files in place**
- File: `.cursor/skills/documentation-templates/SKILL.md` — Cursor also reads .agents/skills/ and .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install davila7/claude-code-templates documentation-templates
```

2. **Manually: put the files in place**
- File: `.github/skills/documentation-templates/SKILL.md`

### Gemini CLI

**Platform CLI**
```bash
gemini skills install https://github.com/davila7/claude-code-templates --path cli-tool/components/skills/document-processing/documentation-templates
```

### Windsurf (Devin Desktop)

**Manually: put the files in place**
- File: `.devin/skills/documentation-templates/SKILL.md` — The legacy .windsurf/skills/ path still works

### Claude.ai

**Claude.ai**
- Zip the folder and upload it in Settings → Capabilities → Skills

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/davila7/claude-code-templates/tree/HEAD/cli-tool/components/skills/document-processing/documentation-templates

## When to use it
- draft a README outline with setup and configuration sections
- document an API endpoint with parameters and response cases
- add comments for complex logic and API contracts
- record a project change or architecture decision
- prepare documentation for AI retrieval and RAG indexing

## Example prompts
- Draft a README outline for this project using the skill's format.
- Document these API endpoints with parameters, response cases, and request examples.
- Review the code comments and suggest where behavior needs explanation and where a comment repeats the code.

## Similar
- [grill-with-docs](https://affpapa.org/en/nevibecode/skills/grill-with-docs.md) — skill · 1219756 installs
- [skill-creator](https://affpapa.org/en/nevibecode/skills/skill-creator.md) — skill · 414180 installs
- [setup-matt-pocock-skills](https://affpapa.org/en/nevibecode/skills/setup-matt-pocock-skills.md) — skill · 1052851 installs
- [handoff](https://affpapa.org/en/nevibecode/skills/handoff.md) — skill · 1038491 installs
- [triage](https://affpapa.org/en/nevibecode/skills/triage.md) — skill · 990453 installs
- [domain-modeling](https://affpapa.org/en/nevibecode/skills/domain-modeling.md) — skill · 876391 installs

From the same set: [davila7/claude-code-templates](https://affpapa.org/en/nevibecode/by/davila7/claude-code-templates.md) — 495 cards

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md