document-release

Synchronize project documentation with shipped code after PR merges.

Updated Jul 21, 2025
One-click install
npx skills add https://github.com/robertzengcn/aiFetchly --skill document-release-robertzengcn
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/robertzengcn/aiFetchly/tree/main/.agents/skills/gstack/document-release
Command: npx skills add https://github.com/robertzengcn/aiFetchly --skill document-release-robertzengcn

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

After code is shipped or a PR is merged, project documentation often falls out of sync, leading to outdated READMEs, architecture drift, missing changelog entries, and undocumented changes that confuse users and contributors. This Skill eliminates that manual, error-prone work by automatically aligning all project docs with what actually shipped.

Core Features & Use Cases

  • Cross-Doc Sync: Automatically updates README, ARCHITECTURE, CONTRIBUTING, and AGENTS.md files to match shipped code changes by cross-referencing code diffs against existing documentation.
  • Coverage Mapping: Builds a Diataxis (reference/how-to/tutorial/explanation) coverage map to identify gaps in your documentation suite.
  • Debt Surfacing: Detects architecture diagram drift, polishes CHANGELOG voice, cleans up stale TODOs, and surfaces all documentation debt directly in the PR body for easy tracking.
  • Use Case: After merging a PR that adds a new local business finder feature to your marketing tool, this Skill automatically updates the feature list in the README, adds the new API to the architecture docs, and notes missing tutorial content for the new feature in the PR.

Quick Start

Use the document-release skill to sync all project documentation with the changes from the most recently merged PR.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I sync project documentation after merging a PR?

To sync project documentation after a PR merge, you can automatically cross-reference code diffs against existing files to update READMEs and architecture docs. This eliminates manual synchronization and prevents documentation drift in shipped code.

What is documentation debt and how do I surface it in a PR?

Documentation debt is the gap between shipped code and outdated project docs. You can surface this debt directly in a PR body by detecting architecture diagram drift, cleaning stale TODOs, and noting missing changelog entries automatically.

How does a Diataxis coverage map identify missing documentation?

A Diataxis coverage map identifies missing documentation by categorizing existing content into reference, how-to, tutorial, and explanation sections. It reveals structural gaps in your documentation suite after new features are shipped.

Can I automatically update my README and architecture diagrams after a feature release?

Yes, you can automatically update README and architecture files after a feature release. By cross-referencing code diffs with existing documentation, the system detects architecture drift and updates content to match the newly shipped code.

What is the best way to prevent architecture drift in code repositories?

The best way to prevent architecture drift is to automatically cross-reference code diffs against architecture documentation after every release. This detects outdated diagrams and updates core project documentation files to match shipped changes.

Do I need to manually write changelog entries for every merged PR?

No, you do not need to manually write changelog entries for every merged PR. You can automatically polish changelog voice and generate entries by analyzing code diffs post-ship, ensuring all changes are documented consistently.