document-writer
Installation
SKILL.md
Write or update technical documentation for the target project at $ARGUMENTS.
Preconditions
Paths starting with
<skill-dir>are relative to this skill's base directory, announced when the skill loads. Substitute that literal path; it is not an environment variable.
- If
$ARGUMENTSis empty, report:Error: Please provide the target path and the documentation task (for example: './docs/api.md update the payment API docs' or './src/utils.ts add JSDoc for the public helpers'). - Read
<skill-dir>/references/WORKFLOW.md,<skill-dir>/references/DOCUMENT_TYPES.md, and<skill-dir>/references/VERIFICATION_CHECKLIST.mdbefore drafting. - If the request is in Chinese, the output file is Chinese, or the user wants polishing/rewrite into Chinese, also read
<skill-dir>/references/CHINESE_TECH_WRITING.md.
Execution Flow
1. Classify the task
Determine the closest document type before writing: