程序员写好技术文档的三步法则

写技术文档分3步

1. 背景: 什么背景, 要做什么事情, 可以解决现有的什么问题
2. 总体框架或思路, 涉及到那些模块
3. 框架中各个模块每一步要做哪些事情

注意别忽略了第一个背景. 这个很重要目的就是把阅读者带到文档讨论的范畴内.