写作风格指南是一类写作时可参考的手册。每个人，每个团体，每个公司都有自己的语言风格，但并不是所有的写作风格都能促进理解，减少沟通成本，规范文档，和对外树立专业的形象。为了实现这几点，比较大的公司都有自己的写作风格指南。比如：

• Microsoft Writing Style Guide
• The Red Hat Style Guide
• Google Developer Documentation Style Guide
• Snapmaker English Writing Style Guide

这些指南都是针对英文写作的，中文写作的风格指南可参考的样本较少，其中一份是 中文技术文档的写作规范。鉴于中文文档的增多，为了促进交流效率，这份指南诞生了。它主要面向内容设计和市场运营的同事。技术文档工程师需遵守，其它运营同事，以及营销和公关的同事可有选择性地遵守，研发同事可参考。

这份指南规定 Snapmaker 内部中文写作中的注意事项。第一章，语言与语法，帮助你用清楚的语言写作，第二章格式与内容架构，帮助你用好看的方式呈现你写的内容。

术语的规范表达不在这份指南的规定范围内。如果有术语概念需要厘清，请咨询 archain@snapmaker,com，中英术语表见 https://shimo.im/sheets/9YTQWxT6yVkxYHGp。

截至 2021 年 11 月 11 日，石墨文档中的《Snapmaker 中文写作风格指南》已停止维护，今后的更新都会在此 repository 中进行。欢迎指正和探讨，如有建议，可以先在上方提 issue 或者发送邮件至 [email protected]。下面是这份写作风格指南的目录。

1. 语言和语法

• 1.1 标点
  • 1.1.1 逗号（，）
  • 1.1.2 短横线 （ – ）
  • 1.1.3 顿号（、）
  • 1.1.4 分号（；）
  • 1.1.5 感叹号（！）
  • 1.1.6 一字线（—）
  • 1.1.7 角括号（ > ）
  • 1.1.8 句号（。）
  • 1.1.9 连字符（-）
  • 1.1.10 冒号（：）
  • 1.1.11 破折号（——）
  • 1.1.12 千分号（,）
  • 1.1.13 书名号（《》）
  • 1.1.14 双引号（“ ”）
  • 1.1.15 问号（？）
  • 1.1.16 斜杠（/）
  • 1.1.17 圆括号
• 1.2 单位
  • 1.2.1 货币
  • 1.2.2 缩写
  • 1.2.3 区间
• 1.3 口吻
• 1.4 日期和时间
• 1.5 缩略
• 1.6 易读性
  • 1.6.1 平实、简单
  • 1.6.2 清晰、明确
  • 1.6.3 有逻辑性、主次分明
• 1.7 “咬文嚼字”

2. 格式与内容架构

• 2.1 标题
  • 2.1.1 标号
  • 2.1.2 命名
• 2.2 表格
• 2.3 间距
  • 2.3.1 被强调的元素
  • 2.3.2 段落
  • 2.3.3 符号
  • 2.3.4 含链接的文字
  • 2.3.5 日期和时间
  • 2.3.6 型号与规格
  • 2.3.7 网址和联系方式
  • 2.3.8 英文和字母
• 2.4 链接
• 2.5 列表
• 2.6 强调、引用和提及
• 2.7 数字
• 2.8 题目
• 2.9 引用