skills.rest
billydeeii136
billydeeii136COMMUNITY
Explore all skills by this author →
WebsiteGitHub

document-release

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

Updated Jul 7, 2026
Search Tags:#architecture#documentation#change log#change detection#post-ship
One-click install
npx skills add https://github.com/billydeeii136/black-opps-gstack --skill document-release-billydeeii136
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/billydeeii136/black-opps-gstack/tree/main/document-release
Command: npx skills add https://github.com/billydeeii136/black-opps-gstack --skill document-release-billydeeii136

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 your project's documentation is always up-to-date with the latest changes.

Core Features & Use Cases

  • Documentation Update: Automatically updates README, architecture, contributing, and Claude.md files after a code ship.
  • Change Detection: Identifies what has changed and documents it.
  • Architecture Diagram Drift Detection: Monitors and reports on any changes in architecture diagrams.
  • Change Log Voice Polishing: Enhances the change log with a sell-test rubric.
  • Documentation Debt Reporting: Highlights any documentation gaps in the PR body.
  • Use Case: After merging a pull request, use this Skill to automatically update the project documentation, ensuring it reflects the latest changes.

Quick Start

Use the document-release skill to update the documentation after shipping a new feature.

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 merging a pull request?▼

Post-ship documentation updates are automated by detecting code changes and updating README, architecture, and contributing files to reflect the latest project state.

How does architecture diagram drift detection work for software projects?▼

Architecture diagram drift detection monitors changes in architecture diagrams after a code ship, reporting any deviations to ensure documentation matches the actual codebase structure.

What is documentation debt reporting and how is it added to a pull request?▼

Documentation debt reporting identifies gaps in documentation and highlights them directly within the PR body, ensuring undocumented changes are tracked for future updates.

Can I use Bash and Grep to identify changed files for change log generation?▼

Yes, Bash and Grep are used to perform change detection across the project, identifying what has changed so the change log can be automatically generated and polished.

What is the best way to polish a change log using a sell-test rubric?▼

Change log voice polishing applies a sell-test rubric to enhance generated change log entries, improving readability and ensuring updates clearly communicate value to users.

Related Skills

Explore More Software Engineering Skills→
mostafasudomostafasudo
3

document-release

Compare project documentation with the latest codebase and update files after release.

Community
Advanced
ShmurdocShmurdoc

document-release

Synchronize project documentation with code diffs after releases.

Community
Advanced
AnveioAnveio
1

task-pull-request

Automate GitHub pull request creation, reviews, feedback, and merges via gh CLI.

Community
Intermediate
brainbrewlabsbrainbrewlabs
7

doc-publishing

Publishes documentation to GitHub Pages, Vercel, or Netlify from source docs and build outputs.

Official
Intermediate