bmad-agent-tech-writer

Translate complex technical concepts into structured documentation with Mermaid diagrams.

Updated Apr 12, 2026
One-click install
npx skills add https://github.com/Yukine5377/common --skill bmad-agent-tech-writer-yukine5377
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bmad-agent-tech-writer
Source: https://github.com/Yukine5377/common/tree/main/.cursor/skills/bmad-agent-tech-writer
Command: npx skills add https://github.com/Yukine5377/common --skill bmad-agent-tech-writer-yukine5377

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Translates complex technical concepts into accessible, structured documentation that helps teams learn, implement, and maintain systems more efficiently.

Core Features & Use Cases

  • Master a technical writer persona to produce clear documentation, guidance, and diagrams for API docs, user manuals, and design specs.
  • Capabilities mapping:
    • DP: Generate comprehensive project documentation (brownfield analysis, architecture scanning)
    • WD: Write documents following documentation best practices
    • MG: Create Mermaid diagrams based on descriptions
    • VD: Validate documentation against standards and best practices
    • EC: Explain concepts with clear technical explanations and examples
  • Use Cases: API documentation, architectural specs, design guidelines, knowledge bases, and developer handbooks.

Quick Start

Provide a concise technical document draft by describing your audience, scope, and preferred output format.

Frequently Asked Questions about bmad-agent-tech-writer

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate API documentation from an OpenAPI specification?

To generate API documentation, provide the OpenAPI specification and define your target audience. The Skill translates complex technical concepts into accessible, structured documentation, applying CommonMark and DITA best practices for clear developer handbooks.

Can I create Mermaid diagrams automatically from text descriptions?

Yes, you can create Mermaid diagrams by providing a text description of your architecture or workflow. The Skill generates visual diagrams based on your descriptions, integrating them directly into your structured knowledge bases and design specs.

What is the best way to write technical documentation for both engineers and end users?

The best way to write technical documentation for mixed audiences is to clearly define the audience and scope upfront. The Skill produces clear technical explanations and examples, ensuring clarity and consistency across API docs, manuals, and knowledge bases.

Does this technical writing approach support DITA and CommonMark formats?

Yes, this technical writing approach explicitly supports DITA and CommonMark formats. It writes documents following documentation best practices and validates the output against these standards to ensure structured, accessible knowledge curation.

How do I validate existing documentation against technical writing standards?

You validate existing documentation by submitting it for a standards review. The Skill validates documentation against best practices and standards, checking for clarity and consistency in your architectural specs and knowledge bases.

Can I scan an existing project to generate brownfield architecture documentation?

Yes, you can scan existing projects to generate brownfield architecture documentation. The Skill performs architecture scanning and brownfield analysis to produce comprehensive project documentation and architectural specs for engineering teams.