skills.rest
sobhanashine
sobhanashineCOMMUNITY
Explore all skills by this author →
GitHub

document-release

Update markdown documentation files after shipping new versions.

1|Updated May 12, 2026
Search Tags:#documentation#version control#software development#change detection#post-ship
One-click install
npx skills add https://github.com/sobhanashine/nazarato --skill document-release-sobhanashine
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/sobhanashine/nazarato/tree/main/.claude/skills/document-release
Command: npx skills add https://github.com/sobhanashine/nazarato --skill document-release-sobhanashine

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill streamlines the post-ship documentation update process, ensuring accurate and up-to-date project records while automating repetitive tasks.

Core Features & Use Cases

  • Documentation Update: Automatically update README, architecture, contributing, and Claude.md files to reflect the latest shipped changes.
  • Change Detection: Identify and document what has changed between shipping versions.
  • Proactive Updates: Suggest documentation updates after a PR is merged or code is shipped, helping maintain a proactive documentation strategy.
  • Use Case: After deploying a new version of the software, use this Skill to automatically update all relevant documentation files and ensure that the documentation reflects the new changes.

Quick Start

Run the document-release skill to update all project documentation after a new version is 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 post-ship documentation updates after deploying a new version?▼

To automate post-ship documentation updates, use this Skill to compare change logs, update relevant markdown files like README and architecture docs, and flag documentation debt in PRs after new versions are shipped.

What is the best way to detect and document changes between software release versions?▼

The best way to detect and document changes between shipping versions is using a change detection process that compares git repository change logs and automatically reflects new modifications in your project documentation.

Can I use this to flag documentation debt in merged PRs?▼

Yes, you can flag documentation debt in PRs by proactively suggesting documentation updates after a PR is merged or code is shipped, helping maintain a proactive documentation strategy across your software development workflow.

Do I need a git repository to maintain accurate project records with this process?▼

Yes, you need access to a git repository and relevant documentation files. The process requires repository access to compare change logs and update markdown files accurately after shipping new software versions.

How does change detection work for markdown files in version control systems?▼

Change detection for markdown files works by comparing change logs within version control systems, identifying what has changed between shipping versions, and updating relevant documentation files to reflect the latest shipped modifications.

Related Skills

Explore More Software Engineering Skills→
miko06miko06

document-release

Update project documentation files after shipping using Git and Bash.

Community
Advanced
NehaTanti-afkNehaTanti-afk

update-docs

Analyze codebase changes and propose updates to affected documentation files.

Community
Advanced
tamnguyentommy-rgbtamnguyentommy-rgb
2

post_merge_setup

Automate post-merge script execution and workflow reconciliation in CI pipelines.

Community
Advanced
billydeeii136billydeeii136

document-release

Automate post-ship documentation updates with change detection and debt reporting.

Community
Advanced