萌新程序员,为什么要写技术文档,如何写一份好的技术文档?

这摸鱼也很累...

  为什么要写技术文档?

  横向来看,能帮助团队其他成员快速了解程序内容,精准查询所需要的部分内容。

  纵向来看,便于日后的更新维护,让其更加结构化。

  具体的代码细节当然不需要写文档(每个细节都写也非常浪费时间),但整体的架构和业务流程要讲清楚,这样在别人使用或者自己日后使用。

摸鱼被发现了,稍后继续

posted @ 2023-08-21 08:54  浪矢-CL  阅读(31)  评论(0编辑  收藏  举报