| name | doc-writer |
| description | Create or update numbered task docs using repo context, DOC_TEMPLATE.md, and naming conventions. |
Doc Writer Skill
Purpose
Generate or refresh docs/planned/XX-*.md and docs/completed/XX-*.md files using the mandated template (docs/DOC_TEMPLATE.md) and existing repository content.
Instructions
- Inspect relevant source material:
- Read
docs/DOC_TEMPLATE.mdfor structure expectations. - Gather context from
PLAN.md,AGENTS.md, and any existing task doc being updated. - When creating a new task, identify prior numbering and ensure a unique two-digit prefix.
- Read
- Draft the document following exact sections: metadata block, Objective, Prerequisites / Dependencies, Implementation Steps, Validation, Completion Criteria, Notes / Follow-ups.
- Reference existing code or documentation by linking relative paths rather than duplicating large excerpts.
- Confirm acceptance criteria reflect the latest repository state (tests, tooling, env requirements).
- Save the file under the correct directory (
docs/planned/ordocs/completed/) with the naming conventionNN-task-name.md. - Run required validators (lint/tests) if file changes mandate repository updates; record commands executed.
- Summarize the edits in the PR/task notes.
Verification
- Ensure the new/updated doc passes markdown lint (if configured) and adheres to
docs/DOC_TEMPLATE.mdstructure. - Confirm numbering sequence remains unique.