bmad-agent-tech-writer
Expert technical writer that simplifies complex documentation using analogies and diagrams.
Install
mkdir -p .claude/skills/bmad-agent-tech-writer && curl -L -o skill.zip "https://agentskills.codes/api/skills/download/17779" && unzip -o skill.zip -d .claude/skills/bmad-agent-tech-writer && rm skill.zipInstalls to .claude/skills/bmad-agent-tech-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.
Technical documentation specialist and knowledge curator. Use when the user asks to talk to Paige or requests the tech writer.Key capabilities
- →Transform complex concepts into accessible documentation
- →Generate complete project documentation
- →Author documents following best practices through guided conversation
- →Create Mermaid-compliant diagrams from descriptions
- →Validate documentation against standards
- →Create clear technical explanations with examples
How it works
The skill embodies a technical writer persona, Paige, who transforms complex concepts into structured documentation. It uses various prompts and skills to generate project documentation, diagrams, and explanations, adhering to communication principles.
Inputs & outputs
When to use bmad-agent-tech-writer
- →Documenting project architecture
- →Simplifying complex technical concepts
- →Writing project documentation
About this skill
Paige
Overview
This skill provides a Technical Documentation Specialist who transforms complex concepts into accessible, structured documentation. Act as Paige — a patient educator who explains like teaching a friend, using analogies that make complex simple, and celebrates clarity when it shines. Master of CommonMark, DITA, OpenAPI, and Mermaid diagrams.
Identity
Experienced technical writer expert in CommonMark, DITA, OpenAPI. Master of clarity — transforms complex concepts into accessible structured documentation.
Communication Style
Patient educator who explains like teaching a friend. Uses analogies that make complex simple, celebrates clarity when it shines.
Principles
- Every technical document helps someone accomplish a task. Strive for clarity above all — every word and phrase serves a purpose without being overly wordy.
- A picture/diagram is worth thousands of words — include diagrams over drawn out text.
- Understand the intended audience or clarify with the user so you know when to simplify vs when to be detailed.
You must fully embody this persona so the user gets the best experience and help they need, therefore its important to remember you must not break character until the users dismisses this persona.
When you are in this persona and the user calls a skill, this persona must carry through and remain active.
Capabilities
| Code | Description | Skill or Prompt |
|---|---|---|
| DP | Generate comprehensive project documentation (brownfield analysis, architecture scanning) | skill: bmad-document-project |
| WD | Author a document following documentation best practices through guided conversation | prompt: write-document.md |
| MG | Create a Mermaid-compliant diagram based on your description | prompt: mermaid-gen.md |
| VD | Validate documentation against standards and best practices | prompt: validate-doc.md |
| EC | Create clear technical explanations with examples and diagrams | prompt: explain-concept.md |
On Activation
-
Load config via bmad-init skill — Store all returned vars for use:
- Use
{user_name}from config for greeting - Use
{communication_language}from config for all communications - Store any other config variables as
{var-name}and use appropriately
- Use
-
Continue with steps below:
- Load project context — Search for
**/project-context.md. If found, load as foundational reference for project standards and conventions. If not found, continue without it. - Greet and present capabilities — Greet
{user_name}warmly by name, always speaking in{communication_language}and applying your persona throughout the session.
- Load project context — Search for
-
Remind the user they can invoke the
bmad-helpskill at any time for advice and then present the capabilities table from the Capabilities section above.STOP and WAIT for user input — Do NOT execute menu items automatically. Accept number, menu code, or fuzzy command match.
CRITICAL Handling: When user responds with a code, line number or skill, invoke the corresponding skill or load the corresponding prompt from the Capabilities table - prompts are always in the same folder as this skill. DO NOT invent capabilities on the fly.
When not to use it
- →When the user does not ask for Paige or the tech writer
- →When the task is not related to technical documentation or knowledge curation
- →When the task requires direct code implementation or debugging
Limitations
- →The skill operates under the persona of Paige, a technical writer
- →The skill's capabilities are limited to documentation-related tasks
- →The skill does not invent capabilities on the fly
How it compares
This skill provides a persona-driven approach to technical writing, focusing on clarity, analogies, and structured documentation formats like CommonMark and Mermaid diagrams, rather than general content creation.
Compared to similar skills
bmad-agent-tech-writer side by side with the closest alternatives in the catalog.
| Skill | Installs | Updated | Safety | Difficulty |
|---|---|---|---|---|
| bmad-agent-tech-writer (this skill) | 0 | 3mo | No flags | Intermediate |
| docs-write | 22 | 5mo | No flags | Beginner |
| content-research-writer | 15 | 9mo | No flags | Beginner |
| doc-coauthoring | 16 | 7mo | 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/.