Document from brief
Apply the document-author skill to the brief in $ARGUMENTS.
Input¶
$ARGUMENTS should describe:
- What's being documented (component / API / process / decision)
- Type if known (tutorial / how-to / reference / explanation) — else infer
- Audience (beginner / intermediate / advanced; technical / non-technical)
- Locale (Korean / English / both)
- Length target (under 500 / standard / long-form)
If ambiguous: ask one clarifying question.
Steps¶
- Parse the brief into structured spec.
- Determine Diátaxis type if not stated. If brief mixes types: split into multiple docs.
- Apply
skills/document-author/PLAYBOOK.mdend-to-end. - Output the markdown file with frontmatter.
- Run the skill's verification phase.
Examples¶
Brief: "Document our REST API authentication endpoint. POST /auth/login. For technical readers." → Reference doc with signature, parameters, returns, errors, examples.
Brief: "Walk a new user through their first chart in our analytics product. Korean, friendly tone." → Tutorial with step-by-step + Korean ~해요 voice + screenshots references.
Brief: "Why we chose ClickHouse over Postgres for analytics." → Explanation doc with problem / alternatives / decision / tradeoffs.
Brief: "How to deploy the staging environment." → How-to with TL;DR + steps + variations + pitfalls.
Done when¶
- One markdown file (or multi-file directory if split needed).
- Matches the chosen Diátaxis template.
- Frontmatter complete.
- Code samples runnable.
- Cross-reference section included.
- Verification phase from
document-authorpasses.