写技术文档最怕啥?配架构图。严格来说Visio 太重,手绘截图塞进去,俩月后代码早改了图还停在上古版本,后来人照着走直接迷路。我前阵子被这破事折腾够呛,转去用 Mermaid——一种拿文本定义图形的语言,basically 就是把图当 code 写。
最戳我的是它能进 Git。graph TD; A–>B 这种写法,diff 一拉谁动了箭头清清楚楚,图跟代码同步过期的问题算根治了。CI 挂个渲染,PR 里直接看图,reviewer 省劲。
常用的没几个:flowchart 画流程,sequenceDiagram 画时序,classDiagram 画类关系。我有时让 AI 吐 Mermaid,服务调用链几分钟捋顺,比白板乱划强。
门槛也低,GitHub、VS Code、Notion 都原生认,零安装。我现在真回不去截图时代了,你们有啥私藏玩法也来唠两句。