post-ship-doc-sync

Community

Keep docs fresh after releases.

Authorjlaws
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Reusable workflow to discover and fix stale documentation after shipping changes. Use when docs may be out of date after a release, merge, or significant feature work. Do NOT use for writing new documentation from scratch (use documentation-writer agent).

Core Features & Use Cases

  • Scan for documentation files in common locations: README*, ARCHITECTURE*, CONTRIBUTING*, CLAUDE.md, CHANGELOG*, the docs/ directory (all .md files), and any root-level .md files.
  • Compare changes since the last release (default to last tag..HEAD) to identify stale sections such as API references, setup/install, architecture, config references, CLI usage, and feature docs.
  • Produce minimal, surgical edits and a diff preview for approval before applying changes.

Quick Start

Use the post-ship-doc-sync workflow to identify stale docs after a release and generate targeted edits for review.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: post-ship-doc-sync
Download link: https://github.com/jlaws/dotfiles/archive/main.zip#post-ship-doc-sync

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.