skills.rest
esopian
esopianCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

document-release

Update project documentation files to reflect shipped code and version changes.

2|Updated Apr 10, 2026
Search Tags:#automation#changelog#documentation#release#sync#update
One-click install
npx skills add https://github.com/esopian/blue-oak-audit --skill document-release-esopian
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/esopian/blue-oak-audit/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/esopian/blue-oak-audit --skill document-release-esopian

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill automates the update and synchronization of project documentation after code ships, preventing outdated docs and ensuring consistency across key files.

Core Features & Use Cases

  • Complete Documentation Update: Reads project docs like README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md, then updates them to reflect the latest shipped code and features.
  • Changelog and Todo Management: Polishes CHANGELOG entries, cleans up TODO comments, and optionally bumps version numbers to keep release notes accurate.
  • Use Case: After merging a new feature, run this Skill to automatically update the project's documentation files and keep all descriptions aligned with the current product state.

Quick Start

Run the document-release skill to automatically update all project documentation files with the latest shipped changes and version bumps.

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 release?▼

To automate documentation updates, run the document-release skill to read project docs, cross-reference shipped code, and modify files like README and ARCHITECTURE to reflect the latest changes without manual editing.

What is the best way to keep a changelog and documentation in sync?▼

The best way to keep changelogs and documentation in sync is to automate the process by polishing CHANGELOG entries, cleaning up TODO comments, and bumping version numbers to match shipped code updates.

Can I automatically update internal and public documentation after merging code?▼

Yes, you can automatically update internal and public documentation after merging code by running a script that reads and modifies key project files, ensuring descriptions align with the current product state.

Does this documentation sync tool require any external dependencies?▼

No, this documentation sync tool requires no external dependencies to function, allowing you to directly read and modify project documentation files within your existing development workflow.

When do I need to update project documentation files in my development workflow?▼

You need to update project documentation files in your development workflow after shipping new code or features to prevent outdated docs and ensure consistency across key files like CONTRIBUTING and CLAUDE.md.

Related Skills

Explore More Content & Communication Skills→
vadimcomanescuvadimcomanescu
24

finishing-a-development-branch

Synchronize a development branch with its base and run tests and linters.

Community
Advanced
marcel-heinzmarcel-heinz
4

release

Coordinate ClawCity release workflows with version bumps, changelog updates, git tagging, and GitHub releases.

Community
Advanced
Jia-Hong-PengJia-Hong-Peng

document-release

Synchronize project documentation with shipped code changes across multiple document types.

Community
Advanced
miXshiftmiXshift
2

release-docs

Scan README, CHANGELOG, FAQs, and plugin.json for release documentation accuracy.

Official
Intermediate