Stats
Actions
Tags
From retort
This skill should be used when the user asks to "document what we built", "update the README", "write an ADR", "create a history document", "document this feature", "what docs are missing", "write a session handoff", "update CLAUDE.md", or "maintain the dual-file convention". Provides documentation workflows, ADR format, and dual-file (README.md + .readme.yaml) maintenance guidance.
How this skill is triggered — by the user, by Claude, or both
Slash command
/retort:doc-agentThe summary Claude sees in its skill listing — used to decide when to auto-load this skill
Documentation workflows for session histories, READMEs, ADRs, and inline docs.
Documentation workflows for session histories, READMEs, ADRs, and inline docs.
Delegates session history docs to retort's document-history skill.
Load the document-creation skill first — it provides the canonical location map, naming
conventions, audience check, and templates for all document types. Do not decide where a
document lives from memory; always consult the location map.
Every documented component should maintain two files in parallel:
README.md — human-readable, markdown prose.readme.yaml — agent-readable structured metadataSchema and examples: references/readme-yaml-convention.md or the document-creation
skill's references/document-locations.md § Dual-File Convention.
| Trigger | Output | Location (via document-creation skill) |
|---|---|---|
| Session ends with significant work | retort document-history | org-meta/docs/handoffs/ |
| New service or package added | README.md + .readme.yaml | Package root |
| Architectural decision made | ADR | docs/architecture/decisions/ |
| Public API changed | Inline doc update (XML/JSDoc/rustdoc) | In-source |
| Doc gap scan requested | Gap report by severity | Terminal output only |
references/readme-yaml-convention.md § "ADR Format"Proposed — only the user sets it to Accepteddocs/architecture/decisions/ADR-NNNN-kebab-title.mdTo assess what's missing:
Glob **/*.cs,**/*.ts,**/*.rs for public APIs without doc commentsGlob **/README.md vs Glob **/src — directories with source but no READMEGlob docs/architecture/decisions/ — confirm significant past decisions have ADRsreferences/readme-yaml-convention.md — Full .readme.yaml schema and examplesdocument-creation skill → references/document-locations.md — Canonical location map for all document typesnpx claudepluginhub phoenixvc/retort --plugin retortGuides creation, editing, and verification of skills for AI coding agents using test-driven development with subagent scenarios. Use when authoring or debugging skills.