编写指南

MDN 网页文档是一个开源项目。以下各节概述了我们关于 MDN 网页文档上记录什么以及如何记录的指南。要了解如何贡献，请参阅我们的贡献指南。

本节涵盖了我们在 MDN 网页文档上包含的内容以及我们不包含的内容，以及其他一些策略，例如我们何时编写有关新技术的信息、内容建议流程以及我们是否接受外部链接。如果您正在考虑为我们撰写或更新内容，这是一个很好的起点。本节还包括

写作风格指南涵盖了我们在 MDN 网页文档上写作时使用的语言和风格。它还涵盖了如何格式化代码示例。

本节涵盖了创建和编辑页面所需的所有信息，包括我们遵循的某些流程和技术。本节提供了有关入门的信息、页面结构的总体概述以及在何处查找特定任务的操作指南。本节包括以下主题：

如何研究一项技术: 本节提供了一些关于研究您正在记录的技术的有用技巧。
如何创建、移动和删除页面: 本节说明了我们如何在 MDN 网页文档上创建、移动或删除页面。它还解释了在移动或删除页面时如何重定向页面。
如何使用 Markdown: 我们使用的 Markdown 格式源自 GitHub 风格的 Markdown (GFM)。本节是有关我们在 MDN 网页文档上使用的 Markdown 的指南，包括特定页面内组件（如注释和定义列表）的格式。
添加图像和媒体: 本节描述了在页面中包含媒体（如图像）的要求。
如何记录 CSS 属性: 本文解释了如何编写 CSS 属性页面，包括布局和内容。
如何记录 API 参考: 本节说明了如何处理 Web API 的记录。
如何记录 HTTP 标头: 本文解释了如何为 HTTP 标头创建一个新的参考页面。
如何添加术语表条目: 本文解释了如何在 MDN 网页文档术语表中添加和链接条目。它还提供了有关术语表条目布局和内容的指南。

MDN 网页文档上的每个页面都有一个特定的页面类型，无论是 CSS 参考页面还是 JavaScript 指南页面。本节列出了不同的页面类型并为每种类型提供了模板。最好浏览这些模板以了解您正在编写的页面类型。

本节涵盖了我们用来在 MDN 网页文档上提供一致信息呈现的各种页面结构。这包括

语法部分: MDN 网页文档上参考页面的语法部分包含一个语法框，用于定义功能的确切语法。本文解释了如何为参考文章编写语法框。
代码示例: 在页面上包含代码示例有很多不同的方法。本节概述了它们并为不同语言提供了语法指南。
横幅和通知: 有时，文章需要添加特殊通知。如果页面涵盖已弃用的技术或不应在生产代码中使用的其他内容，则可能会发生这种情况。本文涵盖了最常见的情况以及如何处理它们。
规范表格: MDN 网页文档上的每个参考页面都应提供有关定义该 API 或技术规范或规范的信息。本文演示了这些表格的外观并解释了如何添加它们。
兼容性表格: MDN 网页文档为我们的开放 Web 文档提供了标准的兼容性表格格式。本文解释了如何添加和维护用于生成兼容性表格的数据库，以及如何将表格集成到文章中。
宏: 宏是在页面中用于生成内容（如侧边栏）的快捷方式。本节列出了我们使用的宏及其作用。

描述了我们关于在网络上其他地方使用 MDN 网页文档内容的政策、如何获得在 MDN 上重新发布内容的权限以及链接到 MDN 内容的提示。

本节涵盖了我们对“已淘汰”、“已弃用”和“实验性”等术语的定义，并提供了有关如何使用这些术语标记技术的指南，以及我们何时从 MDN 网页文档中删除内容。