固定排版规则¶
技术文档中经常出现的内容(元素),统一成固定排版规则。
快捷键¶
快捷键(或热键)是指通过某些特定的按键、按键顺序或按键组合来完成一个操作。在文档写作中建议使用以下排版:
使用 <> 括起按键,前后各添加一个空格
使用 + 号连接按键,不使用空格分隔
按键名称遵循键盘上印刷的英文字母(大小写)书写
使用 Win 指代 Windows 徽标键
使用 Cmd 指代 macOS 徽标键(⌘)
方向键可以使用文字,如: <Ctrl+左箭头>
在 Windows 操作系统中,使用快捷键 <Ctrl+C> 复制所选择的内容或文件。
在 Excel 软件中,使用快捷键 <Alt+Shift+F1> 插入新工作表。
依次选择菜单栏上的选项¶
在文档中需要说明,按步骤依次选择菜单栏上的选项,建议使用以下排版:
使用 [] 括起选项,前后各添加一个空格
使用 > 连接依次选择的选项,前后各添加一个空格
打开 Excel 软件后,选择菜单 [文件 > 新建 > 空白工作簿] 新建空白的工作簿。
上下文的链接¶
链接分为内链和外链,内链是指文档内部的链接,外链是指文档内指向外部网站的链接。
文档内的链接¶
在线文档相对于传统书籍,可以更好的做到上下文的链接,方便在文档之间跳转。
文档写作也包含在内容之中,请参见:“划分主题”及“可读性”。
参见其它章节¶
传统书籍中的上下文链接,需要标名具体的章节目录。
文档写作也包含在内容之中,请参见:“3.1.4 划分主题”及“3.2 可读性”。
图片说明¶
使用图片时最好使用 figure 添加说明。简单的逻辑可以使用以下样式:
团队发明了一种新方法,可以更快的检测感染病毒,如下图所示。