用途:编写结构化、精确、实用的技术文档,从单文件到多文档项目,覆盖架构、代码、实现、spike 与通用技术内容。
主要能力:要求文档顶部声明受众;标题层级不跳级;段落不超过三句;用 Mermaid 描述系统交互、数据流、状态机与序列(flowchart LR、sequenceDiagram、classDiagram、stateDiagram-v2、C4Context、erDiagram、gantt);用 tree 输出展示目录结构;多文件项目采用标准 docs/ 布局(architecture、spikes、implementation、api、README.md 索引);混合受众需先写执行摘要;spike 与架构文档各有固定结构。
使用方式:按文档类型选择结构;描述流程时画图而非叙述;仅在用户明确要求可导出图表时,才在 markdown 旁创建 .mmd 源文件,并用 mmdc -i auth-flow.mmd -o auth-flow.png 渲染;GitHub 优先使用标准 Markdown,避免混入 Confluence/Notion 语法。
适用场景:架构文档、ADR、spike 结果、实现指南、README、多文件文档项目。
限制:不用于行内代码注释、从代码生成 API 参考(应使用 TypeDoc 或 Swagger)、营销或产品文案。Mermaid 在 Confluence 中不渲染,需先导出 PNG。资料未提供收费、价格与平台支持等细节。