如何研究一项技术

本文提供有关如何记录各种技术的实用信息。

进行准备工作

在 MDN Web 文档上开始记录或更新前，应当首先准备和规划某些事项再开始正式书写。

假定你在阅读本指南前已对下列各项有合理程度的了解：

其余事项可边做边学。

在书写任何文档时的实用资源包含：

MDN Web 文档写作指南——虽然你已准备开始写作，但是仍然推荐浏览所有文章并熟悉我们的写作规范、不同的页面类型及所含章节和引入页面的不同部分（如规范和浏览器兼容性）的不同方式。
最新规范——MDN Web 文档上所记录的技术由不同的标准团体创建规范。例如 TC39 对应 JavaScript，WHATWG 对应 HTML，以及 W3C 对应 CSS、XML 和某些 web API。MDN Web 文档中的参考页有指向规范的链接（见“规范”一节），而通常也可进行 web 搜索。请总是着眼于最新的、最接近当下的规范。
最新的现代 web 浏览器——应为如 Firefox Nightly、Chrome 每日构建版或 Safari 技术预览版的实验性或内测构建版，这些版本更有可能支持要记录的特性。若要记录“即将到来”的特性，则这一点尤其要紧。
演示、博客文章或其他信息——请找到尽可能多的信息。若因为一项技术发生了变化而要将其更新，则请确保用于学习此技术的资源没有过时。此即上述前两点为何重要的原因。

尝试找人帮助解答问题也属明智之举，询问对象可为规范作者或实现浏览器特性的工程师。

开始阅读规范时可能会有些不适应，但是读得越多就会越习惯。此处有一些有助于上手的不错的链接：

如何阅读 W3C 规范（作者：J. David Eisenberg，载于 A List Apart）
理解 CSS 规范（来自 W3C）
如何阅读 web 规范（第 1 部分）——又名：WebVR，你的原理是什么？虽然仅阐述了阅读 WebVR 规范的步骤，却属如何阅读 web API 规范的不错的介绍。
如何阅读 web 规范（第 2a 部分）——又名：ECAMScript Symbol 为上一链接的第二部分，包含如何理解 ECMAScript 规范的信息，此规范描绘了 JavaScript 语言的大纲。

此外，我们有关于 WebIDL 文件所含信息的指南，在阅读 web API 规范时大有裨益。

在记录一项技术的过程中，你将反反复复书写代码示例或构建演示，而先花时间熟悉这项技术的原理将非常有用。这是十分有价值的实践，可以让你很好地理解用例（为何开发者要使用这项技术），且同时有助于创造一些代码示例。

备注： 若因规范近期的更新导致某个方法现在有不同的定义，但是旧的方法在浏览器中仍然有效，则为了同时涵盖旧方法和新方法，常常需要在同一处同时记录两者。如需帮助，请参考你所找到的演示或询问工程师。

你需要从头书写或进行更新的页面会因为所对应的技术而有所区别。请查阅页面类型和与要记录的技术相关的章节。由于极有可能还需更新现有文档，故请在 MDN Web 文档中搜索与要书写的内容相关的页面。

所写页面的侧边栏可能也需要进行定义或更新。为获知是否有必要操作及如何操作，请查阅侧边栏指南。

MDN Web 文档的某些代码示例位于另外的仓库中，其中最为显著的为参考页中“尝试一下”一节中出现的交互式示例和指南所需的大型演示代码。若确需在这些仓库中进行添加或修正，不妨在列表中进行对此标注。

代码示例一文描述了在 MDN Web 文档上所使用的不同类型的代码示例。

假设你要记录新的 web API，待记录章节的初始列表将类似下列所示：

然后可用更多的细节扩充列表，再加上每个接口及其构成。例如若要记录 Web Audio API，则列表很可能如下所示：

此时不妨在 mdn/content 仓库中创建追踪性议题，将上述页面列为待办（复选框）列表。由此可同时使你与其他着手于文档的人公开追踪状态。还可将你的合并请求链接至此议题，为所有人提供更多的背景信息。

现在可以创建所需页面了。创建新的页面请阅读如何创建、移动、删除和编辑页面指南中的指示。可能有用的页面模板请查阅页面类型指南。