怎么写技术文档？

技术文档的作用

当前的信息共享和长期的知识传承

好的技术文档

敏捷， 高度可维护的并且经常维护， 易理解
表述准确、结构清晰、排版美观、风格统一

1. 背景？问题？目标？核心需求？主要功能？
2. Terms
   术语解释，很多业务会衍生一些特定词汇，需要单独解释。
3. 每一个文件是做什么的，配置在哪里, 接口约定（对外公开的方法、api 接口等）
4. 流程性比较强的内容画成图
5. 测试用例，怎么运行测试用例
6. Setup
7. 需求，参考资料
8. Appendix, 版本历史

产品需求文档例子：
1.简要说明产品的使用价值
我是谁（一两句话写清楚产品的身份）？
我有什么用（我是做什么的，我能提供什么服务等）？
为什么选择我们（与竞争对手相比，我们产品的优势，核心竞争力是什么）？
2.目标用户、使用场景
产品的主要用户群是谁？
用户主要在什么场景下使用我们的产品。