大谈自己作品的作家,正如大谈自己孩子的母亲。这种事还是少谈为佳。——迪斯思里
分享一篇文档写作规范的教程
https://developer.mozilla.org/zh-CN/docs/MDN/Writing_guidelines/Writing_style_guide
本篇写作风格指南描述了 MDN Web 文档上的内容应该如何书写、组织、拼写和格式化。
这些指南是为了确保整个网站的语言和风格的一致性。也就是说,我们对内容而不是格式更感兴趣,所以不必在为 MDN Web 文档贡献前学习整个写作风格指南。然而,如果其他贡献者后来编辑你的作品以符合该指南,请不要感到不安或惊讶。当你提交内容拉取请求时,审稿人也可能将你指向这个风格指南。
备注: 本指南的语言方面主要适用于英语文档。其他语言可能有(并且欢迎创建)他们自己的风格指南。这些应该作为各自的本地化团队页面的子页面发布。然而,在格式化和组织内容时,仍应参考本指南。
备注: 简体中文翻译时的规范请参见《简体中文翻译指南》,当然“简体中文翻译指南”仅列出了常见的规范,这份文档较为详细一点,在翻译时,参考一些相关内容也是有益的。
在列出一般的写作准则后,本指南介绍了 MDN Web 文档的推荐写作风格,然后介绍了如何对页面上的不同组件进行格式化,如列表和标题。