软件文档写作-文档表达-公开课件（讲义）.pptVIP

* 4.5 选择表达方法 编制软件文档时，应该根据不同文档的性质、类型以及涉众的类型、专业能力等，在确定文档编制计划、内容和步骤后，还要确定文档编制的表达方法。 需要编入文档的资料以怎样的方式表达，对该文档涉众以及软件产品、文档等的传播有很大的影响。 以软件产品的用户手册为例，其表达方式有以下多种： 1. 直叙式 2. 菜谱式 3. 编号指教式 4. 剧本式 5. 四步法 任何一本软件用户手册都可能使用这些方法的其中一种或几种。 用户手册编制时常用表达方式介绍： 1. 直叙式。按照文档中上下文关系，平铺直叙需要编入文档的内容。这是多数文档常用的表达形式。下图是一个直叙式编档的例： 订购员填写订购输入单(单据编号P0123)，这张单据有预先印好的订购号。事务输入日期、供货公司名、货号、数量和价格。 事务员将此单据信息输入到计算机中，并更新订购文件。 注意这种方式会使某些信息在段落中丢失。可以把它和下一种表达方式的例子加以比较 2. 菜谱方式。菜谱方式，顾名思义，就是写成菜肴或点心的烹制法的样子： 搅拌直至均匀，并出现泡沫为止 焙烤(350°)一小时 语句的第一个词是动词。菜谱方式可以比直叙方式使用更少的字词表达数学内容。 将前面直叙方式表达的内容用菜谱方式再表达一次。同样的内容，字数少了，但实际上说的是同一件事。阅读行越短，意味着阅读和理解越快。 填写订购输入单，P0123 输入日期、供货公司名、货号、数量和价格 将单据数据录入计算机 更新订购文件 提示：每当要给出指示性内容时，使用菜谱表达方式。把动词放在最前面。如果某指示有一个条件，则先说明条件，接着就用一个动词。 3. 编号指教式。以菜谱式为基础，将文档中描述的软件工作步骤或处理过程加以编号，其表达结果会比直叙式更适合阅读理解。 订购员填好订购输入单(P0123)。 1. 订购号：已印在单据上 2. 日期：输入当前日期。采用yyyymmdd的8位表达，如将2005年12月2日表示 3. 供货企业：输入接受订货的企业名。最多25个汉字 4. 货号：输入要订购的货号。在库存清单中找货号。若为新增，则见新增货物部分 5. 数量：输入订购数量。最多99999 6. 单价：输入每种货物的价格。最贵￥99999.99(系统将计算本次订购的总金额) 7. 制表人：制表人签名 8. 计算机操作员把填写完毕的订购单送计算机录入 9. 系统管理员将录入后数据处理，并更新订购文件 这种表达方式使需要完成的工作十分明确，且数据的长度、格式也有规定，尽管占用的空间稍大，但阅读方便，能使读者快速找到需要的内容。 4. 剧本式。以菜谱式为基础，将文档以剧本方式表达。也有“演员”，以及动作。下图是这种方法的例： 订购员： 1. 完成订购输入单(P0123) a. 订购号： 预先印在单据上的顺序号 b. 日期： 输入当前日期。采用yyyymmdd的8位表达，如将2005年12月1日表示 c. 供货企业： 输入接受订货的企业名。最多25个汉字 d. 货号： 输入要订购的货号。在库存清单中找货号。若为新增，则见新增货物部分 e. 数量： 输入订购数量。最多99999 f. 单价： 输入每种货物的价格。最贵￥99999.99(系统将计算本次订购的总金额) g. 制表人： 制表人签名 操作员： 2. 将订购单输入计算机 系统员： 3. 数据录入计算机，并更新订购文件 剧本式会比编号指教式占用更多的篇幅。但软件编档的目的并不是为了节省篇幅，而是如何使文档更清晰，更容易阅读理解。 直叙法使文档内容泛而无重点，编号指教法则突出执行者即角色的作用欠缺。而剧本法者使角色的任务十分鲜明，不同用户只需阅读相关部分即可。 5. 四步法。对有些功能较多，结构复杂，操作较为灵活的系统，用户比以上的例子会有更多的自由。对于使用第三方软件包开发的系统就更是如此。此时，剧本法已不再适用。 即使有几种用户使用软件包，但无法知道谁需要做什么。并且，系统操作过程也不一定是一步接一步，而是需要用户判断接下去做什么，及何时做。 对此种情形，唯有直叙式表达和所谓的四步法适用。因为用户手册需要提供用户何时及为什么执行某项功能的指导。