如何写文章帮助人们了解 Web

翻译不完整。 请帮助我们翻译这篇文章!

MDN 的学习区是我们给新手开发者介绍 Web 概念的大本营。因为它的内容主要面对初学者,这是你分享知识,帮助新手逐渐了解 Web 的绝佳地点。确保新手开发者能够跟上这里的内容是很重要的,所以我们格外重视学习区。

这篇文章解释了如何给学习区写文章。

如何写学习社区的文章

要开始贡献你的知识,只需点击绿色大按钮,然后按照下面的五个步骤。如果你想找点子,请看一下我们的团队 Trello

这篇文章可能不会在正确的地方出现,但至少是在MDN上。如果你需要找人谈谈把它搬到正确的地方,请联系我们

第一步:写两行

你文章的第一句话需要总结一下你将要涉及的主题,第二句话应该更详细地介绍你要放在文章中的内容(项目)。例如:

 HTML 文件包含的结构和内容, CSS以及其他主要的Web技术,使内容看起来像你想要的那样。在本文中,我们将介绍这项技术是如何工作的,以及如何编写你自己的基本示例。

注意示例如何简要说明CSS是用于样式化页面的核心Web技术。 这足以使读者很好地了解本文所涵盖的内容。

因为学习区域的文章主要是针对初学者的,所以每篇文章都应该涵盖一个简单的主题,以免给读者带来太多的新信息。如果你不能在一句话中总结这篇文章,那么你可能在一篇文章中做得太多了!

第二步:添加一个顶部框

然后添加一个顶框,以帮助读者了解他们在学习过程中的位置。 这是“了解URL及其结构 ”顶部框的示例。 您可以在编写自己的文章时将其用作模型。

必要条件: 您首先必须清楚Internet的工作方式,Web服务器是什么,与Web链接背后的所有概念。
目标: 您将了解什么是URL以及它如何在Web上工作
必要条件
读者首先必须知道什么东西才能读懂你的一篇文章?在有可能的状况下,让每一个前提条件链接到另一篇涵盖概念的学习领域的一篇文章(除了您写的是是一篇完全不需要首先先验知识的无比基础的文章)。
目标
这一章节粗略说明了您的读者在阅读学习这篇文章的过程中会学到(并学会)什么。这与一行程序有点不同;一行代码总结了文章的主题,而目标部分专门列出了读者在阅读文章过程中所希望完成的全部内容。

注意:要创建此表,您可以复制并粘贴上面的示例表,或者使用MDN的编辑器 台式工具。如果选择使用table工具,则需要在默认的standard-table类之外特别添加learn-box CSS类。为此,当您创建或编辑表的属性时,请转到“Advanced”面板并将样式表类字段设置为“standard-table learn-box”。

第三步:写一个完整的描述

接下来,写一个更长的描述,提供更全面的文章概述,突出最重要的概念。不要忘记解释为什么读者要花时间来学习这个主题并阅读你的文章!

第四步:更深一步

当你完成了所有这些,你终于可以深入到主题。你可以根据自己的喜好来组织文章的这一部分(尽管您能够随时咨询我们的 设计指南)。这是你闪耀的机会!详细解释你要写的主题。提供指向完整参考文档的链接,详细解释该技术的工作原理,提供语法和用法细节,等等。由你决定
  • 专注于一个主题。如果你觉得你需要涵盖其他主题,这意味着要么你错过了一篇必备文章,要么你需要把你的文章分解成多个主题
  • 使用简单的英语。尽可能避免使用技术术语,或者至少定义它们并在适用的情况下链接到它们的术语表条目。
  • 包括直接的例子,使理论概念更容易掌握。许多人以身作则学得最好。与写学术论文相比,我们希望初学者能容易地跟上文章的节奏
  • 视觉辅助工具通常可以使内容更容易消化,并携带额外的信息,所以请随意使用图像、图表、视频和表格。如果您正在使用包含文本的图表,我们建议您使用SVG,这样我们的翻译团队就可以本地化文本。

看一看我们的函数的前几节可重用代码块文章 ,有一些很好的描述部分。

第五步:提供“主动学习”材料

为了阐明本文并帮助读者更好地理解他们正在学习的内容,请确保提供练习、教程和需要完成的任务。通过让他们积极地、实际地使用和试验你文章中解释的概念,你可以帮助他们将信息“锁定”在大脑中。

您可以选择在页面中直接包含这些示例作为 实时实例,或者直接链接到它们。 (如果它们不能作为实时实例。) 如果你有兴趣帮助创造这些有价值的东西 ,请参阅《创建一个交互式的练习来帮助学习网络》

如果您不能提供到现有活动学习材料的链接(您不知道或者没有时间创建它们),那么您应该在文章中添加标记。这样,其他贡献者就可以找到需要积极学习材料的文章,并可能帮助你找到它们。

看看《主动学习:选择不同的元素》进行现场互动学习练习或者《主动学习: 玩转范围》或者另一种不同风格的练习,要求它们在本地下载模板并按照提供的步骤更改

                                                                                         

第六步:查看文章,并放入学习区域导航菜单

在你写完你的文章后,让我们知道,这样我们可以看一看,做一个回顾,并提出改进建议 。再次看看我们的 联系方式 板块以寻找最好的联系方式。

完成文章的另一部分是把它放在学习区主导航菜单中。这个菜单是 LearnSidebar 宏生成的。 你需要特殊的权限来编辑,所以,再一次,让我们团队中的一个人把它添加进去。

您至少应该将其添加到您的页面中,这是通过在页面顶部的段落中添加宏调用{{LearnSidebar}}来完成的。

推荐文章

您想做出贡献,但是您不知道该写什么?

学习社区维护了一个要写文章的Trello看板。随意挑选一个,然后开始去写吧!