程序员必备！最全技术文档写作指南

文章预览

👉 目录 1 用什么载体 2 需要写哪些文档 3 怎么写好文档 4 文档的维护 5 推荐阅读书籍 程序员最讨厌两类人，一类是不写文档的人，一类是让自己写文档的人。但其实，一篇上下文详尽、边界清晰的文档，能够前置性地解决很多问题，避免因为信息差而带来的各种来回追问、扯皮。 写技术文档是开发者的义务，它和写可读代码一样重要，它也可以体现个人做事态度、逻辑思考能力。本篇文章作者将体系化地教会你，如何写文档，如何写好文档。 01 用什么载体 持久沉淀的文档：建议使用可以被多人看到、可以被检索的知识库工具，譬如：公司内的 wiki 或者归属于组织的知识库。不建议使用私人文档，或者 word 等无法规模化传播的工具。 短时间多人协作的文档：首选腾讯文档之类的在线多人协作工具。 整体建议：评审、共建类的文档，可以采用 ………………………………