Skip to content
Back to skills

Document Release

ASecurity

Post-ship documentation update — reads all project docs, cross-references the diff, updates README/ARCHITECTURE/CONTRIBUTING/CLAUDE.md to match what shipped.

  • 8 stars
  • 0 votes
  • 0 copies
  • 1 view
  • Added May 27, 2026
data-aibashrailsgitdocumentation

Security analysis

A100/100

Scanned May 27, 2026

npx -y skills add ShaheerKhawaja/ProductionOS --skill document-release --agent claude-code

Installs into .claude/skills of the current project.

Are you the author of Document Release?

Add the live security badge to your README. It updates with every re-scan.

Security grade badge for Document Release
[![Security: A — Skills Directory](https://www.skillsdirectory.com/api/skills/shaheerkhawaja-document-release/badge)](https://www.skillsdirectory.com/skills/shaheerkhawaja-document-release)

More formats (shields.io, HTML) on the badges page. Keep it an A: scan every change in CI with Pro.

Download with Pro
SKILL.md
---
name: document-release
description: "Post-ship documentation update — reads all project docs, cross-references the diff, updates README/ARCHITECTURE/CONTRIBUTING/CLAUDE.md to match what shipped."
argument-hint: "[scope or repo path]"
---

# document-release

Post-ship documentation update — reads all project docs, cross-references the diff, updates README/ARCHITECTURE/CONTRIBUTING/CLAUDE.md to match what shipped.

## Inputs

| Parameter | Values | Default | Description |
|-----------|--------|---------|-------------|
| `scope` | string | all | What to update: all | readme | architecture | changelog (default: all) |

# /document-release — Post-Ship Documentation Update

After shipping, update all documentation to match what actually shipped.

## Step 0: Preamble
Run `templates/PREAMBLE.md`. Read the latest git diff.

## Step 1: Diff Analysis
```bash
# What changed since last release
git log --oneline $(git describe --tags --abbrev=0 2>/dev/null || echo HEAD~10)..HEAD
git diff --stat $(git describe --tags --abbrev=0 2>/dev/null || echo HEAD~10)..HEAD
```

## Step 2: Read Current Docs
Read ALL documentation files: README.md, ARCHITECTURE.md, CONTRIBUTING.md, CLAUDE.md, CHANGELOG.md.

## Step 3: Cross-Reference
For each doc, check:
- Do counts match reality? (agent count, command count, test count)
- Do version numbers match VERSION file?
- Are new features documented?
- Are removed features cleaned up?
- Are code examples still accurate?

## Step 4: Update
For each discrepancy found, update the doc with accurate information. Keep the doc's existing style and tone.

## Step 5: Self-Eval
Run `templates/SELF-EVAL-PROTOCOL.md`. Are all docs now accurate? Did we miss any?

## Error Handling

| Scenario | Action |
|----------|--------|
| No target provided | Ask for clarification with examples |
| Target not found | Search for alternatives, suggest closest match |
| Agent dispatch fails | Fall back to manual execution, report the error |
| Ambiguous input | Present options, ask user to pick |
| Execution timeout | Save partial results, report what completed |

## Guardrails

1. Do not silently change scope or expand beyond the user request.
2. Prefer concrete outputs and verification over abstract descriptions.
3. Keep scope faithful to the user intent.
4. Preserve existing workflow guardrails and stop conditions.
5. Verify results before concluding. Run self-eval on output quality.

Attribution

Is this your skill, or is something wrong with this listing? Request removal or report an issue. Author removals are honored within 72 hours.

Comments

Loading comments…

Newsletter

Get the weekly list of safe new skills, and the ones we pulled.