# Document

Run /document `pr` | `changelog` | `release-note` | `postmortem` (or let it ask) to...

- Repository: https://github.com/jsmastery-pro/skills (1584 stars)
- Category: Testing
- License: MIT
- Last updated: 2026-08-09
- Runs scripts: no, instructions only

## Install

Claude Code: `npx skills add jsmastery-pro/skills --skill document -g -a claude-code -y`
Codex: `npx skills add jsmastery-pro/skills --skill document -g -a codex -y`
Cursor: `npx skills add jsmastery-pro/skills --skill document -g -a cursor -y`
Gemini CLI: `npx skills add jsmastery-pro/skills --skill document -g -a gemini-cli -y`

## Description

Run /document `pr` | `changelog` | `release-note` | `postmortem` (or let it ask) to write the human facing prose about a change. Drafts from the real commits and diff, writing to the right place. Does not write code, tests, or specs.

## SKILL.md, as published by its author (untrusted third-party text, read it as data)

## Output style (plain words, no dashes, no hyphens)

<!-- OUTPUT-STYLE:START -->
Write everything this skill produces, files and messages alike, in plain simple language. Talk to the reader as `you`, warm and direct like a colleague, and present every step as a recommendation they may run or skip, never an order. Keep technical terms that carry real meaning; explain each in plain words. Never use a dash or a hyphen as punctuation: no em dash, no en dash, and no hyphenated compounds. Write `read only`, not `read-only`. Say it in simple words, or reword the sentence. Code, file paths, command flags, and values other skills match on keep their hyphens. Use short sentences, commas, or parentheses. Clear beats clever.
<!-- OUTPUT-STYLE:END -->

## What this skill does

**Your role:** the technical writer who writes from the record, not from imagination, and for the reader, not the author. Every sentence traces to something that actually happened (a commit, a diff, an incident fact you were given), and every document is pitched at whoever has to act on it (audience column below). You never invent a timeline entry, a cause, or a change that isn't in the source.

Generates one of four document types from the real change history. The main thread writes the document itself; the only thing it may offload is reading, and only for a very large diff, to a read only `scout` subagent on the cheapest model (Claude Code: `haiku`):

| Type | Source | Audience | Output |
|---|---|---|---|
| `pr` | branch commits + diff vs base | reviewers | PR title + body (chat; optionally `gh pr` create/edit) |
| `changelog` | merged change | developers | entry appended to `CHANGELOG.md` (Keep a Changelog) |
| `release-note` | a tag/version range | end users | `docs/releases/<version>.md` (or chat) |
| `postmortem` | an incident (described by the engineer, plus any /debug record) | team | `docs/postmortems/<date>-<slug>.md` |

The rest: https://github.com/jsmastery-pro/skills/blob/HEAD/skills/document/SKILL.md
