bmad-agent-tech-writer

Generate structured technical documentation in CommonMark, DITA, or OpenAPI formats.

4|1|Updated Sep 30, 2024
One-click install
npx skills add https://github.com/co-cddo/ndx --skill bmad-agent-tech-writer-co-cddo
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bmad-agent-tech-writer
Source: https://github.com/co-cddo/ndx/tree/main/_bmad/bmm/1-analysis/bmad-agent-tech-writer
Command: npx skills add https://github.com/co-cddo/ndx --skill bmad-agent-tech-writer-co-cddo

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Transforms complex technical concepts into clear, accessible documentation, reducing time spent drafting and reviewing.

Core Features & Use Cases

  • Acts as Paige, a patient educator who explains complex topics with clarity.
  • Supports CommonMark, DITA, OpenAPI, and Mermaid diagrams for flexible formats.
  • Used for creating API docs, architecture overviews, user guides, and design specifications.

Quick Start

Tell Paige the topic and audience, and she will generate clear, structured technical documentation in your preferred 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 technical documentation from complex system designs?

To generate technical documentation from complex system designs, provide the topic and target audience. The assistant produces clear, structured drafts for architecture overviews and specifications, significantly reducing time spent drafting and reviewing.

Can I use Markdown and Mermaid diagrams for API documentation?

Yes, you can use Markdown and Mermaid diagrams for API documentation. The assistant supports format compatibility with CommonMark for text and Mermaid for diagrams, enabling clear visualization of API endpoints and workflows.

Does this technical writing assistant support OpenAPI and DITA formats?

Yes, this technical writing assistant supports OpenAPI and DITA formats. It ensures format compatibility for your documentation, allowing you to generate structured API docs and content that meets specific industry standards.

What is the best way to write user guides for software projects?

The best way to write user guides for software projects is through multi-turn guided writing with validation. This approach transforms complex technical concepts into accessible documentation while ensuring accuracy and clarity.

How do I validate technical writing for accuracy during generation?

You validate technical writing for accuracy during generation by using the multi-turn guided writing feature. This interactive process allows you to refine explanations, verify technical details, and validate the structure before finalizing.

Are there limitations when converting complex concepts into DITA documentation?

There are no explicit limitations mentioned for converting complex concepts into DITA documentation. The assistant handles complex topics and outputs structured DITA formats, though providing clear input on the topic and audience ensures best results.