document
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.
Install / Use
npx skills add jsmastery-pro/skills --skill documentInstalls into whichever agent you are using.
SKILL.md
Installable skill definition
Quality Score
Category
Content & MediaSupported Platforms
Tags
Our assessment of document
document scores 86/100 on our quality scale, 733rd of 1,155 Content & Media skills we index.
Its SKILL.md is 9.3 KB long, well organised into 15 sections with 3 code examples: a thorough specification that gives an agent plenty to work with.
With 1,318 GitHub stars, it is one of the more widely adopted skills in the catalogue.
Maintenance, license and trust
- The repository was last updated about 3 months ago. That is recent enough to be usable, but agent tooling moves fast, so check the instructions against your agent's current version.
- Our last check on 2026-10-30 found the source still online.
- It is released under the MIT license, a permissive license that allows use, modification and commercial use with attribution.
- Its trust signals score 100/100, with no cautions. These come from repository metadata, not a code audit — read the skill file before letting an agent act on it.
Safety scan
No issues foundOur scan of the whole file found no instruction hijacking, hidden characters, credential access, data exfiltration or destructive commands. An AI review of the same text found nothing harmful.
AI review by kimi-k2.7-code on 2026-10-04. Automated pattern scan on 2026-10-04. It catches known dangerous patterns, not every risk — read a skill before letting an agent act on it.
document compared with similar skills
All 4 of these similar skills score higher than document; compare them before choosing.
| Skill | Score | Stars | Updated | Format |
|---|---|---|---|---|
| document (this skill)by jsmastery-pro | 86 | 1.3k | 3mo ago | SKILL.md |
| siyuanby siyuan-note | 100 | 47.3k | today | MCP Server |
| x402by browser-use | 100 | 121.0k | 3d ago | SKILL.md |
| algorithmic-artby anthropics | 100 | 177.9k | 55d ago | SKILL.md |
| pptxby anthropics | 100 | 177.9k | 55d ago | SKILL.md |
Frequently asked questions
- How do I install document?
- Run
npx skills add jsmastery-pro/skills --skill document. The install tabs above show the steps for each supported agent. - Which AI agents does document work with?
- It is written for Universal, as a SKILL.md file. Other agents that read the same format can often use it too.
- Is document safe to use?
- Our scan of the whole file found no instruction hijacking, hidden characters, credential access, data exfiltration or destructive commands. An AI review of the same text found nothing harmful. It is MIT-licensed and scores 100/100 on trust signals. Skills are instructions an agent will follow, so read the file before installing it and do not approve commands you do not understand.
- Is document still maintained?
- The repository was last updated about 3 months ago. That is recent enough to be usable, but agent tooling moves fast, so check the instructions against your agent's current version.
Skill content
View source on GitHubname: document
allowed-tools: Bash, Read, Grep, Glob, Write, Edit, Agent, AskUserQuestion
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."
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.
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 |
Acts. Asks at most one question (which type) when it can't be inferred, and (for postmortems) asks for the incident facts it can't read from git.
Artifact ownership
PR text, CHANGELOG.md, docs/releases/, docs/postmortems/ (owned by this skill). It writes nothing else.
Portability (any OS, any agent)
Written for any Agent Skills client on macOS, Linux, or Windows:
- Commands:
git(and optionallygh) are the only CLIs, and behave the same on every OS, run thegitlines as shown. Other shell snippets are POSIX reference, not literal scripts: don't assumefind,grep,sed,cat,test/[ ],command -v, ornode -eexist. Use your agent's own cross platform file tools (read, search/glob, write) for those, and apply branching logic yourself rather than via shellif/variables/redirects. - Bundled files: referenced by paths relative to this skill's folder. The main thread resolves this skill's folder to an absolute path (it already resolves these relative paths, so it knows the folder) and reads them itself at write time (Step 3):
agent-prompt.mdand the one template for the chosen type. - No interactive question support? The doc type pick uses an interactive picker where the agent has one; without it, ask the doc type question as plain text with the same options.
Execution
1. Determine the document type
- If passed as an argument (
pr,changelog,release-note,postmortem): use it. - Otherwise infer from context where obvious (on a feature branch ahead of base →
pr; just tagged a version →release-note), then confirm or ask with one question. Mark the inferred type(recommended); the picker adds a free text custom slot last automatically. Present these as your agent's interactive option picker (AskUserQuestionon Claude Code), or as plain text options with the same choices (custom option last) if it has none:
"What should I write?"
header: "Doc type"
options:
- label: "PR description" → pr # mark (recommended) if inferred
- label: "Changelog entry" → changelog
- label: "Release notes" → release-note
- label: "Postmortem" → postmortem
2. Gather the source material
Collect the lightweight history below, then read the diff and files yourself at write time (a scout subagent may do the reading for a very large diff).
Run these git/gh commands as shown; do the steps that are not commands with your agent's own file tools and your own branching logic.
# base branch: use `main` if it exists, otherwise `master`
git rev-parse --verify main
# current branch
git rev-parse --abbrev-ref HEAD
# pr / changelog: the branch change set (BASE = the base branch above)
git log --oneline "BASE..HEAD"
git diff --name-only "BASE...HEAD"
# release-note: needs tags. List them; if there are none, fall back gracefully (treat as NO_TAGS).
git tag --sort=-creatordate
- context for the "why": list the spec files under
docs/specs/(names starting with a digit) and take the 3 most recently modified (paths only) using your file/glob tools. - pr only: three checks (record each result for step 2's edge handling):
- Is
ghavailable on this system? (GH_INSTALLED) - Does the repo have a git remote? Run
git remote; a result that is not empty means HAS_REMOTE. - Does a PR already exist? Run
gh pr view --json number -q .number. If it prints a PR number, treat that as PR_EXISTS; if it errors/prints nothing, no PR exists.
- Is
Per type edge handling the main thread resolves before writing:
release-noterange: if tags exist, the range is<previous-tag>..<latest-tag>(or a range the engineer named). IfNO_TAGS, don't guess, ask: "No version tags found. Give me a version name and range (e.g.v1.0.0, covering<commit>..HEAD), or I'll cover all commits since the first one." Pass the resolved range/version to the subagent.- pr + gh: only offer to create/update the PR via
ghwhenGH_INSTALLEDandHAS_REMOTE. IfPR_EXISTS, the action isgh pr edit(update the body), notgh pr create. If gh isn't usable or no remote, the PR text is chat only, don't attemptgh. Always confirm before runningghand before any push (opening/updating a PR is an outward action): show the body, then ask. This holds regardless of theAGENTS.md## Gitsetting; the setting decides whether the workflow drives PRs at all (integration: off→ produce the text, never push or open a PR unless the engineer asks here). - postmortem: git won't contain the incident narrative. Ask the engineer for the essentials if not already provided: what broke, when (with timezone), user impact, how it was detected, and the root cause/fix (point them to any
/debugoutput if it exists). Pass their account as the incident facts. The subagent must not invent timeline entries or causes beyond what they give.
3. Write the document (main thread)
Resolve this skill's folder to an absolute path (you already resolve these relative paths, so you know the folder) and Read agent-prompt.md and the one template for the chosen type, templates/<type>.md, now (only now, at write time). Follow agent-prompt.md and write the document yourself. Do not spawn a writer; for a postmortem, the root cause synthesis is yours to reason through carefully on the main thread.
The inputs to apply:
- Document type + its template (the chosen one only; read it)
- Source: commit list, diff command, and (postmortem) the incident facts. Read the diff yourself; for a very large diff (e.g. >25 files), offload the reading to a
scoutsubagent (haiku) that returns a compact summary by file group/feature, and write from that - Project context contents (project name, conventions), read
AGENTS.md, orCLAUDE.mdfallback, + recent spec paths for the "why" - Output target for the type and today's date
- pr: the gh action,
none (chat-only)|gh pr create|gh pr edit(from theGH_INSTALLED/HAS_REMOTE/PR_EXISTSchecks) - changelog: match the existing
CHANGELOG.mdformat if the file exists (don't impose Keep a Changelog over a different established style) release-note: the resolved version + range
4. Relay the result
Lead with the type and where it landed; for pr the body IS the deliverable, so show it in full (per docs/conventions.md). Template:
## /document <pr | changelog | release-note | postmortem> · <PR body below | CHANGELOG.md | docs/releases/<v>.md | docs/postmortems/<file> | PR #N updated>
<for pr: the title + full body, ready to paste · always shown in chat so it works without gh>
<for the others: a 2 to 3 line preview>
Scope: ticked `Document it` (or "no scope row matched"; omit if not on the scope)
This skill does not commit, push, or merge; it produces the prose (and ticks the Document it box per the closing gate above, the only scope edit it makes).
Reference files
agent-prompt.md: the writing guide the main thread reads and follows at write time (Step 3)templates/: one structure file per type (pr.md,changelog.md,release-note.md,postmortem.md); the main thread reads only the chosen one at write time
Related Skills
siyuan
47.3kAn open-source, privacy-first, self-hosted knowledge workspace where humans and AI agents work together 开源、隐私优先、自托管的知识工作空间,让人与智能体在此协作
x402
121.0kSet up Browser Use Cloud payments with x402 — pay per request from a crypto wallet (USDC on Base mainnet), no signup or API key.
algorithmic-art
177.9kCreating algorithmic art using p5.js with seeded randomness and interactive parameter exploration. Use this when users request creating art using code, generative art, algorithmic art, flow fields, or particle systems.
pptx
177.9kUse this skill any time a .pptx or .potx file is involved in any way — as input, output, or both. This includes: creating slide decks, pitch decks, or presentations; reading, parsing, or extracting text from any .pptx or .potx file (even if the extracted content will be used elsewhere, like in an em…
Languages
Trust signals
From repository metadata: license, adoption, age and documentation. Not a code audit — see the Safety scan above for what the skill file itself contains.
