document-release
by garrytandocument-release is a post-ship documentation update skill that reads project docs, cross-references the shipped diff, and updates README, ARCHITECTURE, CONTRIBUTING, CLAUDE.md, CHANGELOG, and VERSION so docs match what actually shipped. Use the document-release skill for technical writing when code is already merged and you need a reliable document-release guide.
This skill scores 76/100, which means it is a solid listing candidate for directory users who want a dedicated post-ship documentation workflow. The repository gives enough trigger guidance and procedural detail to help an agent use it with less guesswork than a generic prompt, though it still has some adoption caveats around packaging and discoverability.
- Clear trigger language for post-ship doc updates, including 'update the docs', 'sync documentation', and 'post-ship docs'.
- Operational workflow is explicit: reads project docs, cross-references the diff, updates README/ARCHITECTURE/CONTRIBUTING/CLAUDE.md, polishes CHANGELOG, cleans TODOS, and can bump VERSION.
- Strong procedural signals in the body: valid frontmatter, many headings, code fences, repo/file references, and multiple workflow/constraint mentions.
- No install command and no support files (scripts, references, resources, or readme), so users may need to infer setup and usage boundaries from SKILL.md alone.
- The file contains placeholder/WIP markers, which suggests some parts may still be under refinement even though the core workflow is present.
Overview of document-release skill
What document-release is for
document-release is a post-ship documentation update skill for keeping project docs aligned with what actually shipped. It reads the docs, compares them with the recent diff, and helps update files like README.md, ARCHITECTURE.md, CONTRIBUTING.md, CLAUDE.md, CHANGELOG.md, and VERSION when a release changes the story.
Who should use it
This document-release skill is best for technical writers, repo maintainers, and agents that need to turn merged code into accurate documentation with less manual cross-checking. It is especially useful when the code is done but the docs still reflect the old behavior.
Why it matters in practice
The main job-to-be-done is not generic writing; it is release synchronization. The skill is useful when you need a dependable document-release guide that updates prose, trims stale TODOs, and keeps release notes consistent with shipped changes instead of inventing a new narrative from scratch.
How to Use document-release skill
Install and trigger it correctly
Use the document-release install flow in your agent environment, then invoke it when a PR is merged, code is shipped, or someone asks to “update the docs” or “sync documentation.” The skill is designed to be called after implementation, not during exploratory drafting.
Start from the right inputs
Strong prompts include the shipped diff, the affected files, the intended audience, and any release constraints. A weak request like “update docs” forces the skill to guess; a stronger request like “sync docs for the API rename in this merged PR and keep the changelog voice concise” gives it the context needed to edit accurately.
Read these files first
For document-release usage, start with SKILL.md, then inspect the files it points to in your repo, especially README.md, ARCHITECTURE.md, CONTRIBUTING.md, CLAUDE.md, and any release or version files. Also check SKILL.md.tmpl if you want to understand the generated structure and what should stay stable across updates.
Workflow tips that improve output
Use the skill to answer three questions in order: what changed, what docs mention that behavior, and what must be rewritten or removed. If the repo has active TODOs, stale examples, or versioned instructions, call those out explicitly in the prompt so the document-release skill can clean them instead of preserving them.
document-release skill FAQ
Is document-release only for final releases?
No. The document-release skill also fits merged PRs and any post-ship change that makes published docs drift from reality. It is less useful for pre-merge brainstorming and more useful once the source of truth has changed.
How is this different from a normal prompt?
A normal prompt may produce a decent edit, but document-release adds a release-focused workflow: read the docs, cross-reference the diff, update affected files, and keep voice and terminology consistent. That reduces the chance of shipping stale instructions or missing a dependent doc.
Is it suitable for beginners?
Yes, if the user can identify what shipped and which docs need to reflect it. Beginners get the best results when they provide a clear summary of the change, the target repo path, and the files they expect to update.
When should I not use it?
Do not use document-release when you only need a rough draft, a product announcement, or speculative documentation for unfinished code. It is also a poor fit if you cannot access the repo history or the changed files, because the skill depends on grounding edits in what actually changed.
How to Improve document-release skill
Give the skill a tighter release brief
The biggest quality gain comes from naming the exact shipped behavior, the impacted docs, and the tone you want preserved. For example: “Update the docs for the new auth flow, remove outdated setup steps, keep the changelog factual, and do not change architecture notes outside the impacted section.”
Surface the common failure modes
document-release works best when you warn it about stale examples, renamed commands, broken cross-references, or version strings that need to move together. If you know one doc is authoritative and others are derivative, say so; that prevents unnecessary rewrites and keeps the document-release skill focused.
Iterate after the first pass
Review the first output for three things: missing links, outdated screenshots or code samples, and terminology drift across files. Then feed back only the gaps you found, which helps the next pass tighten the document-release install and usage result without re-editing stable sections.
Use the skill as a release checklist
For document-release for Technical Writing, treat the skill like a post-ship QA pass: confirm the docs match shipped behavior, remove dead TODOs, and verify versioned instructions. The best document-release guide inputs are specific enough that the model can reconcile the diff against the repo instead of rewriting everything generically.