skills.rest
dogeared
dogearedCOMMUNITY
Explore all skills by this author →
Website𝕏@afitnerdGitHub

document-release

Align README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md with shipped code changes.

Updated Dec 13, 2017
Search Tags:#documentation#consistency#diff#docs#update#post-ship
One-click install
npx skills add https://github.com/dogeared/tnra --skill document-release-dogeared
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/dogeared/tnra/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/dogeared/tnra --skill document-release-dogeared

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation often drifts from what shipped. This Skill automatically updates and aligns README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md to reflect shipped changes.

Core Features & Use Cases

  • Synchronizes documentation across project files to reflect changes that were shipped in a PR.
  • Polishes CHANGELOG voice while preserving existing entries.
  • Detects inconsistencies and suggests targeted updates to keep docs accurate.

Quick Start

Scan the latest diff and automatically update project docs to reflect shipped changes.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I automatically update documentation after a pull request merge?▼

You can automatically update documentation after a PR merge by scanning the latest diff and applying idempotent edits to keep docs aligned with shipped changes.

Does this sync changes to README, ARCHITECTURE, and CONTRIBUTING files?▼

Yes, it synchronizes README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md by cross-referencing diffs to ensure documentation consistency.

What is the best way to keep docs consistent with shipped code changes?▼

The best way to keep docs consistent is automating post-ship updates that detect inconsistencies and apply safe, targeted edits to markdown files.

Can I polish my CHANGELOG voice while preserving existing entries?▼

Yes, you can polish your CHANGELOG voice while preserving existing entries as part of the automated documentation synchronization process.

Are the edits to markdown files safe if I run the documentation sync multiple times?▼

Yes, the documentation sync performs safe, idempotent edits to markdown files, requiring minimal manual edits across multiple runs.

Related Skills

Explore More Content & Communication Skills→
huichenhuichen

document-release

Update project documentation files after code ships.

Community
Advanced
miko06miko06

document-release

Update project documentation files after shipping using Git and Bash.

Community
Advanced
samjhechtsamjhecht
4

finishing-a-development-branch

Validate tests and TDD compliance before presenting merge, PR, keep, or discard options.

Community
Intermediate
dallaydallay

markdown-a11y

Review markdown files for accessibility issues and provide prioritized linting commands.

Official
Intermediate