技术文档的快速写作模板
技术写作是为了总结解决问题的实用技术，而撰写的文档，对团队的技术积累非常关键。 为了 准确、高效 的传递技术价值，技术文档写作方法必须满足两个条件： 第一点很容易理解，第二点在实际中更关键。如果不能快速写作，那么新鲜的思考成果会迅速流失，淹没于各种杂事之中。 针对以上两个问题，本文总结了一套标准的 技术写作模板 。 清晰快速的写作，需要借助一定的技术工具： markdown是当前最高效的技术写作方式，图片的插入需要在网络条件下使用。如果不使用markdown，而使用word，未尝不可，但效率会低很多。 关于markdown可以关注本人的其他文章，或直接百度。 一个基本事实是： 填空题比简答题容易做 。与之相对应，设计一套标准的技术文档模板，将一个 创作 的问题转化为 填空 问题，只需要参照模板，填入需要的信息，不需要思考文章的结构，那么写作过程自然大大提高了。 以下介绍技术文档写作的 主体结构 和 附属结构 。一般非正式的文档只需要主体结构即可，但对于更复杂的问题，或者面对更大的阅读者群体，最好补充适当的附属结构信息。 附属结构是锦上添花： 一个典型的标准化技术文档写作示例如下： 技术写作的最大问题在于 追求完美 。苛求完美的结果往往是——写不出来。 时间表明，昨晚工作后，及时用10 min时间回顾总结几个基本步骤，截取关键图片，写一篇不完善的文档，也是很重要的积累。积累比完美更重要。 如果写作太慢，用1个小时的时间总结半个小时的工作，那就得不偿失了。
如何写好技术文档
写好文档，注意点有：一、思路清晰、章节分布合理分章节、逐层深入地描述问题。这是写科技文档的要旨。看看MSDN和各家软件公司的产品文档就可以知道，无一不是如此。二、不用口语科技说明文档，不用口语。不能出现“你们”、“我们”、“好啊”、“咋样啊”、“应该”。。。。。。这些都不能出现。比如，“应该”应写成“应”、“需”等书面用语。一些讨论稿可以适量使用口语。文档代表公司和技术要点，不是体现个人魅力的地方。一个公司不能使用五花八门风格的文档。口语的使用，更是会雪上加霜。三、形成固定风格科技文档不要求风格各异，但求达意简约。这个和写文章的方法是格格不入。可以针对每类事务，形成固定的模板。所谓有章可循。要把它形成组织积累。而不是个人行为。这样能形成整体风格。四、站在读者的角度写主要涉及到难度、叙述方式等。文档叙述的难易程度要和读者匹配。否则，难了看不懂。太简单了，也没有意思。这些都没有起到效果。五、解决问题是核心任何文档写出来都是要解决问题，那就是帮助读者熟悉知识点。任何的形式、风格、注意点都是表面的东西。解决问题是关键。一个写的再好的文档，不能姐姐问题，都是白搭。六、注意积累
