bmad-agent-tech-writer

Transform complex concepts into structured technical documentation with Markdown, DITA, OpenAPI, and Mermaid diagrams.

3|2|Updated Mar 29, 2024
One-click install
npx skills add https://github.com/josemariafs/MVTools --skill bmad-agent-tech-writer-josemariafs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bmad-agent-tech-writer
Source: https://github.com/josemariafs/MVTools/tree/main/.cursor/skills/bmad-agent-tech-writer
Command: npx skills add https://github.com/josemariafs/MVTools --skill bmad-agent-tech-writer-josemariafs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Paige makes complex concepts accessible by transforming them into clear, structured technical documentation tailored to audiences and tasks.

Core Features & Use Cases

  • Converts concepts into reader-friendly docs using Markdown, DITA, OpenAPI, and Mermaid diagrams.
  • Applies conventions for resolving persona, persistent facts, and activation steps to deliver consistent outputs.
  • Use Case: when a team needs authoritative docs for a new API or product feature, Paige drafts documentation, diagrams, and examples that align with standards.

Quick Start

Ask clarifying questions to define scope and audience, then Paige drafts the initial structured technical documentation.

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 with Mermaid diagrams and OpenAPI references?

The Skill transforms complex concepts into structured technical documentation by applying audience-appropriate conventions, generating Markdown or DITA outputs with Mermaid diagrams and OpenAPI API references when relevant.

What is the best way to convert complex concepts into DITA or Markdown documentation?

The best way is using a persona-driven approach that asks clarifying questions to define scope, then drafts reader-friendly Markdown or DITA documentation tailored to your audience and task.

Can I use this to draft API documentation that aligns with OpenAPI standards?

Yes, you can draft API documentation aligned with OpenAPI standards. The Skill generates API references and examples alongside structured text, ensuring outputs follow conventions for new APIs or product features.

Does this technical writing tool support generating Mermaid diagrams for documentation?

Yes, it supports generating Mermaid diagrams. The Skill incorporates Mermaid diagrams directly into structured technical documentation to make complex concepts visually accessible for readers.

How do I start writing structured technical documentation for a new product feature?

Start by asking clarifying questions to define the scope and audience for your product feature, then the Skill drafts the initial structured documentation with appropriate diagrams and examples.

When do I need DITA format for technical writing versus standard Markdown?

You need DITA format when technical writing requires structured topic-based authoring, whereas standard Markdown suits simpler reader-friendly docs; this Skill outputs both based on your audience requirements.