写作指南
MDN Web Docs 是一个开源项目。下面概述的各部分描述了我们关于在 MDN Web Docs 上记录什么内容以及如何记录内容的指南。要了解如何贡献，请参阅我们的贡献指南。
- 我们写什么
-
本节涵盖了我们在 MDN Web Docs 上包含和不包含的内容，以及其他一些政策，例如何时撰写关于新技术的内容、内容建议流程以及是否接受外部链接。如果您考虑为我们撰写或更新内容，这是一个不错的起点。
- 收录标准
-
本文详细介绍了 MDN Web Docs 上内容的收录标准、收录新文档的申请流程，以及申请方的期望和指南。
- 我们的写作风格指南
-
写作风格指南涵盖了我们在 MDN Web Docs 上使用的语言和风格。它还涵盖了如何格式化代码示例。
- 学习 Web 开发写作指南
-
MDN 的“学习 Web 开发”部分专门面向学习 Web 开发基本基础知识的人员，因此需要与 MDN 的其他内容采取不同的方法。本文提供了编写学习内容的指南。
- 如何为 MDN Web Docs 编写内容
-
本节涵盖了创建和编辑页面的所有信息，包括我们遵守的特定流程和技术。本节提供了关于入门的信息、页面结构的总体概述，以及在哪里可以找到特定任务的操作方法。本节包括以下主题：
- 如何研究技术
-
本节提供了一些关于研究您要记录的技术的实用技巧。
- 如何创建、移动和删除页面
-
本节解释了我们如何在 MDN Web Docs 上创建、移动或删除页面。它还解释了我们在移动或删除页面时如何重定向页面。
- 如何使用 Markdown
-
我们使用的 Markdown 格式源自GitHub flavored markdown (GFM)。本节是关于我们在 MDN Web Docs 上使用的 Markdown 的指南，包括特定页面内组件的格式，例如注释和定义列表。
- 添加图片和媒体
-
本节描述了在页面中包含媒体（例如图片）的要求。
- 如何记录 CSS 属性
-
本文介绍了如何编写 CSS 属性页面，包括布局和内容。
- 如何记录 API 参考
-
本节解释了如何着手记录 Web API。
- 如何记录 HTTP 标头
-
本文介绍了如何为 HTTP 标头创建新的参考页面。
- 如何向词汇表中添加条目
-
本文介绍了如何在 MDN Web Docs 词汇表中添加和链接条目。它还提供了关于词汇表条目布局和内容的指南。
- MDN Web Docs 上的页面类型
-
MDN Web Docs 上的每个页面都有特定的页面类型，无论是 CSS 参考页面还是 JavaScript 指南页面。本节列出了不同的页面类型并为每种类型提供了模板。浏览这些内容以了解您要编写的页面类型是个好主意。
- MDN Web Docs 上的页面结构
-
本节涵盖了我们用于在 MDN Web Docs 上提供一致信息呈现的各种页面结构。这包括
- 语法部分
-
MDN Web Docs 参考页面的语法部分包含一个语法框，用于定义功能的精确语法。本文介绍了如何为参考文章编写语法框。
- 代码示例
-
有许多不同的方法可以在页面中包含代码示例。本节概述了它们，并为不同语言提供了语法指南。
-
有时，一篇文章需要添加特殊通知。如果页面涵盖了已弃用的技术或其他不应在生产代码中使用的材料，则可能会发生这种情况。本文介绍了最常见的情况以及如何处理它们。
- 规范表格
-
MDN Web Docs 上的每个参考页面都应提供有关定义该 API 或技术的规范的信息。本文演示了这些表格的外观，并解释了如何添加它们。
- 兼容性表
-
MDN Web Docs 为我们的开放 Web 文档提供了兼容性表的标准格式。本文介绍了如何向用于生成兼容性表的数据库添加内容和维护该数据库，以及如何将表格集成到文章中。
- 宏
-
宏是页面中用于生成内容（例如侧边栏）的快捷方式。本节列出了我们使用的宏及其功能。
- 署名和版权许可信息
-
描述了我们关于在网上其他地方使用 MDN Web Docs 内容的政策，如何获得在 MDN 上重新发布内容的许可，以及链接到 MDN 内容的提示。
- 如何标记技术
-
本节涵盖了我们对“已淘汰”、“已弃用”和“实验性”等术语的定义，并提供了如何用这些术语标记技术的指南，以及何时从 MDN Web Docs 中删除内容的指南。