skills.rest
ncptuan
ncptuanCOMMUNITY
Explore all skills by this author →
GitHub

bmad-agent-tech-writer

Create structured technical documentation and Mermaid diagrams from complex project information.

Updated Apr 23, 2026
Search Tags:#documentation#mermaid#openapi#technical writing#document review#commonmark#concept explanation
One-click install
npx skills add https://github.com/ncptuan/stock_backtest_project --skill bmad-agent-tech-writer-ncptuan
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: bmad-agent-tech-writer
Source: https://github.com/ncptuan/stock_backtest_project/tree/main/.claude/skills/bmad-agent-tech-writer
Command: npx skills add https://github.com/ncptuan/stock_backtest_project --skill bmad-agent-tech-writer-ncptuan

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps users turn complex technical information into clear, structured documentation that people can actually understand and use. It is especially useful when documentation is unclear, incomplete, inconsistent with standards, or missing helpful visuals and explanations.

Core Features & Use Cases

  • Document Authoring: Guides users through drafting well-structured technical documents tailored to audience, purpose, and scope.
  • Concept Explanation: Breaks down difficult technical ideas with accessible language, examples, and diagrams.
  • Mermaid Diagram Creation: Produces Mermaid-compliant diagrams for workflows, systems, relationships, and other technical visuals.
  • Documentation Validation: Reviews existing documents for clarity, structure, standards compliance, and actionable improvements.
  • Use Case: A team shipping a complex backend service can use this Skill to write onboarding docs, explain architecture decisions, generate system diagrams, and review existing documentation for quality gaps.

Quick Start

Ask Paige to help write or review a technical document, explain a concept, or create a Mermaid diagram for your project.

Frequently Asked Questions about bmad-agent-tech-writer

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

FAQPage Schema
What is the best way to write technical documentation for a complex backend service?▼

Document validation reviews existing technical documentation for clarity, structure, and standards compliance. It ensures your docs align with CommonMark standards and identifies actionable improvements for audience-aware writing and better overall quality.

Can I generate Mermaid diagrams to explain complex architecture decisions?▼

To create clear technical documentation, draft well-structured documents tailored to your audience, purpose, and scope. Break down difficult technical ideas using accessible language, practical examples, and Mermaid-compliant diagrams to communicate architecture effectively.

Does this documentation review process support CommonMark formatting standards?▼

Yes, you can use this for OpenAPI documentation and concept explanation. It creates clear technical documentation from complex project information, breaking down difficult technical ideas with accessible language, examples, and diagrams for engineering and product teams.

How do I validate existing documentation for clarity and structure?▼

To validate existing documentation for clarity and structure, review the documents against audience-aware writing standards and CommonMark compliance. This process identifies quality gaps and provides actionable improvements to make complex technical information clearer and more usable.

Related Skills

Explore More Content & Communication Skills→
GenEducationGenEducation

bmad-agent-tech-writer

Transform complex technical information into structured documentation and Mermaid diagrams.

Official
Intermediate
tankpkgtankpkg
1

@tank/markdown-renderer

Convert extended markdown into verified HTML and SVG output.

Official
Advanced
thomfilgthomfilg

spec

Generate technical specifications from product briefs and codebase analysis.

Community
Intermediate
adriannoesadriannoes
46

org-chart-creator

Automate organizational chart creation and configuration for visual content projects.

Community
Intermediate