document-release

Audit and update project documentation to match committed code changes.

1|Updated Jul 7, 2026
One-click install
npx skills add https://github.com/the-inconvenience-store/superbeads --skill document-release-the-inconvenience-store
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/the-inconvenience-store/superbeads/tree/main/skills/document-release
Command: npx skills add https://github.com/the-inconvenience-store/superbeads --skill document-release-the-inconvenience-store

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill ensures that all project documentation accurately reflects the committed code changes before merging into the main branch, preventing documentation drift.

Core Features & Use Cases

  • Post-Ship Documentation Update: Triggers on specific commands to update documentation, such as "update docs", "sync documentation", or "post-ship docs".
  • Documentation Audit: Covers README, ARCHITECTURE, CONTRIBUTING, CHANGELOG, CLAUDE.md, TODOS, and VERSION files.
  • 9-Step Process: A comprehensive methodology for detecting and correcting documentation inconsistencies and ensuring all documentation is in sync with the codebase.

Quick Start

Run the 'document-release' skill after code changes are committed but before PR merge to ensure all project documentation is updated.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I prevent documentation drift after committing code changes?

To prevent documentation drift, you need to audit and update project documentation to match committed code changes. This skill triggers via commands like 'update docs' to ensure README, CHANGELOG, and architecture files accurately reflect the codebase before merging.

What is the best way to sync project documentation with committed code?

The best way to sync documentation is running a comprehensive audit that checks README, ARCHITECTURE, CONTRIBUTING, CHANGELOG, CLAUDE.md, TODOS, and VERSION files against committed code changes. This ensures all critical documentation remains consistent with the codebase.

When should I run a documentation update in my development workflow?

You should run a documentation update after code changes are committed but before merging your pull request into the main branch. This timing ensures all project documentation is updated and accurate before changes are integrated into the main codebase.

How does the 9-step documentation audit process work?

The 9-step documentation audit process works by systematically detecting and correcting inconsistencies between your codebase and project files. It covers all critical documentation files to ensure no documentation drift occurs and maintains strict consistency between code and documentation.

Can I use this documentation sync tool without any external dependencies?

Yes, you can use this documentation sync tool without external dependencies. It operates independently using internal scripts to audit and update documentation, ensuring accuracy with committed code changes without requiring additional project management or version control packages.

Does the documentation update cover CONTRIBUTING and VERSION files?

Yes, the documentation update explicitly covers CONTRIBUTING and VERSION files, alongside README, ARCHITECTURE, CHANGELOG, CLAUDE.md, and TODOS files. This comprehensive coverage ensures all critical project documentation stays synchronized with committed code changes.