软件文档写作-第4讲文档表达(完整).ppt

* 2. 国际化软件开发编档的基本准则 在进行国际化软件开发和编档的实践中，人们逐步总结出一些通用的准则。遵守这些准则，可以避免国际化项目走弯路甚至失败，可以提高软件质量，降低开发和维护成本。 国际化软件开发和编档需要遵循的通用准则如下： 在国际化软件项目的最初期就融入国际化思想，并且使国际化理念贯串于项目的整个生命周期； 采用单一源文件和文档模板进行多语言版本的本地化，不针对不同的语言编写多套代码和文档； 将需要本地化的文字与软件源代码分离，并存储在单独的资源文件中； 软件代码和文档模板支持处理单字节字符集和多字节字符集文字的输入、输出和显示，并且遵守竖排和折行等规则； 软件代码和文档模板应该支持 Unicode 标准，或者可以在 Unicode与其他代码页(Code Pages)互换； * 软件代码和文档不要嵌入字体名，也不要假设使用某种字体； 使用通用的图标和位图，避免不同区域的文化和传统差异，避免在图标和位图中嵌入需要本地化的文字； 菜单、对话框等界面布局及文档模板，能够处理本地化文字的长度扩展； 源语言及文档描述的文字要准确精简，使用一致的术语，避免歧义和拼写错误，容易进行本地化翻译； 保证不同区域的键盘布局都能使用源软件的快捷键及文档的使用的一致方法； 考虑不同区域的法律对软件的要求； 如果软件中采用第三方开发的软件或组件，需要检查和确认是否满足国际化的要求； 保证源语言软件及其中内嵌的电子文档可以在不同的语言文化区域和操作系统上正确运行； 软件代码及文档模板中避免“硬编码”，不使用基于源语言的数字常量、屏幕位置、文件和路径名； 软件代码及文档模板中字符串的缓冲区长度要满足本地化字符扩展的需要； 软件及文档模板能正确支持区域排序和大小写转换。 * 4.8 软件本地化工程文档处理 软件本地化工程是融合软件工程、翻译技术和桌面出版等专业知识的综合性技术，是软件本地化项目中不可缺少的重要环节。 软件本地化项目包含的本地化内容，经过软件本地化工程处理后，可以提高软件本地化工作(翻译、桌面排版、测试、项目管理)的工作效率，并且有助于保持本地化内容的一致性。 软件本地化工程的目的： 软件本地化工程处理的目的是为软件翻译等人员提供精确的、易于翻译的格式文档，并且对翻译后的文档进行工程后处理，为本地化后的软件编译提供正确的内容。 具体来说，软件本地化的目的至少包含下面三个方面： 通过抽取和重复利用已经翻译的资源文件，提高本地化的效率和一致性； 校正和调整翻译后的资源文件用户界面的大小和位置，保证编译出正确的本地化软件/文档； 通过修正软件本地化测试发现和报告的Bug，提高软件本地化的质量。 * 软件本地化工程及文档处理的内容： 软件本地化工程处理的内容与具体本地化项目的要求有关。对于一个完整的软件本地化项目，至少包括软件资源文件和联机帮助文档的本地化工程处理。 一般，软件本地化工程及文档处理的内容包括以下多个方面： 制定本地化项目计划，准备本地化工程的专用工具(Preparing) 检查本地化工程需要处理的文档(Checking) 抽取并重复利用软件/文档的本地化资源(Leveraging) 生成字数统计表(Word Count) 生成本地化术语表(Glossary) 配置本地化编译环境(Build Environment) 校正翻译的资源文件(Validating) 调整翻译的用户界面的控件位置和大小(Resizing) 编译本地化软件和联机帮助文档(Compiling) 对编译后的本地化软件和联机帮助执行完整性检查(Sanity Check) 修正测试工程师报告的缺陷（Fixing bugs） * 软件本地化工程及文档处理的流程 1. 软件本地化工程。软件本地化工程的处理流程与具体处理内容有关，但一般情况下，其流程如下： 准备资源文件本地化工具 → 检查所需要处理的源内容 → 抽取软件资源文件 → 对翻译的资源文件进行工程后处理 → 检查翻译的文件 → 调整软件界面 → 编译本地化软件 → 检查软件编译的完整性 → 修正软件测试中发现的缺陷  2. 联机帮助文档本地化。软件本地化工程一个十分重要的工作是联机帮助文档的本地化，其处理流程如下： 准备联机帮助文档的本地化工具 → 检查联机帮助工程文件内容 → 抽取联机帮助工程文件 → 翻译的联机帮助文档进行工程后处理 → 检查翻译的文件 → 编译本地化联机帮助文档 → 检查编译后联机帮助文档的完整性 → 修正联机帮助文档测试中发现的缺陷 3. 编制本地化软件文档。国际软件完成本地化工程后，就基本具备了在本地上市流通的条件了。但是，作为商品软件，在最后上市流通前