document-release

Synchronize markdown documentation with shipped code changes via git diffs.

3|14|Updated Mar 10, 2026
One-click install
npx skills add https://github.com/cegit27/moodle-proctor --skill document-release-cegit27
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/cegit27/moodle-proctor/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/cegit27/moodle-proctor --skill document-release-cegit27

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Shipping code is only half the battle. Documentation quickly becomes stale, misleading users and wasting time on outdated instructions. This Skill automates the post-ship documentation update process, reading your project docs, cross-referencing the git diff, and updating README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md files to match what actually shipped.

Core Features & Use Cases

  • Diff-aware doc updates: Analyzes recent code changes and updates documentation sections that reference modified features, APIs, or architecture.
  • Multi-file synchronization: Updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md in one pass to maintain consistency.
  • Changelog and TODO cleanup: Polishes CHANGELOG voice for clarity and removes completed TODOs from the codebase.
  • Optional version bumping: Automatically increments VERSION files to match the new release state.
  • Use Case: After merging a PR that adds WebSocket-based live monitoring to the backend, this Skill updates the architecture diagram in the README, adds the new endpoint to the API docs, and bumps the version from 1.2.0 to 1.3.0.

Quick Start

Use the document-release skill to update all project documentation to match your latest 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 automate documentation updates after shipping code changes?

Automate post-ship documentation updates by cross-referencing git diffs with existing docs to synchronize README, ARCHITECTURE, and CONTRIBUTING files with shipped code changes. It reads markdown files and applies targeted updates to reflect new features, APIs, or architecture modifications.

What is the best way to keep my README and changelog consistent with git commits?

Keeping README and changelog consistent involves multi-file synchronization across your project, analyzing recent git diffs to update documentation sections and polishing the CHANGELOG voice. This automated approach ensures docs match shipped code by updating all related files in one pass.

Can I automatically bump version files and clean up TODOs when merging a PR?

Yes, you can automatically bump VERSION files to match a new release state and remove completed TODOs from the codebase. This cleanup happens during the documentation synchronization pass, ensuring your versioning and task tracking stay current with merged code.

Do I need git repository access to synchronize markdown documentation with shipped code?

Yes, git repository access is required to cross-reference diffs and apply targeted updates. The Skill needs read and write access to both markdown documentation files and the git repository to identify code changes and update ARCHITECTURE or CLAUDE.md files accordingly.

Does multi-file documentation synchronization work across large codebases?

Multi-file documentation synchronization works across multi-file codebases by updating README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md in one pass. It targets documentation sections referencing modified features, APIs, or architecture to maintain consistency regardless of project scale.