整理把文档写好的一些guide line，这些都是我工作过程中一些笔记，希望对大家有用。。。
---------------------------------------------------------------------------------------
写文档之前把目录结构定下来
在写文档之前，通常已知道文档应该需要包含哪些内容，所以应先把目录结构写好，并给到Review人员或者上级Leader进行Review，没有问题之后才开始文档的编写，好处是显而易见的，比较资深的Review人员或者Leader可以通过目录结构可以发现文档错误和遗漏，发现错误的时间是在执行者写文档之前，而不是写完整个文档之后才发现，有时，目录结构甚至由Leader来制定，或者在Leader的协助下制定，这样做的目的是，最后出来的文档，接近Leader想要的东西。
写文档的时间
什么时候开始写文档？
最好的方式是，写文档贯穿整个工作周期，边执行任务边写文档，在文档中记录下工作步骤和分析过程，如果当工作完成并得到结论之后才开始写文档，通常就变成了为了文档而文档，写作动力下降，影响质量，同时，文档还可以起到监督工作的作用，避免工作发生了遗漏。
文档的格式
首先是要有目录索引（当然1,2页的文档可能不需要:))，同时页眉或者页头要有页码，有些人容易把页码漏掉，如果别人不看电子版(领导都喜欢纸版)，打印出来再看的话，没有页码会跟目录对不上号：）
除了目录外就是文档的概述和正文等，下面将分别讨论。
文档的概述部分
文档的源由 -- 写出为什么要写这个文档，例如一份单元测试计划,可以这么写源由, 每个程序员在完成自已的模块编码工作之后,都要对自已的模码进行单元测试后才能将代码提交到代码仓库,这份文档用于制定单元测试的计划，源由特别有助于新员工更容易地理解和学习开发流程和文档的作用。
文档的目的 -- 描述这份文档描述些什么内容, 解决了什么问题等。
面向的读者 -- 写出你的文档面向的是什么样的读者，以及文档中的章节是如何为这些不同的读者进行组织的，例如一份报告，主管通常希望能看到更多的分析细节，以方便考证最终的结论是否可靠，工作步骤是否有误等，而工作时间非常宝贵的经理则只希望能够在文档中得到结论而并不关心分析的细节，因此要在这里进行说明，他们应怎么阅读你的文档，就可以以最短的时间得到他们想要的东西。
参考资料 -- 某些结论，可能是在某本书籍或某一篇文献上得到的，你应该把它写在文档上，以便于读者能追踪到更多相关的内容。如果资料是在网上的，例如某一个URL上，你应该把内容下载下来，因此网址可能会过时无效。
文档的正文编写
文档的正文怎么写, 一个简单的理解就是把你想告诉别人的东西写下来。
常常犯的一个错误是，只写结论，而缺乏结论所经历的分析过程。文档的读者通常开始猜测作者是如何得到这些结论，更糟糕的时，如果文档交给另一个工程师Review, 这个负责Review的工程师需要（有意或无意地）将执行了与作者类拟的分析工作，才能确定文档中的结论是正确的还是有误，浪费了人力。
因此，分析过程和结论一样重要，例如，按这样的逻辑来组织文档的内容：
1. 需求是什么
2. 要实现这个需求共有多少种解决方案
3. 如何验证这些方案是可行的
4. 比较每种解决方案有哪些优缺点
5. 选择最后的解决方案，并说明为什么选择该方案而丢弃其它方案
总之，读者,有时是你的Leader需要从你的文档中不仅仅是得到结论，还有得到你的思路。
附录
可以摘录一些与文档相关的资料放在这里，或者把一些速查表汇总在这里以方便读者查询。
鸣谢
如果你的工作在执行的过程中，得到了一些同事的帮助才得以顺利地进行，花费了他们宝贵的工作时间，那么，在文档的最后，应该感谢他们。