安同 OS 用户手册编写规范

安同 OS 用户手册编写规范

欢迎参与文档的编写工作！编写文档绝非易事，此类工作通常需要一定程度上的汉语知识，并且不能过于口语化，又不能像技术文档那样生硬。同时，与技术文档类似，在您编写用户文档前，您也需要透彻了解所描述的对象。

一般来讲，用户使用软件的目的是为了完成日常工作、娱乐及系统维护。您可能是高级用户，有些功能您可能会用到，但普通用户日常情况下用不到。因此，您需要权衡介绍给用户的功能及其细节。

用户文档的受众是广大用户，因此您应该尽量采用温和的语气编写描述，同时在介绍操作时务必注意详细描述每一个步骤。

以下是一些关于用户文档编写的要求。

总体要求

截图可以在虚拟机上进行，也可以在物理机上进行。
截图的语言必须匹配文档的语言（英文文档中的截图需使用英语界面）。
全屏幕截图尺寸不得超过 1920×1200。如果物理机启用了 HiDPI（视网膜清晰度显示），则有效分辨率不得超过 1920×1200。
除非必要（如虚拟机无法使用 WiFi 及蓝牙等），否则您应该在 “安同 OS 参考系统” 上截图。
如果无法使用 “安同 OS 参考系统”，您需要保证您的 KDE 外观处于如下状态：
1. “全局主题” 为 “AOSC OS”。
2. “应用程序主题”、“Plasma 主题”、“窗口装饰元素” 都保持为 “Breeze 微风”。
3. “字体” 中的字体为默认。
截图可以不带光标。由于截图软件或虚拟机的限制，您可能无法截到光标。
截图需存储为 PNG 或 JPEG 格式。截图文件的大小不受限制，一般遵循文档托管平台的限制。
截图的文字标注不允许使用有版权的字体，如 Helvetica、Segoe UI、Arial、微软雅黑等。
- 中文字体推荐使用 Noto Sans CJK。
- 英文字体推荐使用 Trebuchet MS 及 Open Sans。然而 Trebuchet MS 的许可需要考证。

“安同 OS 参考系统” 是用于文档编写用途的系统，如上节所述，除非必要，否则所有截图均需来自 “参考系统”。

制作 “参考系统” 的方法很简单：您只需要安装桌面版的安同 OS，安装完毕后更新系统即可。

Warning

系统安装后，您不得调整任何外观设置。

作为中文文档的编写者，您应该了解以下要点：

“用户文档” 的受众是用户。
您应该尽量避免使用晦涩难懂的术语，或者在必要情况下给出合理的解释。
文档的描述需通顺。
正确使用标点符号。尽管您可能日常期间有在使用，但在文档编写的情境下，您不应该使用 “「」” 形式的引号。
统一使用 “您” 来称呼用户。
避免直接采用由其他语言翻译而来的文档。
文档描述不得过于口语化，如 “点击这个 ‘拆分视图’ 按钮就能够把 Dolphin 的界面分成两半了。” 应改写为 “点击 ‘拆分视图’ 按钮就即可将文件视图拆分为两部分。”
描述界面及操作时应清晰。如上例中的反例 “Dolphin 的界面” 指代不清，应改为 “文件视图”（您应该在描述 Dolphin 界面时介绍文件视图是什么）。

您不应该直接采用自其他语言翻译来的文档，您也不应该直接采用机器和人工智能翻译的语句。您可以将其视为辅助您编写文档的手段，但由于这些翻译来的句子通常充斥着不符合中文语言习惯的句式或词组，因此您应该再三阅读，并且有必要时在呈现到文档前改写翻译的文本。

以下举几个常见的、有违日常汉语习惯的 “课本英语” 句式：

“当……时”：该句式在翻译出的中文文档中非常常见，且应该避免。
- 取决于语境，此类句式的改写方法也不同。
- 常见的改法是改写成 “如果……，您可以……”、“在……的情况下，您可以……” 等。
倒装句式：“您不应该在文档中使用 ‘「」’ 形式的引号，尽管您日常习惯中可能会用到。”
“进行……（的操作）”：常见的滥用词。取决于语境，改写的方法也不同：
1. “然后运行 make 进行编译”：删去 “进行”，改写成 “开始编译（软件/项目）”。
2. “需要先进行数个操作”：将 “进行” 改为 “执行”，并将 “操作” 改为 “步骤”。
其他一些生硬的词组或句式，如 “如果……那么……”、以下是一些常见的或被滥用的错误翻译：