skills.rest
tgmarinho
tgmarinhoCOMMUNITY
Explore all skills by this author →
Website𝕏@tgmarinhoGitHub

document-release

Updates project documentation to match shipped code changes after a release.

Updated May 15, 2026
Search Tags:#changelog#documentation#readme#release#diataxis#git diff#post-ship
One-click install
npx skills add https://github.com/tgmarinho/canetaco --skill document-release-tgmarinho
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/tgmarinho/canetaco/tree/main/.claude/skills/document-release
Command: npx skills add https://github.com/tgmarinho/canetaco --skill document-release-tgmarinho

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? After shipping code, project documentation drifts out of sync with reality. This Skill reads all project docs, cross-references the git diff, and updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to match what actually shipped, surfacing documentation debt in the PR body. ## Core Features & Use Cases - Diataxis Coverage Mapping: Builds a coverage map across reference, how-to, tutorial, and explanation doc types to find gaps. - Doc Synchronization: Updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md against the shipped diff, and detects architecture diagram drift. - Release Hygiene: Polishes CHANGELOG voice with a sell-test rubric, cleans up TODOs, and optionally bumps VERSION. - Use Case: After merging a feature PR, ask the agent to sync the docs; it reviews the diff, rewrites stale sections, and reports remaining documentation debt. ## Quick Start Ask the agent to update the docs and sync documentation with what just shipped.

Frequently Asked Questions about document-release

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I update documentation after shipping code?▼

Invoke the skill after a PR merges or code ships. It reads all project docs, cross-references the git diff, and rewrites stale sections of README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to match what shipped.

What is a Diataxis documentation coverage map?▼

Diataxis splits docs into four types: reference, how-to, tutorial, and explanation. The skill builds a coverage map across these quadrants so you can see which doc types are missing or stale for the shipped changes.

Can it detect outdated architecture diagrams?▼

Yes. The skill detects architecture diagram drift by comparing documented diagrams against the current codebase structure, flagging diagrams that no longer reflect the shipped system.

Does it update the CHANGELOG and version automatically?▼

It polishes CHANGELOG entries using a sell-test voice rubric and can optionally bump the VERSION file. Version bumps are optional and confirmed during the workflow rather than applied silently.

When should I run post-ship documentation updates?▼

Run it after a PR is merged or code is shipped, before documentation debt accumulates. The skill surfaces remaining doc debt in the PR body so gaps stay visible to the team.

Related Skills

Explore More Software Engineering Skills→
davidabeyerdavidabeyer
13

shipping-worktree

Automate shipping Git worktree changes to the main branch.

Official
Advanced
typemdtypemd
9

create-release

Gather closed issues and commits to draft release notes and create a GitHub draft release.

Official
Advanced
cvenwucvenwu

ship

Coordinate base-branch detection, tests, diff review, version bumps, and PR creation.

Community
Advanced
Varnan-TechVarnan-Tech
581

docs-from-code

Generate README.md and API reference docs from a codebase knowledge graph.

Official
Advanced