但在写代码外还要写 markdown 、画图,感觉是难以为继的事,需要每个维护者都遵守规则去写文档,这个脆弱的文档很可能在某次小功能迭代、人员变动后就对不上代码,从而无人问津了。越来越大的文档库,也难找到要看的地方。
产品 prd 自然有维护一些业务流程,但和代码实现也是两码事,缺少含有业务语义的代码流程。
还是说没必要维护,全靠脑子记,忘了就从触发入口开始一路再看一遍。
代码当中通常会有起节点作用的重要模块或函数,它们通常是大业务动作下可分解出的小业务动作的入口,那通过注解或者魔法注释,自动标记这些代码位置,在写代码的时候顺手标记下,人为加上业务语义备注,最后自动生成一份流程图,可不可行,现在有没有类似的工具了。
再编写个 vscode 插件,点击这些魔法注释,能够聚焦到流程图对应位置,反之也可以定位到代码位置。

