document-release

Update project markdown documentation by cross-referencing git diffs after code commits.

11|2|Updated Mar 31, 2026
One-click install
npx skills add https://github.com/ajsai47/holyclaude --skill document-release-ajsai47
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/ajsai47/holyclaude/tree/main/skills/team/document-release
Command: npx skills add https://github.com/ajsai47/holyclaude --skill document-release-ajsai47

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

After shipping code, documentation often drifts out of sync. READMEs become stale, CHANGELOGs lose their voice, and ARCHITECTURE docs no longer reflect reality. This skill automates the tedious post-ship documentation update process, ensuring every markdown file in your project accurately describes what actually shipped.

Core Features & Use Cases

  • Cross-Doc Sync: Reads all project docs and cross-references the git diff to update README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md files.
  • CHANGELOG Polish: Refines the voice and clarity of existing CHANGELOG entries without rewriting history.
  • TODO Cleanup: Marks completed TODOS and flags new ones based on shipped changes.
  • Version Bump Option: Optionally updates VERSION files when appropriate.

Quick Start

Run the document-release skill immediately after merging a PR to automatically audit and update all project documentation files to match the shipped code.

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 markdown documentation after a git commit?

To update markdown documentation after a git commit, you can cross-reference git diffs against project files to selectively edit README, ARCHITECTURE, and CHANGELOG docs, ensuring they accurately match the shipped code.

What is the best way to keep a CHANGELOG consistent with merged PRs?

Keeping a CHANGELOG consistent with merged PRs involves parsing markdown files and refining existing entries based on git diff analysis, maintaining factual accuracy and voice consistency without rewriting project history.

How does cross-referencing git diffs against project docs prevent documentation drift?

Cross-referencing git diffs against project docs prevents documentation drift by analyzing code changes and applying selective file editing to markdown files, ensuring every document accurately reflects what actually shipped.

Can I automatically mark completed TODOs in markdown files after shipping code?

Yes, you can automatically mark completed TODOs and flag new ones in markdown files by analyzing shipped changes from git diffs and updating the documentation to reflect the current project state.

Does post-ship documentation update work for CLAUDE.md and CONTRIBUTING files?

Post-ship documentation updates do work for CLAUDE.md and CONTRIBUTING files, reading all project docs and cross-referencing them with git diffs to maintain factual accuracy across every markdown file in your project.

When should I avoid automating README and ARCHITECTURE doc updates?

You should avoid automating README and ARCHITECTURE doc updates when a project lacks git diff history or when documentation requires manual narrative restructuring that exceeds selective markdown parsing and editing capabilities.