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

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

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

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

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