软件文档写作06-文档表达2演示教学.ppt

4.5 选择表达方法 编制软件文档时，应该根据不同文档的性质、类型以及涉众的类型、专业能力等，在确定文档编制计划、内容和步骤后，还要确定文档编制的表达方法。 需要编入文档的资料以怎样的方式表达，对该文档涉众以及软件产品、文档等的传播有很大的影响。 以软件产品的用户手册为例，其表达方式有以下多种： 1. 直叙式 2. 菜谱式 3. 编号指教式 4. 剧本式 5. 四步法 任何一本软件用户手册都可能使用这些方法的其中一种或几种。; 用户手册编制时常用表达方式介绍： 1. 直叙式。按照文档中上下文关系，平铺直叙需要编入文档的内容。这是多数文档常用的表达形式。下图是一个直叙式编档的例：;2. 菜谱方式。菜谱方式，顾名思义，就是写成菜肴或点心的烹制法的样子：;3. 编号指教式。以菜谱式为基础，将文档中描述的软件工作步骤或处理过程加以编号，其表达结果会比直叙式更适合阅读理解。;4. 剧本式。以菜谱式为基础，将文档以剧本方式表达。也有“演员”，以及动作。下图是这种方法的例：;6. 综合式。 在具体编制用户手册时，可以根据手册内容或手册读者的需要，采用不同的编档表达方法。 例如，对绪言或概述，通常采用直叙式编写。对于读者对象只有一类的那些文档部分，则使用菜谱式或编号指教式比较合适。而有若干类读者的部分，则可以选择采用剧本式编制。 具体在用户手册这类文档的编制过程中，编制者可以根据文档涉众的特点，采用灵活的策略，决定文档的表达方式。;4.6 国际化软件开发编档 在当今的全球经济环境下，使用软件的用户可能说着各种不同的语言、来自不同的国家，有着不同的文化背景，如果我们开发的应用软件能够满足这些用户需要，显而易见是益处多多。 所谓国际化软件开发和编档，就是要理解什么是国际化．并设计全球可用的应用软件，编制相符合的国际化软件文档。 1.国际化软件开发编档的基本要求 由于国际化软件的用户分布在不同的国家/地区，并且使用不同的语言，因此，国际化软件的开发编档就要充分考虑和满足各种用户的功能和区域特性的需要。与面向单???语言的软件相比，国际化软件开发及编档具有以下基本要求: (1) 全球可用性是国际化设计的目标 全球可用，可以保证国际化设计的软件顺利实施本地化，使软件能够运行在不同的语言环境中。为了保持较高的开发效率，为各种语言版本创建共同的单一二进制、全球可用的内核，是一种快速有效的方法。全球可用性的目标使得各种不同语言的版本具有一致的外观、风格和功能。 但全球化开发的软件的文档的编制，则必须按照软件去向，符合当地文字规范、文化习俗和阅读习惯。;(2) 支持不同编码字符集的能力 国际化软件及其文档模板应支持不同语言和字符的输入、显示和输出。 对于东亚市场的版本，不但需要支持单字节字符集，还需要正确支持双字节甚至多字节字符集。因此，需要在软件国际化设计时，处理正确的字符集编码。国际化软件编档同样会有类似问题，特别是同一国际化软件的不同语言版本文档采用统一模板编制时。一个较好的解决方案是采用Unicode字符编码标准。 (3) 支持区域信息格式 国际化软件需要支持不同区域的信息格式。如，键盘布局、字符串排序、日期、时间、数字、货币、地址、电话号码、度量单位等与特定区域的语言和文化有关的信息。保证不同语言版本的软件能够正确输入、显示、编辑、打印这些信息。相关文档必须完整表达这一类区域信息。 (4) 国际化特征贯穿于软件项目的全过程 软件国际化特征和需求应该从项目最初的市场调研、可行性研究以及项目计划就开始加以考虑。在随后的项目需求分析、系统设计、编码、测试、质量管理，直到软件发布、维护的全过程，应始终贯彻国际化的理念。 尽管国际化软件开发过程的技术文档可以采用所在地文字或事先约定的文字编制，但应为最终完成多语种文档编制做好准备。;(5) 提高软件的本地化能力 提高软件的本地化能力，可以降低本地化的成本，提高软件的质量、可用性和稳定性。因此，要求软件开发人员从软件开发的最初阶段，就应遵循基本的本地化能力准则来开发软件和编档。将需要本地化的内容、文档，与国际化程序代码和文档分开，单独放在资源文件中。 (6) 尽早测试国际化软件 由于必须通过修改程序代码才能解决本地化能力方面的错误，因此，如果到了软件本地化阶段再来修正这些错误，那将会带来很大的困难，并提高开发成本，推迟本地化过程。为此，可以通过伪本地化测试本地化能力，以尽早发现和修改软件的国际化错误。 这项工作可以在编码刚刚完成，甚至在详细设计阶段就开始测试。不仅要测试程序，也要同步测试设计