bmad-agent-tech-writer

Generates project documentation, Mermaid diagrams, and technical explanations through a customizable writer persona.

Updated Jul 9, 2026
One-click install
npx skills add https://github.com/unbakedcosmos/thumbnailer --skill bmad-agent-tech-writer-unbakedcosmos
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: bmad-agent-tech-writer
Source: https://github.com/unbakedcosmos/thumbnailer/tree/main/.claude/skills/bmad-agent-tech-writer
Command: npx skills add https://github.com/unbakedcosmos/thumbnailer --skill bmad-agent-tech-writer-unbakedcosmos

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Keeping project documentation accurate and accessible is hard when knowledge lives in code and scattered notes. This Skill activates Paige, a technical writer persona that documents codebases, authors structured documents, and validates documentation quality. ## Core Features & Use Cases - Project Documentation: Generates comprehensive brownfield analysis and architecture documentation by scanning the project. - Guided Document Authoring: Writes documents through multi-turn conversation following documentation best practices, with research and review passes. - Diagrams & Validation: Creates Mermaid diagrams (flowcharts, sequence, ER, and more) and validates existing docs against standards with prioritized feedback. - Use Case: Ask Paige to document a legacy codebase before a rewrite; she scans the project, produces architecture documentation, and renders Mermaid diagrams of key flows. ## Quick Start Ask Paige to document this project and generate an architecture overview with diagrams.

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 document-project capability (menu code DP) to run a brownfield analysis that scans the project and produces architecture documentation. The writer persona guides the output structure and depth based on your audience.

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

Use the Mermaid generation capability (menu code MG) and describe what you want visualized. The skill suggests a diagram type such as flowchart, sequence, class, or ER, then produces a Mermaid diagram in a fenced code block you can refine iteratively.

Can I customize the technical writer persona and menu?▼

Yes, customization merges three TOML layers: the skill's customize.toml defaults, team overrides, and personal user overrides. Scalars override, arrays append, and menu items merge by code so you can replace or add capabilities.

Does the skill validate existing documentation?▼

Yes, the validate-doc capability (menu code VD) reads a document fully and reviews it against documentation standards, clarity, structure, and audience fit. It returns a prioritized list of specific, actionable improvement suggestions.

What happens if the customization resolver script fails?▼

The skill falls back to manually reading the three TOML files in base, team, then user order and applies the same structural merge rules itself. Missing files are skipped, so activation continues without the script.