EMoS 快速参考指南
本指南提供了《乐鑫风格手册》(EMoS) 中文文档基本写作规范 的快速参考。请参阅完整手册获取更多信息和示例。
主动语态
编写用户手册和指南时，使用主动语态，除特殊情况下，应避免使用被动语态。
示例
按下 EN 按键使系统复位。
在正式文档（如数据表、规格书）中，可以适当使用被动语态。
更多信息，请参考章节 Active vs. Passive Voice。
叙述视角
在教程和操作指南中，以第二人称称呼读者。
示例
对 eFuse 存储器的数据进行编程，首先需将数据写入编程寄存器中。
在解释性和参考性文档中，从客观的物称视角进行描述。
示例
Hold 功能可用于保持管脚状态。
尽量避免以“用户”或第三人称代词称呼读者。
相同文档类型中，尽量使用同一叙述视角。
更多信息，请参考章节 Point of View。
缩写和缩略词
文档中第一次提到缩写和缩略词时，请使用全称。
示例
Mesh 开发框架 (MDF)
如果缩写和缩略词比全称更常见，则可直接使用缩写和缩略词。
示例
USB
更多信息，请参考章节 Define Abbreviations and Acronyms at First Use。
大写
中文文档中，尽量避免在标题或句子开头使用英文单词。若无法避免，无需大写首字母。
示例
flash 加密功能
更多信息，请参考章节 Heading Titles。
标点符号
除特殊情况下，英文文档应使用英文标点符号，中文文档应使用中文标点符号。
空格
数字和单位之间使用空格。
示例
40 nm
中文和数字之间使用空格。
示例
2020 年
中文和英文字符之间使用空格。
示例
USB 接口
中文标点符号前后没有空格。
示例
比如，这个逗号前后没有空格
数字和百分比符号 % 之间没有空格。
示例
50%
数字和角度符号 ° 之间没有空格。
示例
50°
表示版本号 v 和数字之间没有空格。
示例
v1.1
连字符、连接号 (–)
连字符可表示数值范围，前后没有空格。
示例
2019-2020
连接号可表示负数。
示例
–1
斜线
不要使用斜线“/”代表“或”。
更多信息，请参考章节 Punctuation。
数字
五位及以上的数字，由右向左，每三位用英文逗号“,”分隔。
示例
10,000
小数用句点，不用逗号。
示例
1.4
表示金额时，建议使用货币代码，不用货币符号。
示例
100 USD
一般来说，建议使用十进制和十六进制数字。
更多信息，请参考章节 Numbers。
时间和日期
表示日期时，不要使用日/月/年或月/日/年全数字形式。
示例
不要使用 04/06/2020
更多信息，请参考章节 Time and Dates。
度量单位
数字和单位之间使用空格。
使用正确的度量单位和缩写。常见的有：
Byte, <abbr> B
kilobyte, <abbr> KB
kilohertz, <abbr> kHz
megabit, <abbr> Mbit
megabits per second, <abbr> Mbit/s
megahertz, <abbr> MHz
示例
85 °C
更多信息，请参考章节 Measurement Units and Abbreviations。
交叉引用
添加超链接时，在“显示”文本框中使用具体描述（例如文档名称、网址等），不要使用空泛的描述（比如“点击这里”）。
在 LaTeX、Word 或 Pages 文档中，请遵循以下规则：
外部超链接使用蓝色（Hex Color #0096FF）和下划线。
中文书名、文档名、报纸名等应使用蓝色、下划线、书名号。
对于
.md或.rst文档，遵循默认规范即可。
更多信息，请参考章节 Editing References。
图片和表格
图片中的文字大小应与正文文字大小一致。
图片应紧跟段落之后。
图片应居中放置。
一般情况下，图片要有编号和标题。
图片标题应紧跟图片。
更多信息，请参考章节 Pictures and Diagrams。
表格
单元格中的文本应垂直居中。
除特殊情况外，单元格中的文本应居左对齐，数字应居右对齐。
如果某一列居右对齐，说明单元格中为数字，此时该列的表头应居中对齐。
表格中有较多小数时，数字应按小数点对齐。
表头应垂直居下对齐。
表格应在页面中水平居中放置。
N/A 数据可使用破折号 (—)，有时也可省略。
更多信息，请参考章节 Tables。
UI 元素
应使用交互界面中 UI 元素的准确原文本，包括大小写字母，但需省略结尾的标点符号。
在
.md或.rst文档中，应在 UI 元素文本两边使用反双引号（``）。在 LaTeX、Word 或 Pages 文档中，遵循以下规则：
对于英文文档中的英文 UI 元素文本，使用加粗字体。
示例
Click Submit
在其他情况下，使用双引号。
示例
点击“提交”。
点击 “Submit”。
使用大于符号 (>) 来指示不同 UI 元素之间的顺序，符号前后加空格。
示例
在“开始”窗口的“插入”标签页，点击“表格” > “插入表格”。
如果用户界面中提供了与文档语言相同的语言选项，则应在文档中使用该语言的 UI 元素文本。若无相应语言选项，则直接使用原文本，或使用“原文本（翻译）”的形式。
示例
在 “Android package name” 字段中输入软件包名称。
勾选复选框—— “Show apps that create custom IAM roles or resource policies”（显示创建自定义 IAM 角色或资源策略的应用程序）。
更多信息，请参考章节 UI Elements。
硬件/软件模式
一般情况下，模式名称的大写应遵循标题的大写规则。
示例
仅可在 Release 模式下启用 flash 加密。
技术术语
使用技术术语时应保持一致。
如不确定某一技术术语，可参考 《乐鑫术语库》。