skills.rest
LeGeRyChEeSe
LeGeRyChEeSeCOMMUNITY
Explore all skills by this author →
GitHub

bmad-agent-tech-writer

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

Updated Aug 25, 2024
Search Tags:#documentation#markdown#mermaid#validation#technical writing#codebase analysis#diagrams
One-click install
npx skills add https://github.com/LeGeRyChEeSe/LanPlay-DiscordBot --skill bmad-agent-tech-writer-legerycheese
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: bmad-agent-tech-writer
Source: https://github.com/LeGeRyChEeSe/LanPlay-DiscordBot/tree/main/bmad/src/bmm-skills/1-analysis/bmad-agent-tech-writer
Command: npx skills add https://github.com/LeGeRyChEeSe/LanPlay-DiscordBot --skill bmad-agent-tech-writer-legerycheese

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Teams struggle to keep project documentation accurate, accessible, and consistent during the analysis phase, leaving humans and AI agents out of sync on project knowledge. ## Core Features & Use Cases - Project Documentation: Generates comprehensive brownfield analysis and architecture documentation by scanning an existing codebase. - Guided Document Authoring: Writes documents through multi-turn conversation following documentation best practices, with research and review passes. - Diagram Generation & Validation: Creates Mermaid diagrams (flowcharts, sequence, ER, and more) and validates existing documents against documentation standards. - Use Case: Ask Paige to document a legacy codebase before a rewrite; she scans the project, produces architecture documentation, and generates Mermaid diagrams explaining key flows. ## Quick Start Ask Paige to document this codebase and generate an architecture overview with Mermaid 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 agent and select the DP menu option, which runs the bmad-document-project skill to perform brownfield analysis and architecture scanning. The output is comprehensive project documentation written to your configured planning artifacts location.

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

Select the MG menu option or ask for a diagram directly. The agent clarifies what needs visualizing, suggests a diagram type such as flowchart, sequence, or ER, then generates Mermaid syntax in a fenced code block and iterates on your feedback.

Can I customize the agent's persona and behavior?▼

Yes, customization merges from three TOML layers: the skill's customize.toml defaults, team overrides, and personal user overrides. Scalars override, tables deep-merge, and arrays append, letting you adjust role, principles, persistent facts, and menu items.

Does the document validation check specific standards?▼

The VD menu option reviews a document against documentation best practices covering clarity, structure, and audience-appropriateness, plus any focus areas you specify. It returns a prioritized list of actionable improvement suggestions.

What are the limitations of the Mermaid diagram generation?▼

Diagrams are limited to what Mermaid syntax supports, such as flowcharts, sequence, class, state, and ER diagrams. Complex or highly custom visual layouts may require manual refinement after generation.

Related Skills

Explore More Content & Communication Skills→
PaneriVatsalPaneriVatsal

codebase-documenter

Generate developer-facing documentation from repository structure and source files.

Community
Intermediate
OntoLedgyOntoLedgy

sprint-planner

Plan executable sprints by ordering prioritized tickets into dependency-aware waves.

Official
Advanced
CloudToLocalLLM-onlineCloudToLocalLLM-online
22

senior-fullstack

Scaffold Next.js, FastAPI/React, MERN, and Django/React projects and analyze code quality.

Official
Advanced
mei28mei28
3

doc-gen

Generate OpenAPI specs and Markdown API references from codebases.

Community
Advanced