bmad-agent-tech-writer

Generates technical documentation, Mermaid diagrams, and validation reports through a persona-driven agent workflow.

Updated Aug 3, 2026
One-click install
npx skills add https://github.com/shaahy/quicknav-desktop --skill bmad-agent-tech-writer-shaahy
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: bmad-agent-tech-writer
Source: https://github.com/shaahy/quicknav-desktop/tree/main/A%20%E6%95%99%E7%A8%8B%E9%9B%86%E5%90%88/BMAD-METHOD%E6%8A%80%E8%83%BD%E9%80%9F%E6%9F%A5/source-v6.10.0/src/bmm-skills/1-analysis/bmad-agent-tech-writer
Command: npx skills add https://github.com/shaahy/quicknav-desktop --skill bmad-agent-tech-writer-shaahy

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Teams struggle to keep project documentation accurate, accessible, and consistent during the BMad Method analysis phase, leaving humans and future LLM agents out of sync. ## Core Features & Use Cases - Project Documentation: Generates comprehensive brownfield analysis and architecture documentation by scanning an existing codebase. - Guided Document Authoring: Writes structured, task-oriented documents through multi-turn conversation following documentation best practices. - Diagrams and Validation: Creates Mermaid-compliant diagrams and validates existing documents against clarity and structure standards. - Use Case: Ask the agent to document a legacy codebase before a refactor; it scans the project, produces architecture documentation, and validates the output against documentation standards. ## Quick Start Ask the technical writer agent to document this project and generate an architecture overview with a Mermaid diagram.

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 documentation for an existing codebase?▼

Invoke the agent's document-project capability, which scans the codebase and produces brownfield analysis and architecture documentation. The agent loads project context files and configuration before generating structured output.

How do I create a Mermaid diagram from a text description?▼

Use the diagram generation menu item and describe what you want visualized. The agent suggests a diagram type such as flowchart, sequence, or ER, then produces Mermaid syntax in a fenced code block and iterates on your feedback.

Can I customize the technical writer agent's persona and menu?▼

Yes, customization works through layered TOML files: the skill's default customize.toml, team overrides, and personal user overrides. Scalars override, tables deep-merge, and menu items merge by code.

Does the agent support validating existing documentation?▼

Yes, the validation capability reviews a specified document against documentation standards, clarity, structure, and audience-appropriateness. It returns a prioritized list of specific, actionable improvement suggestions.

What are the limitations of this documentation agent?▼

The agent relies on project configuration files and context documents being present, so output quality depends on available project knowledge. It generates documentation through conversation rather than automated code parsing pipelines.