MDN 内容和样式指南

这些指南提供了 MDN 文档应当如何被编写并被格式化的规范,以及我们的代码示例与其它内容应当如何被表示的详情说明。你可以通过遵循这些指南来确保自己编写的内容是清晰易用的。

MDN Web 文档写作规范

为了提供更加组织化、标准化且易于阅读的文档,MDN Web 文档写作规范明确了文本的组织方式、拼写规则、固定格式等内容,不过这些内容只是指导性的而不是严格的规定,因为比起格式我们对内容更感兴趣,所以没有必要在参与贡献之前强迫自己学习本规范。但是如果有一位勤劳的志愿者在之后编辑了你的文档使它更加符合本规范,也请不要感到惊讶或难过。

MDN 收录规则

在本文中,你将找到 MDN Web 文档收录规则的有关信息,我们将从主题和类型两方面告诉你什么样的内容是合适的。有些内容如果不适合放置在这里,我们将和你讨论它应该被放置在什么地方,尽管我们的讨论不会很深入。