skills/document-release/SKILL.md
Post-ship documentation update. Cross-references the diff, updates README, ARCHITECTURE, CONTRIBUTING, CLAUDE.md to match what shipped. Polishes CHANGELOG voice, cleans up TODOs, optionally bumps VERSION. Triggers: "update docs", "sync documentation", "post-ship docs", "update the readme", "document what shipped". Proactively suggest after a PR is merged or code is shipped.
npx skillsauth add Wilder1222/superomni document-releaseInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
Status protocol — end every session with one of: DONE (evidence provided) · DONE_WITH_CONCERNS (list each) · BLOCKED (state what blocks you) · NEEDS_CONTEXT (state what you need).
Auto-advance — pipeline: THINK → PLAN → REVIEW → BUILD → VERIFY → RELEASE. Only human gate is spec approval at THINK. On DONE at other stages, print [STAGE] DONE -> advancing to [NEXT-STAGE] and invoke the next skill. On any non-DONE status at any stage, STOP.
Output directory — all artifacts go in docs/superomni/<kind>/<kind>-[branch]-[session]-[date].md. See CLAUDE.md for the full directory map.
TACIT-DENSE — before high-tacit decisions, classify D1 (domain expertise) · D2 (user-facing UX) · D3 (team culture) · D4 (novel pattern). On hit, output TACIT-DENSE [D#]: [question] — My default: [recommendation]. See reference for actions.
Anti-sycophancy — take a position on every significant question. Name flaws directly. No filler ("that's interesting", "you might consider", "that could work").
Telemetry (local only) — at session end, log bin/analytics-log. Nothing leaves the machine.
See preamble-ref.md for detailed protocols.
Goal: After shipping, ensure all documentation matches what was actually built. Catch stale READMEs, outdated architecture docs, and missing CHANGELOG entries.
Always read the actual diff before updating docs. Docs written from memory drift from reality.
# What changed since last release/tag
git log --oneline $(git describe --tags --abbrev=0 2>/dev/null || echo "HEAD~20")..HEAD 2>/dev/null | head -30
git diff $(git describe --tags --abbrev=0 2>/dev/null || echo "HEAD~20")..HEAD --stat 2>/dev/null | tail -20
# Or last N commits
git log --oneline -20
Build a mental model of what actually shipped:
Find all documentation files:
find . -name "README.md" -o -name "CHANGELOG.md" -o -name "ARCHITECTURE.md" \
-o -name "CONTRIBUTING.md" -o -name "CLAUDE.md" -o -name "AGENTS.md" \
-o -name "docs/*.md" 2>/dev/null | grep -v node_modules | grep -v .git
Dispatch the doc-writer agent with:
The agent returns a DOC WRITER REPORT with files written/updated. Incorporate its output and review each changed file for accuracy before committing.
For each doc, check:
Check the README for:
Edit directly: do not add "Updated on [date]" noise.
Scaffold the entry from Conventional Commits using npm run gen:changelog -- --version <X.Y.Z>, then complete the Why this matters / Verified / Deferred subsections manually.
If a CHANGELOG exists, add an entry for the current version:
## [VERSION] — YYYY-MM-DD
### Added
- [Feature] — [one-line description]
### Changed
- [What changed] — [why]
### Fixed
- [Bug fixed] — [impact]
### Removed
- [What was removed] — [migration path if breaking]
Voice guidelines:
⚠️ BREAKING:If ARCHITECTURE.md, DESIGN.md, or docs/ exist:
# Find all TODOs in docs
grep -r "TODO\|FIXME\|HACK\|XXX" --include="*.md" . | grep -v node_modules | grep -v .git
For each TODO:
Ask the user if they want to bump the version:
# Check current version
cat package.json 2>/dev/null | grep '"version"' | head -1
cat VERSION 2>/dev/null
If yes, bump according to what shipped:
DOCUMENT RELEASE COMPLETE
════════════════════════════════════════
Files updated: [N]
✓ README.md [summary of changes]
✓ CHANGELOG.md [entry added for vX.Y.Z]
✓ [other files]
TODOs cleared: [N]
VERSION: [old] → [new] (or: unchanged)
Status: DONE | DONE_WITH_CONCERNS | BLOCKED
════════════════════════════════════════
development
Systematic, behavior-preserving code refactoring with safety gates. Dispatches refactoring-agent. Triggers: "refactor", "clean up code", "reduce tech debt", "extract method", "rename". NOT for reactive PR feedback — use code-review for that.
development
Meta-skill: create, install, list, and manage skills and agents within the superomni framework. Merges writing-skills + agent-management into one unified workflow. Triggers: "create skill", "write a skill", "install skill", "list skills", "create agent", "write an agent", "install agent", "list agents", "new skill", "new agent", "add skill", "add agent", "manage framework".
testing
Dependency security, license, and freshness audit. Dispatches dependency-auditor agent to scan all package managers. Triggers: "dependency audit", "check dependencies", "npm audit", "security scan", "check for vulnerabilities", "outdated packages", "license check".
development
Meta-skill: use when creating a new skill for the superomni framework. Guides through the process of designing and writing a well-structured skill. Triggers: "create a new skill", "write a skill for", "add a skill that".