document-release

Automate project documentation updates by reviewing code changes and editing markdown files.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the process of updating project documentation files, ensuring consistency between shipped code and associated documentation, reducing manual oversight.

Core Features & Use Cases

  • Documentation Synchronization: Reads all project docs, cross-references differences, updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md files to match shipped code.
  • Changelog and Todo Management: Polishes changelog voice, cleans up TODOs, and optionally bumps the project version.
  • Use Case: After a release, run this Skill to automatically ensure documentation reflects the latest shipped features and fixes, and prepare for next development cycle.

Quick Start

Invoke the skill with "update the project documentation after a release" to synchronize project files and ensure documentation accuracy.

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 a code release?

To automate documentation updates after a code release, you can use a skill that reads code changes and edits markdown files. It reviews differences to automatically update README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md files to match shipped code.

What is the best way to keep a project changelog consistent with shipped code?

Keeping a changelog consistent with shipped code involves cross-referencing code changes and polishing the changelog voice. This skill automates that process, cleaning up TODOs and optionally bumping the project version during release workflows.

Can I sync README and ARCHITECTURE markdown files automatically?

Yes, you can sync README and ARCHITECTURE markdown files automatically by running a documentation synchronization tool. It cross-references differences in shipped code and edits key markdown files to ensure accurate, up-to-date project documentation.

Do I need scripting capabilities to maintain documentation accuracy?

Yes, scripting and file editing capabilities are required to maintain documentation accuracy. The automated synchronization process relies on scripts to read project docs, cross-reference differences, and edit text and markdown files.

When should I update project documentation in my development cycle?

You should update project documentation immediately after a release to prepare for the next development cycle. Running an automated documentation sync ensures your files reflect the latest shipped features and fixes, reducing manual oversight.

Why does my project documentation fall out of sync after shipping?

Project documentation falls out of sync after shipping due to manual oversight when updating multiple files. Automating the process by reviewing code changes and editing markdown files ensures consistency between shipped code and associated documentation.