skills.rest
luisgustavooliveira
luisgustavooliveiraCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

document-release

Synchronize README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md with shipped code using Git.

Updated Feb 27, 2026
Search Tags:#document management#Git integration#codebase maintenance#post-ship update#automated synchronization
One-click install
npx skills add https://github.com/luisgustavooliveira/skills --skill document-release-luisgustavooliveira
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/luisgustavooliveira/skills/tree/main/document-release
Command: npx skills add https://github.com/luisgustavooliveira/skills --skill document-release-luisgustavooliveira

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires bash, read, write, edit, grep, glob, askuserquestion, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the post-ship documentation update process, ensuring that READMEs, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md are synchronized with the shipped code.

Core Features & Use Cases

  • Automated Documentation Updates: Automatically updates documentation files after code is shipped, including README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md.
  • Proactive Synchronization: Can be proactively suggested after merging PRs or shipping code to keep documentation up-to-date.
  • Customization: Optionally bump the version number after updates.
  • Use Case: Ideal for developers and maintainers who want to ensure that the documentation accurately reflects the shipped codebase.

Quick Start

Run the 'document-release' skill after a PR merge or code shipment to update documentation automatically.

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 shipping code?▼

Automating post-ship documentation updates is handled by synchronizing README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md files with the shipped codebase using Git integration and text manipulation tools.

What is the best way to keep README and ARCHITECTURE files synchronized with merged code?▼

Keeping README and ARCHITECTURE files synchronized with merged code is achieved by running an automated synchronization process after PR merges to ensure documentation accurately reflects the latest codebase state.

Can I automatically bump the version number when updating project documentation?▼

Automatically bumping the version number during project documentation updates is supported as an optional customization feature, allowing you to maintain accurate versioning alongside synchronized post-ship docs.

Does this documentation synchronization approach work with Git workflows?▼

Documentation synchronization with Git workflows is fully supported, utilizing Git and various text manipulation tools like bash, grep, and glob to update specified files in the codebase after code shipment.

When do I need to update post-ship documentation for my codebase?▼

Updating post-ship documentation for your codebase is needed after merging PRs or shipping code, ensuring that project files like CONTRIBUTING and CLAUDE.md remain accurate and synchronized with the shipped code.

Related Skills

Explore More Software Engineering Skills→
smarmen86smarmen86

document-release

Synchronize README, architecture, and changelog files after code deployment.

Community
Advanced
zhu637882-stackzhu637882-stack

document-release

Update project docs and changelog to reflect a shipped diff.

Community
Advanced
leha-creatorleha-creator

ai-factory.evolve

Analyze project context and patches to refine AI Factory skills.

Community
Advanced
alvazonealvazone
3

traverspec-reconcile

Compare spec nodes against codebase implementation to identify drift.

Community
Intermediate