撰写指南

MDN Web 文档是一个开源项目。下面的概述部分描述了有关我们在 MDN Web 文档上撰写什么文档以及如何撰写文档的指南。学习如何做出贡献,请参见我们的贡献指南

撰写的文档内容

本节涵盖了我们在 MDN Web 文档中包含的内容和我们不希望包含的内容,以及其它的政策,如:我们何时为新技术撰写文档、内容建议流程和我们是否接受外链。如果你正在考虑为我们撰写或更新内容,这是一个很好的入门内容。本节还包括:

包含的标准 (en-US)

本文提供了要将内容添加到 MDN Web 文档的深入标准、在 MDN Web 文档添加新文档的申请流程,以及申请的期望和指南。

文档写作规范

文档写作规范涵盖了我们在 MDN Web 文档上使用的语言和格式。它也包含了如何格式化代码示例 (en-US)

如何撰写 MDN Web 文档 (en-US)

本节涵盖了与创建和编辑页面有关的所有内容,包括我们遵循的流程和技术。本节提供有关入门的信息、页面结构概述,以及在哪里可以找到有关特定任务的操作方法。本节包括以下主题:

如何研究一项技术 (en-US)

本节为你提供了在撰写文档时研究一项技术的技巧。

如何创建、移动和删除页面

本节说明了我们应该如何创建、移动或删除 MDN Web 文档中的页面。它也解释了在移动和删除页面时,我们应该如何对页面进行重定向。

如何使用 markdown

我们使用的 markdown 格式源自 GitHub 风格的 markdown(GFM)。本节是我们在 MDN Web 文档中使用 markdown 的指南,包括特定页内组件的格式,例如特别声明的内容和定义列表。

添加图像和媒体内容 (en-US)

本节介绍了在页面中包含诸如图像等媒体内容的要求。

如何撰写 CSS 属性文档 (en-US)

本文介绍如何撰写 CSS 属性页面,包括布局和内容。

如何撰写 API 参考文档

本节介绍了如何撰写 Web API 文档。

如何撰写 HTTP 标头文档 (en-US)

本文介绍了如何创建 HTTP 标头的参考页面。

向术语表添加条目

本节介绍了如何在 MDN Web 文档中添加术语条目以及链接到这些条目。它还提供了有关术语表条目的布局和内容的指南。

MDN Web 文档上的页面类型 (en-US)

不论是 CSS 参考页面还是 JavaScript 指南页面,MDN Web 文档上的每个页面都有特定的页面类型。本节列出了不同的页面类型并提供了每种类型的模板。浏览这个文档将有助于你了解你正在撰写的文档的类型。

MDN Web 文档的页面结构

本节介绍了我们用于在 MDN Web 文档中提供一致的信息呈现的各种页面结构。包括:

语法部分 (en-US)

MDN Web 文档中的参考页面的语法部分包含一个语法框,用于定义一个特性的确切语法。本文介绍了如何为参考文档编写语法框。

代码示例

在页面上包含示代码示例的方法很多,本节介绍了这些方法,并提供了不同语言的语法指南。

横幅和说明 (en-US)

有时,在文章中需要添加特殊的说明。如果页面中包含不推荐使用的技术或不应在生产环境中使用的其它内容,则可能会包含这些特殊说明。本文涵盖了最常见的情况,以及应该如何处理它们。

规范表格 (en-US)

MDN Web 文档中的每一个参考页面都应该提供有关定义该 API 或技术的规范信息。本文演示了这些表格的外观,并说明了添加的方法。

兼容性表格

MDN Web 文档为我们的开放式的 web 文档提供了兼容性表格的标准格式。本文说明了为用于生成兼容性表格的数据库添加和维护数据,以及如何将这些表格集成到文章中。

宏是页面中用于生成内容(例如侧边栏)的较为便捷的方式。本节列出了我们使用的宏以及它们的作用。

署名和版权许可协议

描述在其它地方使用 MDN Web 文档内容的政策、如何获得重新发布 MDN 上的内容的许可,以及链接到 MDN 上的内容的相关说明。

如何标记一项技术 (en-US)

本节涵盖了我们对过时、弃用和实验性术语的定义以及使用这些术语去标记一项技术的情形,并提供了关于何时从 MDN Web 文档中删除相应内容的指南。