Agent skill

Change Documentation Writer

by jsmastery-pro in jsmastery-pro/skills

Writes PR descriptions, changelog entries, release notes and postmortems from the actual commits and diff, and saves each one in the right place.

MITAuto-check: notesDevelopment

Install Change Documentation Writer

skills CLI
$ npx skills add jsmastery-pro/skills --skill document -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install jsmastery-pro/skills document --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/jsmastery-pro/skills.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/document .claude/skills/document && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
document
GitHub stars
1.4k
Token cost
~2.4k tokens
SKILL.md length
1,246 words
Files
7
Skills in repo
8
Repo updated
First seen
Licence
MIT

At a glance

Writes PR descriptions, changelog entries, release notes and postmortems from the actual commits and diff, and saves each one in the right place.

  • Works in 4 steps: Determine the document type → Gather the source material → Write the document (main thread) → …
  • Writing a pull request title and body from the branch commits
  • SKILL.md covers Output style (plain words, no…, What this skill does, Artifact ownership and Portability (any OS, any agent), plus 2 more sections
  • Calls git, gh and node

What it does

Run it as /document with pr, changelog, release-note or postmortem, or let it ask which one you want. The agent writes from the record only: every sentence has to trace back to a commit, a diff or an incident fact you supplied, and it never invents a timeline entry, a cause or a change. A PR text comes from the branch commits compared with the base, and can optionally be created or edited with gh.

A changelog entry is appended to CHANGELOG.md in Keep a Changelog style, release notes go to docs/releases for a version range, and postmortems go to docs/postmortems under a date and slug, using template files that ship with the skill. For postmortems it asks for incident facts git cannot show. A very large diff may be read by a read-only scout subagent on a cheap model. Output is plain language without dashes, and the skill does not write code, tests or specs.

When your agent uses it

  • Writing a pull request title and body from the branch commits
  • Adding an entry to CHANGELOG.md after a change merges
  • Drafting end-user release notes for a tagged version
  • Writing up an incident as a postmortem

Example prompts

  • “/document pr for this branch against main.”
  • “Write release notes for everything between the last two tags.”
  • “Draft a postmortem for yesterday's checkout outage, and I will give you the timeline.”
  • “Add a changelog entry for the retry fix I just merged.”

Requirements

  • A Git repository with the commits to describe
  • GitHub CLI (gh), only if the PR should be created or edited
  • Pre-approved tools (allowed-tools): Bash, Read, Grep, Glob, Write, Edit, Agent, AskUserQuestion

Workflow steps

4 steps, taken from the step headings in SKILL.md.

  1. Determine the document type
  2. Gather the source material
  3. Write the document (main thread)
  4. Relay the result

What it can do on your machine

Read from SKILL.md and the folder at commit 43b69e4. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves these tools, so the agent can use them without asking each time:

    • Bash
    • Read
    • Grep
    • Glob
    • Write
    • Edit
    • Agent
    • AskUserQuestion

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • git
    • gh
    • node

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md. Its commands use git and gh, which can reach the network depending on how they are called.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Change Documentation Writer loads about 2.4k tokens when it runs. Until then it costs about 61 tokens; SKILL.md has 1,246 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~61
When it runs · the whole SKILL.md, loaded when a task matches
~2.4k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check: notes

The automated check noted patterns worth knowing about, such as sudo or a known installer.

  • NotePre-approves every shell command (allowed-tools: Bash)SKILL.md
    allowed-tools: Bash, Read, Grep, Glob, Write, Edit, Agent, AskUserQuestion

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from jsmastery-pro/skills at commit 43b69e4, republished under its MIT licence (© jsmastery-pro). 1,246 words, ~2,392 tokens.

Download SKILL.mdSave it as .claude/skills/document/SKILL.md (or your agent's skills folder). This skill also uses 6 other files; get the full folder from GitHub.
name
document
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.
allowed-tools
Bash, Read, Grep, Glob, Write, Edit, Agent, AskUserQuestion

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

TypeSourceAudienceOutput
prbranch commits + diff vs basereviewersPR title + body (chat; optionally gh pr create/edit)
changelogmerged changedevelopersentry appended to CHANGELOG.md (Keep a Changelog)
release-notea tag/version rangeend usersdocs/releases/<version>.md (or chat)
postmorteman incident (described by the engineer, plus any /debug record)teamdocs/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 optionally gh) are the only CLIs, and behave the same on every OS, run the git lines as shown. Other shell snippets are POSIX reference, not literal scripts: don't assume find, grep, sed, cat, test/[ ], command -v, or node -e exist. Use your agent's own cross platform file tools (read, search/glob, write) for those, and apply branching logic yourself rather than via shell if/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.md and 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 (AskUserQuestion on 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
Show full SKILL.md (668 more words)Show less
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.

bash
# 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 gh available 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.

Per type edge handling the main thread resolves before writing:

  • release-note range: if tags exist, the range is <previous-tag>..<latest-tag> (or a range the engineer named). If NO_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 gh when GH_INSTALLED and HAS_REMOTE. If PR_EXISTS, the action is gh pr edit (update the body), not gh pr create. If gh isn't usable or no remote, the PR text is chat only, don't attempt gh. Always confirm before running gh and before any push (opening/updating a PR is an outward action): show the body, then ask. This holds regardless of the AGENTS.md ## Git setting; 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 /debug output 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:

  1. Document type + its template (the chosen one only; read it)
  2. 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 scout subagent (haiku) that returns a compact summary by file group/feature, and write from that
  3. Project context contents (project name, conventions), read AGENTS.md, or CLAUDE.md fallback, + recent spec paths for the "why"
  4. Output target for the type and today's date
  5. pr: the gh action, none (chat-only) | gh pr create | gh pr edit (from the GH_INSTALLED/HAS_REMOTE/PR_EXISTS checks)
  6. changelog: match the existing CHANGELOG.md format if the file exists (don't impose Keep a Changelog over a different established style)
  7. 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

© jsmastery-pro, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 6 other files in skills/document of jsmastery-pro/skills.

  • SKILL.md
  • agent-prompt.md
  • agents/openai.yaml
  • templates/changelog.md
  • templates/postmortem.md
  • templates/pr.md
  • templates/release-note.md

Open the folder on GitHubat commit 43b69e4

Compare with similar skills

Change Documentation Writer next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Change Documentation Writer compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Change Documentation Writer this skilljsmastery-pro/skills1.4k—~2.4kAutomated safety check: NotesMIT
RStudio What's New Pagerstudio/rstudio5.1k—~2kAutomated safety check: PassCustom licence
Technical Writingfrappe/skills146—~1.1kAutomated safety check: PassNone
Pull Requestcloudposse/atmos1.4k—~3.5kAutomated safety check: PassApache-2.0
Pull Request Title and Body Writeropeninterpreter/openinterpreter69k2 repos~1.1kAutomated safety check: PassApache-2.0
Git Workflow and Versioningaddyosmani/agent-skills102k2 repos~3.5kAutomated safety check: NotesMIT

Similar skills

  • Turns the current release's NEWS.md entries into the RStudio Desktop What's New page, picking only what Desktop users care about, then commits and opens a PR.

    5.1k GitHub stars~2k tokensUpdated today
    DevelopmentAuto-check passed
  • Technical Writing

    frappe/skills

    Write prose in "Simplified Technical English". An agent skill from frappe/skills.

    146 GitHub stars~1.1k tokensUpdated 7 days ago
    DevelopmentAuto-check passed
  • Pull Request

    cloudposse/atmos

    PR workflow: pick the right semver label (no-release / patch / minor / major), decide when to add a changelog blog post, when to update the roadmap, and how to do each correctly.

    1.4k GitHub stars~3.5k tokensUpdated today
    DevelopmentAuto-check passed
  • Pull Request Title and Body Writer

    openinterpreter/openinterpreter

    Rewrites the title and body of one or more pull requests with gh, leading with why the change was made, then what changed, and describing only the net result.

    69k GitHub starsUsed in 2 repos~1.1k tokens
    DevelopmentAuto-check passed
  • Git Workflow and Versioning

    addyosmani/agent-skills

    Sets git habits for every change: short-lived branches, atomic commits with descriptive messages, clean pull requests, plus versioning, tagging and changelogs for releases.

    102k GitHub starsUsed in 2 repos~3.5k tokens
    DevelopmentAuto-check: notes
  • Takes a change through a verdaccio pull request: branch, local checks, changeset, title and body, labels, CI and review rounds, and ports to other release lines.

    18k GitHub stars~1.9k tokensUpdated today
    DevelopmentAuto-check passed

More from jsmastery-pro/skills

All 8 skills in this repo
  • Pre-Merge Check

    jsmastery-pro/skills

    A gate before merge: verify runs the real app against the spec, and review has a different model do a senior code review, without editing code.

    1.4k GitHub stars~1.1k tokensUpdated 1 mo ago
    Auto-check: notes
  • Root Cause Debugging

    jsmastery-pro/skills

    Runs a reproduce, localize, hypothesize, test, fix and verify loop to find a bug's root cause, applies the minimal fix and hands off a regression test.

    1.4k GitHub stars~1.8k tokensUpdated 1 mo ago
    Auto-check: notes
  • Develop Feature Builder

    jsmastery-pro/skills

    Builds a feature, page, component, API or data layer from an approved spec and AGENTS.md, and sends you back to /architect when a key decision is missing.

    1.4k GitHub stars~3.8k tokensUpdated 1 mo ago
    Auto-check: notes
  • Sync Project Knowledge

    jsmastery-pro/skills

    Runs as the last step after a completed change to keep AGENTS.md files, the project scope and linked spec status lines current, using only small surgical edits.

    1.4k GitHub stars~3.8k tokensUpdated 1 mo ago
    Auto-check: notes
  • Project Context Auditor

    jsmastery-pro/skills

    Bootstraps a project's tool-agnostic AGENTS.md files for a greenfield project, an undocumented codebase or one area, adding only what is missing and never overwriting curated content.

    1.4k GitHub stars~3.2k tokensUpdated 1 mo ago
    Auto-check: notes
  • Living Product Scope Planner

    jsmastery-pro/skills

    Turns a product idea into a coarse, ordered scope kept in docs/scope, then keeps it current: plan a product, plan the next slice, enroll one feature or reconcile after shipping.

    1.4k GitHub stars~2.8k tokensUpdated 1 mo ago
    Auto-check: notes

Works with

Questions about Change Documentation Writer

What does Change Documentation Writer do?

Writes PR descriptions, changelog entries, release notes and postmortems from the actual commits and diff, and saves each one in the right place. Run it as /document with pr, changelog, release-note or postmortem, or let it ask which one you want. The agent writes from the record only: every sentence has to trace back to a commit, a diff or an incident fact you supplied, and it never invents a timeline entry, a cause or a change.

When should I use Change Documentation Writer?

Change Documentation Writer fits situations like: writing a pull request title and body from the branch commits; adding an entry to CHANGELOG.md after a change merges; drafting end-user release notes for a tagged version; writing up an incident as a postmortem.

How do I install Change Documentation Writer in Claude Code?

Run `npx skills add jsmastery-pro/skills --skill document -a claude-code`. Or copy the skill folder (skills/document in jsmastery-pro/skills) into .claude/skills/document in your project. Claude Code loads it when a task matches its description.

How do I install Change Documentation Writer in Codex?

Run `npx skills add jsmastery-pro/skills --skill document -a codex`. Or copy the skill folder (skills/document in jsmastery-pro/skills) into .agents/skills/document in your project. Codex loads it when a task matches its description.

Can I use Change Documentation Writer in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add jsmastery-pro/skills --skill document -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/document, .gemini/skills/document, .github/skills/document and .opencode/skills/document in your project.

What does Change Documentation Writer need to run?

Going by SKILL.md and its folder, Change Documentation Writer needs the command-line tools its instructions call (git, gh and node). Our summary lists: A Git repository with the commits to describe; GitHub CLI (gh), only if the PR should be created or edited. Its frontmatter pre-approves these tools: Bash, Read, Grep, Glob, Write, Edit, Agent, AskUserQuestion.

Does Change Documentation Writer access the network?

SKILL.md contains no URLs. Its commands use git and gh, which can reach the network depending on how they are called. This is read from the text; nothing was executed.

Is Change Documentation Writer safe to install?

Our automated static check of SKILL.md found notes only (pre-approves every shell command (allowed-tools: bash)), nothing it rates as a warning. It is not a guarantee. Review the folder before installing.

What licence does Change Documentation Writer use?

Change Documentation Writer is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Change Documentation Writer use?

About 2.4k tokens (SKILL.md is roughly 9.6k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Change Documentation Writer?

Skills that share tags, products or a category with Change Documentation Writer: RStudio What's New Page (rstudio/rstudio, 5.1k stars), Technical Writing (frappe/skills, 146 stars), Pull Request (cloudposse/atmos, 1.4k stars) and Pull Request Title and Body Writer (openinterpreter/openinterpreter, 69k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Change Documentation Writer?

jsmastery-pro (a GitHub organization) maintains it in jsmastery-pro/skills, which has 1,429 GitHub stars. The repository holds 8 skills in this directory. The repository was last updated on August 9, 2026.

Source: jsmastery-pro/skills on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.