skills.rest
WillNigri
WillNigriCOMMUNITY
Explore all skills by this author →
𝕏@willnigriGitHub

document-release

Synchronize project documentation with shipped code by cross-referencing diffs.

33|6|Updated Mar 17, 2026
Search Tags:#changelog#versioning#documentation#diff#polish#docs-sync
One-click install
npx skills add https://github.com/WillNigri/Agentic-Tool-Optimization --skill document-release-willnigri
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/WillNigri/Agentic-Tool-Optimization/tree/main/.claude/skills/document-release
Command: npx skills add https://github.com/WillNigri/Agentic-Tool-Optimization --skill document-release-willnigri

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation updates are often inconsistent with shipped code. This Skill reads project docs, cross-references diffs, and updates READMEs, ARCHITECTURE, CONTRIBUTING, CLAUDE.md, CHANGELOG, and other references to reflect the actual shipped state.

Core Features & Use Cases

  • Automated cross-file doc alignment: synchronize documentation across multiple files to reflect the latest changes.
  • CHANGELOG-safe polishing: adjust language without rewriting historical entries and preserve integrity.
  • Scope-aware edits: apply updates across the most relevant docs in a single run.
  • Use Case: After shipping a release, run the skill to ensure docs stay aligned with code.

Quick Start

Update docs to reflect the latest ship by running the document-release skill in your repository.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I automate documentation updates after a release?▼

To automate post-ship documentation updates, you can run this Skill in your repository to cross-reference code diffs and apply factual corrections across READMEs, ARCHITECTURE, CONTRIBUTING, CLAUDE.md, and CHANGELOG files.

How do I sync my CHANGELOG with shipped code without rewriting history?▼

To sync your CHANGELOG with shipped code safely, this Skill applies CHANGELOG-safe polishing rules that adjust language and apply factual corrections while preserving the integrity of historical entries.

What is the best way to align project docs with versioning diffs?▼

Aligning project docs with versioning diffs is done by cross-referencing shipped code changes and applying scope-aware edits across core documentation files to ensure consistency after releases.

Does this documentation sync tool modify multiple files in a single run?▼

Yes, this documentation sync tool performs scope-aware edits across multiple files like READMEs, ARCHITECTURE, CONTRIBUTING, CLAUDE.md, and CHANGELOG in a single run to reflect the latest shipped state.

Can I use this to rewrite the narrative in my README after shipping?▼

No, this Skill focuses on factual corrections rather than narrative rewrites, applying safe editing rules to ensure documentation accurately reflects the actual shipped code without altering the original narrative style.

When do I need to update project documentation after a code release?▼

You need to update project documentation after a code release when shipped code changes introduce inconsistencies, requiring cross-file doc alignment to synchronize references with the actual shipped state.

Related Skills

Explore More Content & Communication Skills→
a29paula29paul
1

document-release

Synchronize project documentation with shipped code using git diffs.

Community
Advanced
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced
jg-chalk-iojg-chalk-io

moai-docs-validation

Validate documentation against SPECs and MoAI-ADK standards.

Community
Intermediate
Lautaro073Lautaro073

doc-maintenance

Audit top-level documentation against recent git history to detect drift.

Community
Intermediate