document-release

Update project documentation to match shipped software changes and release status.

2|1|Updated May 20, 2026
One-click install
npx skills add https://github.com/balajivis/multiagent-primer --skill document-release-balajivis
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/balajivis/multiagent-primer/tree/main/lab0-workflow/gstack/document-release
Command: npx skills add https://github.com/balajivis/multiagent-primer --skill document-release-balajivis

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill solves the problem of outdated project documentation after code changes ship by aligning docs with the actual implementation and release state.

Core Features & Use Cases

  • Documentation Synchronization: Reviews README, architecture notes, contributor guides, and project instructions against recent changes.
  • Release Documentation Cleanup: Updates factual documentation gaps, improves changelog wording, and checks cross-document consistency.
  • Use Case: After merging a feature branch, use this Skill to verify that project documentation reflects the shipped functionality and remaining release tasks.

Quick Start

Use the document-release skill to update the project documentation after the latest code changes have shipped.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I update outdated project documentation after merging a feature branch?

To update outdated project documentation after a merge, inspect the repository diff and edit README files, architecture notes, and contributor guides to match the shipped software changes and release status.

How do I synchronize a changelog with recent code changes and release status?

To synchronize a changelog with recent code changes, analyze the repository diff, improve the changelog wording, fill factual documentation gaps, and perform cross-document consistency checks against the shipped implementation.

What is the best way to ensure README and architecture documents match shipped code?

The best way to ensure README and architecture documents match shipped code is to run a post-ship documentation synchronization workflow that performs repository inspection, diff analysis, and controlled versioning decisions.

When do I need to run a documentation cleanup workflow for a repository release?

You need to run a documentation cleanup workflow for a repository release after merging code changes to verify that project instructions, contributor guides, and factual documentation accurately reflect the shipped functionality and remaining tasks.

Can I use repository diff analysis to fix factual gaps in contributor guides and project instructions?

Yes, you can use repository diff analysis to fix factual gaps in contributor guides and project instructions by comparing recent code changes against existing documentation, editing outdated text, and applying consistency checks across the repository.