写分布式系统的文档真的太闹心了... 概念那么多，组件又多，一不小心就前后矛盾。我每次写都会先把架构图画出来，把各个模块关系理顺，不然写着写着自己都迷糊了。接口文档得特别注意版本控制，改一个地方可能一堆地方都要变，之前就因为没更新导致线上出过问题 还有就是异常处理部分一定要写详细，不然别人调用的时候踩坑可不好找原因。对了，示例代码最好能直接跑通，不然光写文字真的很难理解啊！