skills/agentic-doc-writer/SKILL.md
Generate machine-parseable, LLM-optimized documentation for Claude Code agents. Use when documenting agents, subagents, APIs, modules, or any code that other agents will consume. Triggers include "document this agent", "write agent docs", "create API docs for agents", or when documentation needs to be actionable by LLMs.
npx skillsauth add mjmorales/claude-prove agentic-doc-writerInstall 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.
Generate documentation optimized for LLM consumption. Follow references/interaction-patterns.md for all AskUserQuestion usage.
technical-writer with structured promptAskUserQuestion header "Subject" if ambiguous. For <=3 choices, include "Research & proceed".
| Subject | Indicators | Key Contracts |
|---------|------------|---------------|
| Agent | .md in agents dir, tools: frontmatter | Triggers, inputs, outputs, workflow |
| API | HTTP handlers, REST/GraphQL endpoints | Request/response schemas, errors |
| Module | Package exports, public interfaces | Parameters, return types, side effects |
| Code | Functions, classes, complex logic | Types, behavior, edge cases |
Invoke with:
Document [SUBJECT_TYPE]: [SUBJECT_NAME]
Source: [FILE_PATH]:[LINE_RANGE]
Context:
[MINIMAL RELEVANT CODE/CONFIG]
Requirements:
- Output: [agent-doc | api-doc | module-doc]
- Include: [specific contracts needed]
- Format: YAML frontmatter + structured markdown
Agent: Invocation triggers, input contract, output contract (format), workflow steps (numbered), tool permissions
API: Request schema (params, body, headers), response schema (success + error), validation rules, error codes
Module: Public interface (exports only), parameter types/constraints, return types, side effects (I/O, state)
| Component | Document | |-----------|----------| | Skills | Workflow phases, interaction points, references | | Agents | Triggers, tool permissions, model, output format | | Commands | Frontmatter fields, arguments, delegated skill | | Scripts | Usage, flags, output format |
Reference .claude/.prove.json scopes for canonical component list.
Verify before accepting:
name, type.../foo/bar)AskUserQuestion header "Quality": "Approve" / "Revise".
| Anti-Pattern | Instead | |--------------|---------| | Verbose examples with inline commentary | Minimal working examples | | Line-by-line code explanation | Document behavior and contracts |
Delegate to commit skill. Example: docs(agentic-doc-writer): document validation-agent interface
testing
Anchor session context into prove primitives before compaction and rehydrate from them after. Built-in compaction summarizes by recency and drops the claude-prove state an agent needs to reorient; this skill externalizes volatile context into durable anchors (scrum tasks, decisions, run-state, a compact-anchors pointer file) pre-compact, then runs a deterministic reorientation sequence post-compact. Use before a manual /compact, when context is about to auto-compact, or immediately after a compaction. Triggers on "smart compact", "prepare for compaction", "anchor before compact", "context is getting long", "rehydrate", "reorient after compact".
tools
Apply model-driven CONTENT reshaping to stored run artifacts that sit behind the current schema, on explicit operator invocation only. Triggers on "migrate runs", "migrate run artifacts", "run content migration", "reshape run artifacts", "bring runs to current schema". You are the driver: the `run-state migrate-runs` CLI mechanically detects which artifacts are behind and emits a plan naming each one plus its migration-instruction file; you read the instructions and reshape the prose/findings, gated by the operator. The deterministic `schema migrate` handles structural column moves; this skill covers only the content reshaping beyond them. Never run as a background or resident loop — only when the operator asks.
tools
Synthesize the 7-section risk-forward Review Brief from a run's reasoning log. Triggers on "reasoning brief", "review brief", "synthesize the brief", "generate the brief", "brief the run", "brief for review", "story brief". You are the driver: the `acb brief` CLI renders a mechanical preservation-safe backbone and proves preservation; you synthesize the narrative prose (summary + changes), single-pass or multipass over episode chunks, then gate it through Stage-1 (mechanical, blocking) and Stage-2 (prose judge, advisory).
tools
Prune stale cached versions of the prove plugin from Claude Code's plugin cache. Use when superseded versions pile up under plugins/cache and agents read stale skills/references from them, or when reclaiming plugin-cache disk space. Triggers on "clean up cached plugin versions", "prune the plugin cache", "remove old prove versions", "stale plugin cache".