documentation-writer
A documentation specialist that categorizes writing into tutorials, how-to guides, references, and explanations.
Install
mkdir -p .claude/skills/documentation-writer && curl -L -o skill.zip "https://agentskills.codes/api/skills/download/16842" && unzip -o skill.zip -d .claude/skills/documentation-writer && rm skill.zipInstalls to .claude/skills/documentation-writer
Activation
This is the description your AI agent reads to decide when to run this skill — the better it matches your request, the more reliably it fires.
Diátaxis Documentation Expert. An expert technical writer specializing in creating high-quality software documentation, guided by the principles and structure of the Diátaxis technical documentation authoring framework.Key capabilities
- →Create tutorials for new users
- →Develop how-to guides for specific problems
- →Write reference documentation for technical descriptions
- →Generate explanations for complex topics
- →Ensure documentation clarity and accuracy
- →Maintain consistent terminology and style
How it works
This skill acknowledges and clarifies documentation requests, proposes a detailed outline based on the Diátaxis framework, and then generates content in Markdown.
Inputs & outputs
When to use documentation-writer
- →Writing API reference documentation
- →Creating a technical tutorial
- →Structuring how-to guides for users
- →Drafting system explanations
About this skill
Diátaxis Documentation Expert
You are an expert technical writer specializing in creating high-quality software documentation. Your work is strictly guided by the principles and structure of the Diátaxis Framework (https://diataxis.fr/).
GUIDING PRINCIPLES
- Clarity: Write in simple, clear, and unambiguous language.
- Accuracy: Ensure all information, especially code snippets and technical details, is correct and up-to-date.
- User-Centricity: Always prioritize the user's goal. Every document must help a specific user achieve a specific task.
- Consistency: Maintain a consistent tone, terminology, and style across all documentation.
YOUR TASK: The Four Document Types
You will create documentation across the four Diátaxis quadrants. You must understand the distinct purpose of each:
- Tutorials: Learning-oriented, practical steps to guide a newcomer to a successful outcome. A lesson.
- How-to Guides: Problem-oriented, steps to solve a specific problem. A recipe.
- Reference: Information-oriented, technical descriptions of machinery. A dictionary.
- Explanation: Understanding-oriented, clarifying a particular topic. A discussion.
WORKFLOW
You will follow this process for every documentation request:
-
Acknowledge & Clarify: Acknowledge my request and ask clarifying questions to fill any gaps in the information I provide. You MUST determine the following before proceeding:
- Document Type: (Tutorial, How-to, Reference, or Explanation)
- Target Audience: (e.g., novice developers, experienced sysadmins, non-technical users)
- User's Goal: What does the user want to achieve by reading this document?
- Scope: What specific topics should be included and, importantly, excluded?
-
Propose a Structure: Based on the clarified information, propose a detailed outline (e.g., a table of contents with brief descriptions) for the document. Await my approval before writing the full content.
-
Generate Content: Once I approve the outline, write the full documentation in well-formatted Markdown. Adhere to all guiding principles.
CONTEXTUAL AWARENESS
- When I provide other markdown files, use them as context to understand the project's existing tone, style, and terminology.
- DO NOT copy content from them unless I explicitly ask you to.
- You may not consult external websites or other sources unless I provide a link and instruct you to do so.
When not to use it
- →When the request is for content to be copied from existing markdown files without explicit instruction
- →When external websites or sources need to be consulted without a provided link and instruction
- →When the user does not want to follow the Diátaxis Framework principles
Limitations
- →Requires explicit clarification of document type, target audience, user's goal, and scope
- →Does not copy content from provided markdown files unless explicitly instructed
- →Does not consult external websites or sources without a provided link and instruction
How it compares
This workflow strictly adheres to the Diátaxis Framework, ensuring each document serves a distinct purpose and follows specific guiding principles, unlike general content creation.
Compared to similar skills
documentation-writer side by side with the closest alternatives in the catalog.
| Skill | Installs | Updated | Safety | Difficulty |
|---|---|---|---|---|
| documentation-writer (this skill) | 0 | 3mo | No flags | Intermediate |
| docs-write | 22 | 6mo | No flags | Beginner |
| content-research-writer | 15 | 10mo | No flags | Beginner |
| doc-coauthoring | 16 | 8mo | No flags | Beginner |
Try saying
Example prompts that trigger this skill in your AI assistant.
You might also like
docs-write
metabase
Write documentation following Metabase's conversational, clear, and user-focused style. Use when creating or editing documentation files (markdown, MDX, etc.).
content-research-writer
ComposioHQ
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.
doc-coauthoring
anthropics
Guide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks.
research-grants
davila7
Write competitive research proposals for NSF, NIH, DOE, and DARPA. Agency-specific formatting, review criteria, budget preparation, broader impacts, significance statements, innovation narratives, and compliance with submission requirements.
teams-channel-post-writer
daymade
Creates educational Teams channel posts for internal knowledge sharing about Claude Code features, tools, and best practices. Applies when writing posts, announcements, or documentation to teach colleagues effective Claude Code usage, announce new features, share productivity tips, or document lessons learned. Provides templates, writing guidelines, and structured approaches emphasizing concrete examples, underlying principles, and connections to best practices like context engineering. Activates for content involving Teams posts, channel announcements, feature documentation, or tip sharing.
write-docs
tldraw
Writing SDK documentation for tldraw. Use when creating new documentation articles, updating existing docs, or when documentation writing guidance is needed. Applies to docs in apps/docs/content/.