document-release

Analyze diffs and update core documentation files after release.

Updated Dec 22, 2019
One-click install
npx skills add https://github.com/sajalsuhane/sajalsuhane.github.io --skill document-release-sajalsuhane
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/sajalsuhane/sajalsuhane.github.io/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/sajalsuhane/sajalsuhane.github.io --skill document-release-sajalsuhane

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation often drifts as code and docs diverge. This Skill automates alignment by reading shipped changes, cross-referencing docs, and updating README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md to reflect what shipped.

Core Features & Use Cases

  • Auto-audit diffs to identify documentation drift
  • Update core docs to mirror shipped changes
  • Maintain tone and consistency across docs

Quick Start

Run the document-release workflow after a ship to synchronize all docs with the latest code and changes.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I automate post-ship documentation updates to fix README and ARCHITECTURE drift?

Automate post-ship documentation updates by analyzing code diffs against core docs and applying precise, line-item changes. This synchronizes README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md to accurately reflect shipped changes and architecture decisions.

What is the best way to synchronize CONTRIBUTING.md and CLAUDE.md after a code release?

Synchronize contributor guidelines and project docs by running a post-ship workflow that cross-references shipped code diffs. It audits documentation drift and applies structured auto-updates while preserving changelog integrity and maintaining tone consistency.

Can I audit README.md for documentation drift automatically after shipping new code?

Yes, you can audit README.md for documentation drift automatically. The workflow analyzes code diffs against the repository's core docs, identifies inconsistencies, and applies precise line-item changes to ensure documentation mirrors the latest shipped code.

Does the documentation sync workflow preserve changelog integrity during auto-updates?

Yes, the documentation sync workflow preserves changelog integrity during auto-updates. It applies structured changes to core docs while maintaining safety checks, per-file audits, and consistent tone across README, ARCHITECTURE, CONTRIBUTING, and CLAUDE files.

When do I need to run a documentation diff analysis for my release cycle?

Run a documentation diff analysis during release cycles where documentation must reflect code shipped, architecture decisions, and contributor guidelines. It ensures consistency across the project by auto-auditing diffs and updating core docs to mirror the latest changes.

Are there limitations to automated line-item doc updates for architecture decisions?

Automated line-item doc updates apply precise changes to ARCHITECTURE.md based on code diffs, but require safety checks and per-file audits. Limitations include ensuring tone consistency and preserving changelog integrity while applying structured auto-updates across the project workflow.