09 2013 档案

摘要：提纲 我们有时候会怀疑：写提纲一定那么重要吗？如果将文档工作类比于软件开发，这个答案就非常明显了。在软件开发当中，设计是编码的必要前奏，在你没有五六年的工作经验之前，没有设计的编码将会是一塌糊涂。同样，没有提纲的文章，也会是乱七八糟。 提纲让我们能做好内容规划和章节划分。写提纲是一个文章整体的构思过程，能让我们掌控整个文章的大局，做好了大局的工作，章节的内容，在提纲的指导下，很容易节节击破。好的提纲，能让文章大方向的改动变得最小，减少开发人员的工作量，否则出现了大方向的改动，内容也需要跟着变动，工作量也会随之增加。 提纲让我们理清文章的整体思路。文章很重要，思路更重要。网上的模板很无聊，它只是 阅读全文

摘要：最近，公司的重大项目快完工了，除了留下一些Bug，还留下了一些收尾工作，比如我今天要讲的文档。在会上，经理说，怕研发人员写文档写不好。不论经理有没有说包含激将之意的言语，写文档都是一项挑战性的工作。文档开发流程 网上并没有给出一个比较完美的文档模板，如何写这个文档呢？写文档不能简单的看作写一篇文章。它也与软件开发一样，有一个逐步完善的流程。这是我写文档过程中的流程：图1 文档开发流程1. 确定条件和背景。 在文档开发的最初阶段需要了解文档写作的内、外部的条件和背景。不同的专业存在不同的专业背景，对于专业软件不是按照一个文档模板，就能把所有的文档写出来。文档写作的内部条件： （1）公司的产品是. 阅读全文