技术写作与文档2012spin.atomicobject.com编辑精选
如何写出好的需求文档
How to write good requirements
导读
这是一篇讲如何写好软件需求文档的实操文章，核心主张是把需求写得简单、清楚、可验证。虽然背景是软件开发，但它讨论的「先讲问题再讲方案」「用读者能懂的语言」对任何写说明性文字的人都适用；评论区补充了文章忽略的三点：非功能性需求、业务语境和期望结果。
可以直接用的写作要点
- 01
用最简单、最多读者能看懂的语言写需求，别用只有同行才懂的术语。
- 02
先写清楚要解决的是什么问题、造成什么影响，再谈具体做法，避免一上来就写「在这里加这个」。
- 03
动笔前先交代期望结果、整体愿景和利益相关者，让读者知道这些需求服务于什么。
- 04
分清功能性需求与非功能性需求（性能、可靠性等），不要把针对前者的建议套到后者身上。
同类还值得读
编写更好文档的框架
A Framework for Writing Better Documentation
这是 Divio 的文档写作框架，把技术文档按「读者的目标」分成四类：教程（学习导向）、操作指南（问题导向）、参考（信息导向）、解释（理解导向）。
技术写作与文档2021 · 637 分 · 76 评4 条写作要点编辑精选写好一份设计文档
Writing a good design document
这篇 HN 帖子标题为《Writing a good design document》，主题是如何写好一份设计文档；对写作者来说，它值得作为技术写作和结构化说明文的参照。
技术写作与文档2025 · 581 分 · 147 评3 条写作要点编辑精选技术写作课程
Technical Writing Courses
这是 Google 官方免费技术写作课程（两门），讲受众定义、主动语态、短句、文档结构等基础方法。
技术写作与文档2020 · 571 分 · 73 评4 条写作要点编辑精选写出更好的错误信息
Write better error messages
这篇帖子讨论如何写出更好的错误信息，评论补充了开发者场景下的具体做法和真实反面案例。
技术写作与文档2022 · 566 分 · 253 评4 条写作要点编辑精选写一本技术书的经济账
The Economics of Writing a Technical Book
一位技术书作者拆解写书的真实经济账：版税收入往往远低于投入的时间成本。
技术写作与文档2018 · 519 分 · 149 评4 条写作要点编辑精选