课程咨询: 400-996-5531 / 投诉建议: 400-111-8989
认识达内从这里开始
认真做教育 专心促就业
需求文档是程序员在开发软件项目或者设计网页的时候都需要牢记和参考的一项辅助工具，而今天我们就一起来了解一下，软件开发需求文档应该怎么写以及用到哪些工具。
一、基调
足够了解 ：我们要为某个模块写文档，前提一定是我们对这个模块足够了解，只有基于此，我们的文档才是有价值的，否则只是信息垃圾。
换位思考 ：即便有了交接文档，我们也经常需要去询问交接人，这种情况屡见不鲜，究其本质，是因为很多时候我们都是站在自己的角度、按照自己的理解来写文档的，但是读者的信息背景和我们是完全不一样的，我们觉得理所当然的可能他们一无所知，所以写作文档必须要有足够的换位思考的意识。 文档是写给别人看的，不是写给自己看的 。
MECE原则 ： 简单来说就是 相互独立，完全穷尽 ，这个思想可以指导我们对文档结构进行组织。
二、过程
一般来说，文档写作的流程如下：
收集信息、整理框架、实践结论、写作文档
。如果前期工作足够，写作所花的时间是很少的。
此外，文档完成后，还要注意读者反馈，以不断完善自己的文档。
写一份好的技术文档也不是一蹴而就的，需要不断打磨，要注意经常去
刻意练习 。
三、写作工具
对于Word/Pdf我是极力排斥的，因为很多文档都是需要更新的，这两种格式没法做到 动态更新 。Markdown 比较受开源社区的欢迎，因为它在表达力和简洁性之间找到了一个平衡点，但是它有一个致命问题就是 无法应付稍微复杂一点的排版 。Asciidoc是我的主力文档工具，很多人不知道Github也是支持这种文档格式的，比如本文就是这种格式的。Asciidoc的语法比Markdown更加复杂，但我认为 牺牲一点时间学习是完全值得的 。后是Latex，Tex的变种，表达力强大，可以应付各种复杂排版，一般在学术圈比较流行(尤其是那些复杂数学公式的表达)，但我认为放在日常的文档写作中有点矫枉过正了。
【免责声明】：本内容转载于网络，转载目的在于传递信息。文章内容为作者个人意见，本平台对文中陈述、观点保持中立，不对所包含内容的准确性、可靠性与完整性提供形式地保证。请读者仅作参考。
< 上一篇：跨平台编程开发技术的优缺点对比分析
下一篇：程序员需要掌握的几种控制台命令类型分享 >
2025-08-07
免费试听课程
- 全部课程
- IT课程
- 设计课程
- 运营课程
4578
最新开班时间
- 北京
- 上海
- 广州
- 深圳
- 南京
- 成都
- 武汉
- 西安
- 青岛
- 天津
- 杭州
- 重庆
- 哈尔滨
- 济南
- 沈阳
- 合肥
- 郑州
- 长春
- 苏州
- 长沙
- 昆明
- 太原
- 无锡
- 石家庄
- 南宁
- 佛山
- 珠海
- 宁波
- 保定
- 呼和浩特
- 洛阳
- 烟台
- 运城
- 潍坊
- 开课名称
- 开班时间
- 抢座
- 咨询
- 开课名称
- 开班时间
- 抢座
- 咨询
-
- Java全链路开发
- 8月29日
- 火热抢座中
- 立即咨询
- 云计算全栈开发
- 8月29日
- 火热抢座中
- 立即咨询
-
- 网络安全工程师
- 8月29日
- 火热抢座中
- 立即咨询
- 人工智能工程师
- 8月29日
- 火热抢座中
- 立即咨询
-
- 数据分析与商业智能
- 8月29日
- 火热抢座中
- 立即咨询
- C++物联网工程师
- 8月29日
- 火热抢座中
- 立即咨询
-
- Web全栈开发
- 8月29日
- 火热抢座中
- 立即咨询
- 软件测试工程师
- 8月29日
- 火热抢座中
- 立即咨询
-
- AI大模型全栈工程师
- 8月29日
- 火热抢座中
- 立即咨询
- 鸿蒙原生应用开发
- 8月29日
- 火热抢座中
- 立即咨询
-
- 智能职场办公
- 8月29日
- 火热抢座中
- 立即咨询
- VFX商业视效设计
- 8月29日
- 火热抢座中
- 立即咨询
-
- AGI商业设计变现
- 8月29日
- 火热抢座中
- 立即咨询
- UID全链路设计
- 8月29日
- 火热抢座中
- 立即咨询
-
- 新媒体电商运营
- 8月29日
- 火热抢座中
- 立即咨询
-
- Java全链路开发
- 8月29日
- 火热抢座中
- 立即咨询
- 云计算全栈开发
- 8月29日
- 火热抢座中
- 立即咨询
-
- 网络安全工程师
- 8月29日
- 火热抢座中
- 立即咨询
- C++物联网工程师
- 8月29日
- 火热抢座中
- 立即咨询
-
- Web全栈开发
- 8月29日
- 火热抢座中
- 立即咨询
- 软件测试工程师
- 8月29日
- 火热抢座中
- 立即咨询
-
- AI大模型全栈工程师
- 8月29日
- 火热抢座中
- 立即咨询
- 鸿蒙原生应用开发
- 8月29日
- 火热抢座中
- 立即咨询
-
- 智能职场办公
- 8月29日
- 火热抢座中
- 立即咨询
- VFX商业视效设计
- 8月29日
- 火热抢座中
- 立即咨询
-
- AGI商业设计变现
- 8月29日
- 火热抢座中
- 立即咨询
- UID全链路设计
- 8月29日
- 火热抢座中
- 立即咨询
-
- 新媒体电商运营
- 8月29日
- 火热抢座中
- 立即咨询
-
- 云计算全栈开发
- 8月29日
- 火热抢座中
- 立即咨询
- 网络安全工程师
- 8月29日
- 火热抢座中
- 立即咨询
-
- C++物联网工程师
- 8月29日
- 火热抢座中
- 立即咨询
- Web全栈开发
- 8月29日
- 火热抢座中
- 立即咨询
-
- 软件测试工程师
- 8月29日
- 火热抢座中
- 立即咨询
- AI大模型全栈工程师
- 8月29日
- 火热抢座中
- 立即咨询
-
- 鸿蒙原生应用开发
- 8月29日
- 火热抢座中
- 立即咨询
- 智能职场办公
- 8月29日
- 火热抢座中
- 立即咨询
-
- VFX商业视效设计
- 8月29日
- 火热抢座中
- 立即咨询
- AGI商业设计变现
- 8月29日
- 火热抢座中
- 立即咨询
-
- UID全链路设计
- 8月29日
- 火热抢座中
- 立即咨询
- 新媒体电商运营
- 8月29日
- 火热抢座中
- 立即咨询
-
- Java全链路开发
- 8月29日
- 火热抢座中
- 立即咨询
- 网络安全工程师
- 8月29日
- 火热抢座中
- 立即咨询
-
- 数据分析与商业智能
- 8月29日
- 火热抢座中
- 立即咨询
- C++物联网工程师
- 8月29日
- 火热抢座中
- 立即咨询
-
- Web全栈开发
- 8月29日
- 火热抢座中
- 立即咨询
- 软件测试工程师
- 8月29日
- 火热抢座中
- 立即咨询
-
- AI大模型全栈工程师
- 8月29日
- 火热抢座中
- 立即咨询
- 鸿蒙原生应用开发
- 8月29日
- 火热抢座中
- 立即咨询
-
- 智能职场办公
- 8月29日
- 火热抢座中
- 立即咨询
- VFX商业视效设计
- 8月29日
- 火热抢座中
- 立即咨询
-
- AGI商业设计变现
- 8月29日
- 火热抢座中
- 立即咨询
- UID全链路设计
- 8月29日
- 火热抢座中
- 立即咨询
-
- 新媒体电商运营
- 8月29日
- 火热抢座中
- 立即咨询
-
- 云计算全栈开发
- 8月29日
- 火热抢座中
- 立即咨询
- 网络安全工程师
- 8月29日
- 火热抢座中
- 立即咨询
-
- C++物联网工程师
- 8月29日
- 火热抢座中
- 立即咨询
- Web全栈开发
- 8月29日
- 火热抢座中
- 立即咨询
-
- 软件测试工程师
- 8月29日
- 火热抢座中
- 立即咨询
- AI大模型全栈工程师
- 8月29日
- 火热抢座中
- 立即咨询
-
- 鸿蒙原生应用开发
- 8月29日
- 火热抢座中
- 立即咨询
- 智能职场办公
- 8月29日
- 火热抢座中
- 立即咨询
-
- VFX商业视效设计
- 8月29日
- 火热抢座中
- 立即咨询
- AGI商业设计变现
- 8月29日
- 火热抢座中
- 立即咨询
-
- UID全链路设计
- 8月29日
- 火热抢座中
- 立即咨询
- 新媒体电商运营
- 8月29日
- 火热抢座中
- 立即咨询
预约申请试听课
400-111-8989
lihm@tedu.cn
