document-release

Synchronize README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md with shipped changes.

Updated Jul 3, 2025
One-click install
npx skills add https://github.com/andrew-t-james/dotfiles --skill document-release-andrew-t-james
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/andrew-t-james/dotfiles/tree/main/dot_claude/skills/document-release
Command: npx skills add https://github.com/andrew-t-james/dotfiles --skill document-release-andrew-t-james

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship doc sync. Updates README, ARCHITECTURE, CONTRIBUTING, CLAUDE.md to match what shipped. Use when: "update docs", "sync documentation", "post-ship docs".

Core Features & Use Cases

  • Automatically aligns documentation with shipped changes after release.
  • Handles preflight checks, plan-mode prompts, and telemetry settings to keep docs accurate.
  • Supports optional workflow hooks (e.g., CI hints, contributor notes) to maintain consistency across teams.

Quick Start

Run the document-release workflow after shipping to synchronize documentation across files.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I automatically sync documentation after a code release?

Post-ship documentation synchronization is the process of updating README, ARCHITECTURE, and CLAUDE.md files to match shipped changes. This workflow automates that process using Bash to orchestrate updates across your project's core documentation.

What is the best way to update CLAUDE.md and README files after shipping?

The best way to update CLAUDE.md and README files after shipping is to run a post-ship docs workflow. It automatically aligns your documentation with shipped changes and can optionally prompt for Linear integration to align governance with docs.

Can I use post-ship docs sync with Linear integration?

Yes, you can use post-ship docs sync with Linear integration. The workflow can prompt for optional Linear integration to align governance with documentation updates, keeping your project tracking and docs consistent across teams.

What files are updated during a post-ship documentation workflow?

The files updated during a post-ship documentation workflow include README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md. The workflow loads the Markdown body as operational instructions to orchestrate these updates accurately.

Do I need YAML frontmatter for post-ship documentation updates?

Yes, you need YAML frontmatter for post-ship documentation updates. The workflow enforces a YAML frontmatter with a name and description at the root level to properly load the Markdown body as operational instructions for Bash orchestration.