学习 Web 开发写作指南

MDN 的 学习 Web 开发 部分专门面向正在学习 Web 开发基础知识的人员,因此需要与 MDN 的其他内容采取不同的方法。本文档提供了学习内容写作的指南。

目标受众

MDN 学习 Web 开发(也称为 Learn)的目标受众不是前端开发专家,包括学生、初级或学员 Web 开发人员、业余爱好者以及希望获得教学最佳实践指南的教师。

主题覆盖

Learn 提供了一个包含学习成果的结构化路径,旨在教授将读者培养成成功前端开发人员所需的基础技能和实践。学习者可以依赖它来获取正确的学习信息,教育工作者也可以依赖它来获得正确的研究成果,并以此为基础构建课程和教学大纲。

因此,我们的目标是严格限制 Learn 的范围,使其仅涵盖:

  • 在我们的 入门模块中的设置、软技能和背景知识。
  • 在我们的 核心模块中,Web 开发人员旅程开始时所需的基础技术。
  • 在我们的 扩展模块中,代表初学者掌握核心模块后可以继续学习的有用后续步骤的“第二波”主题。

Learn 无意成为 MDN 上介绍所有主题的起点。这意味着诸如 MathML 和 Web Games 等小众主题,以及正则表达式、性能测试、WebRTC 和 WebGPU 等高级或专业主题,都不属于 Learn 的范畴。

如果您认为 Learn 中缺少某个主题,但您认为它应该被包含,请不要直接添加——而是先与我们讨论(请参阅 建议内容)。

方法

要创建和更新 MDN Learn Web 开发内容,在很多方面,您应该遵循与 MDN 其他内容相同的流程。您应该遵循相同的通用 写作风格指南代码风格技术

但是,也有一些区别:

  • 教程风格:MDN 的大部分内容是参考资料和指南的混合体;而 Learn 则旨在提供实践教程。我们没有严格的页面模板,但应该以一种通过分步讲解和“动手尝试”部分相结合的方式,手把手引导读者的方式来撰写。这些内容应指导读者动手尝试,并开始编写代码。例如,请参阅我们关于“搜索引擎”信息的 搜索引擎 下的“动手尝试”部分。这些内容是使用以下 Markdown 创建的:

    md
    > [!CALLOUT]
    >
    > **Try it out**
    >
    > Try this...
    
  • 挑战:Learn 内容会定期包含挑战,以测试读者在进入下一篇文章之前是否理解了他们所学到的主题。这些挑战目前有几种不同的写作风格,例如请参阅 挑战:内容页面结构测试你的技能:HTML 图像,但我们希望将来能提高这些挑战的一致性和用户体验。

  • 密度和完整性:MDN 内容通常以其全面性而闻名。Learn 内容则并非如此详尽完整。它的密度较低,方法更温和,以便学习者能够掌握有用的技能并取得稳步进步,而不会感到不知所措。他们以后可以深入研究。Learn 内容可以省略一些细节,以提供更舒适的学习体验,前提是它不会向读者教授任何误导性或不良实践。

  • 稳定的学习成果:每个教程顶部的学习成果总结了该教程所教授的内容,这些教程共同构成了前端 Web 开发的结构化课程。学习成果和教学内容保持稳定和同步至关重要,否则内容就不能作为正式学习(例如教育课程或认证)的基础。因此,对学习成果的更改应缓慢进行,并且要经过深思熟虑。如果您尝试添加未包含在相关学习成果中的内容(反之亦然),您的拉取请求将被关闭。请先 提出建议

注意:我们维护一个 变更日志,其中详细介绍了对学习成果所做的任何重大更改,以便教育工作者能够维护基于 MDN Learn 的任何资源。

正如我们在 外部链接指南中所述,MDN 通常不允许出现似乎认可商业产品或服务或指向付费内容的外部链接(或嵌入)。这是为了降低 MDN 内容因充斥垃圾链接而失去信任和变得不那么有用的风险。

MDN 的 Learn 内容对此有一些例外。我们允许来自特定受信任合作伙伴站点的外部内容(可能需要付费)的链接。这些是 MDN 通过仔细审查其质量、道德标准、对 Web 标准和最佳实践的承诺,并帮助他们更新不符合我们标准的网站,从而建立了信任关系的网站。我们相信他们不会在未经通知的情况下更改链接,并且相信他们的内容是安全的链接对象。

这些合作伙伴链接的目的是:

  • 提供对支持内容的访问,这些内容建立在我们页面所教授的内容之上。
  • 提供对多媒体学习体验(视频、幻灯片、其他互动内容)的访问,而 MDN 内容团队没有资源来制作这些内容。MDN 内容以文本为主,但人们通常需要不同的学习方法。
  • 通过联盟链接到付费内容选项来赚取收入,我们可以将这些收入用于使 MDN 变得更好。

然而,我们

  • 不会以损害 MDN 内容的完整性且明显是垃圾链接的方式添加这些链接;仅在我们认为它们真正有用时才会添加。
  • 始终确保付费内容旁边提供免费选项。在许多情况下,我们已成功说服合作伙伴免费提供以前需要付费的内容。
  • 将始终用“MDN 学习合作伙伴”标签清楚地标记合作伙伴内容,以便您可以清楚地区分它们与其他链接。

在 Learn 内容页面上,底部出现的“参见”链接应按以下顺序排列:

  1. 内部链接。
  2. 指向免费内容的链接。
  3. 指向混合免费/付费内容的链接。

当前教育合作伙伴