skills.rest
miko06
miko06COMMUNITY
Explore all skills by this author →
GitHub

document-release

Update project documentation files after shipping using Git and Bash.

Updated Jun 16, 2026
Search Tags:#documentation#version control#Markdown#codebase synchronization#post-ship
One-click install
npx skills add https://github.com/miko06/MedicineSimulator --skill document-release-miko06
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/miko06/MedicineSimulator/tree/main/.opencode/skills/gstack-document-release
Command: npx skills add https://github.com/miko06/MedicineSimulator --skill document-release-miko06

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires Git, Bash, Markdown, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the process of updating documentation after a project has been shipped, ensuring that the documentation remains consistent with the latest project changes.

Core Features & Use Cases

  • Documentation Update: Automatically updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md files to reflect the latest shipped changes.
  • Change Detection: Identifies and reports on changes made to the project that should be documented.
  • Use Case: After a new feature is released, this Skill can be used to update the documentation, ensuring that all relevant information is up to date.

Quick Start

Run the document-release skill to update the project documentation after a new feature has been shipped.

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 a new feature?▼

To automate documentation updates after shipping, you can use version control and text comparison tools to detect codebase changes and automatically modify project Markdown files like README and ARCHITECTURE.

What is the best way to keep project documentation consistent with codebase changes?▼

Keeping project documentation consistent requires automatically detecting post-ship changes and applying text updates to Markdown files, ensuring documentation accurately reflects the latest codebase modifications.

Do I need Git and Bash to automate post-ship documentation synchronization?▼

Yes, you need Git and Bash to automate post-ship documentation synchronization, as these tools are required to track version control changes and execute scripts for updating Markdown files.

Which documentation files can be automatically updated when a project is released?▼

When a project is released, documentation files like README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md can be automatically updated to reflect the latest shipped changes.

Can I detect undocumented changes in my codebase before finalizing a release?▼

Yes, change detection mechanisms identify and report on codebase modifications that should be documented, allowing you to verify undocumented changes before or after finalizing a release.

Why does my Markdown documentation not reflect recent Git commits after a release?▼

Markdown documentation fails to reflect recent Git commits when post-ship updates are not automated, requiring text comparison and version control synchronization to align files with the latest changes.

Related Skills

Explore More Software Engineering Skills→
alexanderopalexanderop

using-git-worktrees

Create isolated git worktrees for feature branches with safety checks.

Community
Advanced
luisgustavooliveiraluisgustavooliveira

document-release

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

Community
Intermediate
wineastwineast
1

review-changes

Generate markdown reports of local Git changes for code review.

Community
Intermediate
zzafergokzzafergok
1

markdown-to-html-skill

Convert Markdown documents to HTML using marked.js, pandoc, gomarkdown, or static site generators.

Community
Intermediate