7.3 双语文档格式
本节规范了中英双语技术文档的排版格式和术语对照要求。
R-136
推荐
中英并列时的排版规范
当文档需要中英文并列展示时,中文内容应排在前面,英文内容排在后面。段落级别的中英对照建议使用左右分栏或上下对照的版式。句子级别的中英对照可使用括号注明英文原文。标题级别的中英对照建议中文标题为主,英文标题以较小字号或不同样式紧随其后。
R-137
必须
术语表必须提供中英对照
技术文档的术语表必须同时提供中文术语和英文对应词。术语表按中文拼音首字母排序,每个术语应包含中文名称、英文名称和简要说明。如果同一概念存在多个中文译名,应将推荐译名列在首位,其他译名以括号注明。
核心技术传播术语中英对照
| 中文 | English | 说明 |
|---|---|---|
| 技术传播 | Technical Communication | 涵盖技术信息的创建、设计和传递的学科领域 |
| 用户手册 | User Manual | 指导用户安装、配置和使用产品的文档 |
| 风格指南 | Style Guide | 规定文档写作风格和格式标准的参考文献 |
| 信息架构 | Information Architecture | 组织和结构化信息内容的方法论 |
| 结构化写作 | Structured Authoring | 使用预定义结构和标记语言进行内容创作的方法 |
| 内容管理 | Content Management | 对文档内容进行创建、存储、发布和维护的系统化管理 |
| 单一来源 | Single Sourcing | 从同一内容源生成多种输出格式的技术和策略 |
| 术语管理 | Terminology Management | 系统化地创建、维护和发布标准术语的过程 |
| 本地化 | Localization | 将产品和文档适配到特定语言和文化环境的过程 |
| 可用性测试 | Usability Testing | 评估产品或文档对目标用户的易用程度的测试方法 |
双语 DITA 主题示例
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN"
"topic.dtd">
<topic id="bilingual_example" xml:lang="zh-CN">
<title>安装要求 (Installation Requirements)</title>
<body>
<section id="sys_req">
<title>系统要求 (System Requirements)</title>
<p>安装本软件前,请确认您的系统满足以下要求:</p>
<p><i>Before installing, verify that your system
meets the following requirements:</i></p>
<ul>
<li>
操作系统(Operating System):
Windows 10/11 或 macOS 12 以上
</li>
<li>
内存(Memory):
8 GB 以上
</li>
<li>
磁盘空间(Disk Space):
2 GB 可用空间
</li>
</ul>
</section>
</body>
</topic>