# make-documentation

This skill writes READMEs, architecture notes, changelogs, runbooks, and install docs. It helps choose a document workflow and review the result.

- skill · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode · 1500 installs · ★ 1
- Author: Callicrate
- License: not stated · policy=link-only · description only; the file stays with the author
- Source: https://github.com/Callicrate/skills/tree/HEAD/make-documentation/SKILL.md
- Updated: 2026-06-24
- HTML: https://affpapa.org/en/nevibecode/skills/make-documentation

## What it does

The skill creates or updates project documentation for READMEs, architecture notes, changelogs, release notes, runbooks, install guides, security articles, and notebook explanations. It also covers agent operation manuals and AI-readable workflow documents. API reference work and `AGENTS.md` belong outside this skill.

For a large rewrite, a moved document, or an unclear structure, it runs `scripts/audit_documentation.py` before drafting. It then routes the work to a matching guide, such as `references/guide-readme.md`, `references/guide-install-runbook.md`, or `references/guide-changelog.md`. Notebook work is checked against executable cells, imports, widgets, SQL, configuration, and outputs. The final pass uses `references/review-checklist.md`. Diagram work is opt-in, so this skill does not generate diagram files by default.

## Install

### Claude Code (native platform)

1. **Skills CLI (Vercel)**
```bash
npx skills add Callicrate/skills --skill make-documentation -a claude-code
```

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

### Codex

1. **Skills CLI (Vercel)**
```bash
npx skills add Callicrate/skills --skill make-documentation -a codex
```

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

### Cursor

1. **Skills CLI (Vercel)**
```bash
npx skills add Callicrate/skills --skill make-documentation -a cursor
```

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

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install Callicrate/skills make-documentation
```

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

### Gemini CLI

1. **Skills CLI (Vercel)**
```bash
npx skills add Callicrate/skills --skill make-documentation -a gemini-cli
```

2. **Platform CLI**
```bash
gemini skills install https://github.com/Callicrate/skills --path make-documentation
```

### Windsurf (Devin Desktop)

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

### OpenCode

**Skills CLI (Vercel)**
```bash
npx skills add Callicrate/skills --skill make-documentation -a opencode
```

### 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/Callicrate/skills/tree/HEAD/make-documentation/SKILL.md

## When to use it
- draft a project README
- audit an existing documentation tree
- write a local or Docker install runbook
- update a changelog and release notes
- explain a notebook from its executable content

## Example prompts
- Write a README for this project and inspect the documentation structure first.
- Update `CHANGELOG.md`, choose the right documentation guide, then review the result.
- Create a Docker installation runbook from the project files.

## Similar
- [documentation](https://affpapa.org/en/nevibecode/skills/documentation.md) — skill · 10300 installs
- [docs-updater](https://affpapa.org/en/nevibecode/skills/docs-updater.md) — skill · 3500 installs
- [code-documentation](https://affpapa.org/en/nevibecode/skills/code-documentation.md) — skill · 1900 installs
- [technical-documentation](https://affpapa.org/en/nevibecode/skills/technical-documentation.md) — skill · 1400 installs
- [markdown-documentation](https://affpapa.org/en/nevibecode/skills/markdown-documentation.md) — skill · 1300 installs
- [documentation-engineer](https://affpapa.org/en/nevibecode/skills/documentation-engineer.md) — skill · 711 installs

---
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