用途:帮助团队记录与可视化软件架构,覆盖图表生成、架构决策记录(ADR)和设计决策文档。
主要能力:生成 Mermaid 语法图表,包括时序图、架构流程图、实体关系图(erDiagram)以及用 flowchart 表达的 C4 Context 图;生成 PlantUML 文本图;从 package.json 生成依赖关系图;按标准模板编写 ADR 并列出已有 ADR。
使用方式:Mermaid 图可直接放入 Markdown 的 ```mermaid 代码块,在 GitHub 上原生渲染。ADR 建议写入 docs/adr/,用 mkdir -p docs/adr 创建目录,并按模板创建如 0001-use-postgresql.md 的文件,包含标题、日期、状态、背景、决策和后果。列出 ADR 可用 ls -1 docs/adr/*.md 配合 head 读取首行标题。依赖图可用 python3 读取 package.json 的 dependencies 生成 flowchart LR。PlantUML 使用 @startuml 与 @enduml 包裹。
适用场景:需要为代码库补充架构图、记录技术选型理由、维护设计决策历史,或让图表与代码一同纳入版本控制时。
限制与注意事项:ADR 应顺序编号且不删除,被取代时用 supersede 而非删除;图表建议与代码一起纳入版本控制;C4 模型可按 Context → Container → Component → Code 层级使用。资料未提供安装方式、收费、平台支持范围或具体效果说明。