doc-writer
Create or update numbered task docs using repo context, DOC_TEMPLATE.md, and naming conventions.
Best use case
doc-writer is best used when you need a repeatable AI agent workflow instead of a one-off prompt. It is especially useful for teams working in multi. Create or update numbered task docs using repo context, DOC_TEMPLATE.md, and naming conventions.
Create or update numbered task docs using repo context, DOC_TEMPLATE.md, and naming conventions.
Users should expect a more consistent workflow output, faster repeated execution, and less time spent rewriting prompts from scratch.
Practical example
Example input
Use the "doc-writer" skill to help with this workflow task. Context: Create or update numbered task docs using repo context, DOC_TEMPLATE.md, and naming conventions.
Example output
A structured workflow result with clearer steps, more consistent formatting, and an output that is easier to reuse in the next run.
When to use this skill
- Use this skill when you want a reusable workflow rather than writing the same prompt again and again.
When not to use this skill
- Do not use this when you only need a one-off answer and do not need a reusable workflow.
- Do not use it if you cannot install or maintain the related files, repository context, or supporting tools.
Installation
Claude Code / Cursor / Codex
Manual Installation
- Download SKILL.md from GitHub
- Place it in
.claude/skills/doc-writer/SKILL.mdinside your project - Restart your AI agent — it will auto-discover the skill
How doc-writer Compares
| Feature / Agent | doc-writer | Standard Approach |
|---|---|---|
| Platform Support | Not specified | Limited / Varies |
| Context Awareness | High | Baseline |
| Installation Complexity | Unknown | N/A |
Frequently Asked Questions
What does this skill do?
Create or update numbered task docs using repo context, DOC_TEMPLATE.md, and naming conventions.
Where can I find the source code?
You can find the source code on GitHub using the link provided at the top of the page.
SKILL.md Source
# 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 1. Inspect relevant source material: - Read `docs/DOC_TEMPLATE.md` for 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. 2. Draft the document following exact sections: metadata block, Objective, Prerequisites / Dependencies, Implementation Steps, Validation, Completion Criteria, Notes / Follow-ups. 3. Reference existing code or documentation by linking relative paths rather than duplicating large excerpts. 4. Confirm acceptance criteria reflect the latest repository state (tests, tooling, env requirements). 5. Save the file under the correct directory (`docs/planned/` or `docs/completed/`) with the naming convention `NN-task-name.md`. 6. Run required validators (lint/tests) if file changes mandate repository updates; record commands executed. 7. 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.md` structure. - Confirm numbering sequence remains unique.
Related Skills
prd-doc-writer
Write and iteratively refine PRD/需求文档 with a story-driven structure and strict staged confirmations (journey map alignment, per-story single-point confirmation, final generation gate). Use when the user asks to 梳理/撰写/完善 PRD、需求文档、用户故事、验收标准，并希望用 ASCII 线框图与 Mermaid（流程图/状态图/时序图）来减少歧义、共同完成文档。
svelte-code-writer
CLI tools for Svelte 5 documentation lookup and code analysis. MUST be used whenever creating, editing or analyzing any Svelte component (.svelte) or Svelte module (.svelte.ts/.svelte.js). If possible, this skill should be executed within the svelte-file-editor agent for optimal results.
writer
Document creation, format conversion (ODT/DOCX/PDF), mail merge, and automation with LibreOffice Writer.
wiki-page-writer
Generates rich technical documentation pages with dark-mode Mermaid diagrams, source code citations, and first-principles depth. Use when writing documentation, generating wiki pages, creating technical deep-dives, or documenting specific components or systems.
seo-content-writer
Writes SEO-optimized content based on provided keywords and topic briefs. Creates engaging, comprehensive content following best practices. Use PROACTIVELY for content creation tasks.
blog-writer
Write and add new blog posts for this Next.js site by matching the existing BlogPost structure in `src/lib/blog-data.ts`. Use when asked to draft a new blog article, update blog content, or produce SEO metadata/slug/image details for a new post.
pr-description-writer
Generates comprehensive, reviewer-friendly PR descriptions with visual diagrams, summary tables, collapsible sections, and structured test plans. Optimized for readability without sacrificing detail.
code-review-digest-writer
Generates weekly code-review digest docs from PR review comments for any GitHub repository. If present, follows project-specific docs/review-digests/AGENTS.md guidelines. Use this to turn a date-bounded set of PR reviews into a structured markdown “newsletter” that captures themes, repeated issues, and concrete takeaways.
libreoffice-writer
Use when creating, editing, formatting, exporting, or extracting LibreOffice Writer (.odt) documents via UNO, including session-based edits, structured text targets, tables, images, lists, patch workflows, and snapshots.
skill-writer
Guide users through creating Agent Skills for Claude Code. Use when the user wants to create, write, author, or design a new Skill, or needs help with SKILL.md files, frontmatter, or skill structure.
content-research-writer
Assists in writing high-quality content by conducting research, adding citations, improving hooks, iterating on outlines, and providing real-time feedback on each section. Transforms your writing process from solo effort to collaborative partnership.
documentation-writer
Expert technical writer for Logseq Template Graph project. Generates comprehensive, accurate, and well-structured documentation for modules, features, guides, and APIs. Activates when asked to "write docs", "document this", "create README", "update documentation", or similar requests. Analyzes code/templates to extract information and writes clear, user-focused documentation following project style.