skills.rest
jlaws
jlawsCOMMUNITY
Explore all skills by this author →
GitHub

post-ship-doc-sync

Identify stale documentation after releases and generate diff previews for approval.

2|Updated Jan 3, 2026
Search Tags:#workflow#documentation#release#diff#stale-docs
One-click install
npx skills add https://github.com/jlaws/dotfiles --skill post-ship-doc-sync
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: post-ship-doc-sync
Source: https://github.com/jlaws/dotfiles/tree/main/.agents/skills/workflow/post-ship-doc-sync
Command: npx skills add https://github.com/jlaws/dotfiles --skill post-ship-doc-sync

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about post-ship-doc-sync

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I find and fix stale documentation after a release?▼

To fix stale documentation after a release, cross-reference changed files against doc files like README, ARCHITECTURE, and the docs/ directory. This workflow compares changes since the last tag to identify outdated sections and provides surgical edits for approval.

What is the best way to update API references and setup docs after shipping changes?▼

The best way to update API references and setup docs is scanning common documentation locations by comparing changes since your last release tag. It identifies stale sections and generates a diff preview of minimal edits before applying any modifications.

Can I preview documentation changes before they are applied to the repository?▼

Yes, you can preview documentation changes before they are applied. The workflow generates a diff preview of minimal, surgical edits for approval, ensuring you review all proposed modifications to root-level markdown files before committing.

Does the doc sync workflow compare changes against a specific git range?▼

Yes, the doc sync workflow compares changes against a specific git range. By default, it evaluates changes from the last tag to HEAD, but you can specify a custom range to accurately identify stale sections following a merge or release.

When should I not use automated stale documentation detection?▼

You should not use automated stale documentation detection when writing new documentation from scratch. This workflow is specifically designed to discover and fix outdated sections in existing files like CONTRIBUTING, CHANGELOG, and CLAUDE.md after shipping.

Related Skills

Explore More Content & Communication Skills→
li3pli3p

changelog

Generate human-readable changelog entries from git history and diffs.

Community
Advanced
webjetcmswebjetcms
7

wj-docs-pr

Update Slovak Markdown documentation and CHANGELOG from Git diffs.

Community
Advanced
wnz99wnz99
1

doc-review

Audit markdown documentation against a live codebase for stale claims.

Community
Advanced
AJBcodingAJBcoding
4

moai-docs-linting

Lint Markdown documentation for formatting, broken references, and structural issues.

Community
Advanced