10技巧创建软件开发文档

《10技巧创建软件开发文档》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、10技巧创建软件开发文档虽然编制文档并不是众多IT专业人员选择职业的真正原因，但是足够的激情、勤奋工作和注意细节将会使你成为老板的一份更具价值的资产并能够提升你的履历。本文我们介绍了取自10Things博客中的文章《创建软件文档的10项技巧》。该博客主要面向应用开发专业人员，但是项目经理和管理人员也可以从他们的智慧中获益。AlanNorton从事软件系统开发和相应软件项目文档编制工作很多年。我们可以从他的多年从业经验中获益。坦白地讲，没人想写，没人想读或者实际上是不得不作这项工作。我想说的是软件开发中的文

2、档编制，通常定义为软件生存期的倒数第二步。虽然编写文档可以而且应该出现的软件生存期的任何阶段，但是本文我们将集中在文档编制阶段。需要注意的是我们要讨论的文档包括两部分：终端用户文档和系统/内部文档。项目生存期在准备这篇文章而做一些研究时，我找出了Petrocelli/Charter1976年出版的AnthonyRalston和ChesterL.Meek编辑的计算机科学百科全书。可以明确地是这是第一版的经典，但是有一些东西是永恒的，其中在文档词条关于文档的描述为：“文档是开发和应用基于计算机的系统的重要部分

3、。在一些商业组织，20%到40%的开发工作量用于新系统的文档编制，其中记录了新系统是如何工作的以及是如何开发的。”作者K.R.London。我对于这个定义在今天的正确性感到好奇，如果是真的话，那么为什么媒体没有给与文档应该的关注。在项目生存期我们找不到很多关于文档花费的信息（如图A）。我猜测可能是这些花费经常被低估或没有进行合理的收集。从事工作系统开发的IT专业人员，很多可能会将文档的实际花费看作是件尴尬的事或者认为这反映了他们不良的生产率和工作。对项目生存期文档阶段的重要性的看法，可能依赖于你在IT组织

4、的角色。如果你是经理或项目小组组长，那么你会认为文档对于项目的成功是十分重要的。如果你处于一个非管理职位，那么你会认为编制文档是件恼人的麻烦事，因为它妨碍了你的实际工作。尽管下文的10项技巧主要面向后一类人员，但是项目经理和管理人员同样也可以从中获益。图A7步项目生存期来源：WikipediA#1:如果可能尽量编制图形文档有句古老的格言说是一幅图胜过千句言，意思是说通过使用图形表达你的观点，将会使文档的长度和复杂性减到最小。系统用户喜欢使用图形，图表，表格和列表进行快速查找参考。#2：给出示例例子是终端用

5、户快速掌握他们可能没有完全理解的概念的最好方式。同时对学习使用新软件的终端用户来说，例子还是他们坐下来更容易地处理一项新的挑战好方式。下面是一个带有图片的文档的例子：Vista商业、终极和企业版中的先前版本先前版本是微软用于存储一个文件影印的术语。如果你正在编辑一个文档或任何其它劳动密集型的项目且意外地丢失了部分或全部工作，那么你可以返回到一个先前版本。先前版本可以看作是以自动的方式及时地对以前的文件拍下的快照。但是首先我们需要配置Vista，以便开启你想要用来恢复丢失文件的先前版本功能（图B至图E）逻辑

6、磁盘/分区。开启先前版本图B选择开始

7、控制面板图C左键单击高级系统设置——如果提示UAC（用户账号控制）左键单击继续。图D左键单击系统保护选项卡注意：默认情况下，Vista逻辑磁盘/分区已经开启。在完全清楚这样做的后果后在改变这个设置。图E向下滑动滚动条选择逻辑磁盘左键单击滚动条并向下滑动只到在逻辑磁盘/分区中找到你要开启先前版本的那个分区。在本例中的逻辑磁盘名为Documents。左键单击逻辑磁盘名前面的单选按钮选中。注意：影印文件的创建基于系统创建恢复点的时间和频率。根据Vista的帮助文件，典型情况

8、是一天一次。单击应用然后单击确定关闭系统属性窗口。单击文件

9、关闭或单击控制面板

10、系统窗口右上部的红色X按钮关闭它。为了恢复一个文件的先前版本，你可以右键单击浏览窗口中的文件名然后左键单击恢复先前版本即可。注意：一旦文件的一个影印被恢复后，就不能用于二次恢复。在下一个系统恢复点创建之前，不能创建另外一个影印文件。这就意味着任何在下一个系统恢复点保存的文件不能恢复到你前面使用的那个先前版本中去。应该加强练习注意在使用了恢复先前版本选项后直到下一个恢复点发生和另外一个影印文件可以创建后在保存文件。#3:不要指望

11、假设即使你知道你的目标用户群，也需要编写应用文档以便任何一个具备基础计算机技能的人都可以阅读并学会如何正确的使用新系统。可能的情况下，应该提供一步一步地操作指令。但为了避免混乱，可以考虑将文档放在附录中，单独的章节中或通过超链接访问它们。如果你在编写文档，改变一下你的思维方式从而使你可以站在新系统用户的角度考虑问题。起初，这可能有点困难，但是只要你注意细节并对将所有特性和功能变成文档，你就可以创建一个良好的文档，而不用假定用户