一篇好文章能够向学生们展示如何思考问题。当他们读完这篇文章后,他们会说“哦哦哦哦”。 他们就会理解他们试着去理解的概念,而且他们会停止在网上搜索同样的话题。
糟糕的文章恰恰相反。学生在通读完文章时会更加困惑。他们甚至会怀疑自己是否有能力学习编程。
把一篇糟糕的文章变成好文章花费不了多长时间。内容可以保留。你只需要保证五个因素。
五因素如下:
- 文章的目的
- 学生是谁
- 使用例子和类比
- 使用的语言
- 易于阅读
想象你在一个迷宫。你正在沿着一条路走,然后看见了一条岔路。
你应该走左边还是右边?
你不知道答案。那是因为你不知道哪条是出路。
搜索文章的学生同样会迷失。他们没有答案,这就是为什么他们一开始就在搜索。
指点他们走上正确的方向就是你的文章要做的工作。这意味着你写的每一篇文章都应该有结尾。 这个结尾就是文章的目的。
例如在这篇文章中,我想向你展示五个值得注意的因素,这样你就可以避免写出糟糕的文章。 创造的每一篇文章至少是让人满意的(希望是好的)。
为了给学生指出正确的方向,你必须了解他们是谁以及他们的技能水平。
你的学生是初学者、中级还是专家?
初学者、中级和专家的技能水平各不相同。一旦你思考他们的技能水平,你就可以为他们创造出更好的文章。
例如,你不会教初学者构建复杂的应用程序。你不会以 npm install <package>
做为文章的开头。
这是因为初学者很有可能不知道 npm 是什么。他们可能不知道你让他们安装的 packages。
然后他们迷失了。
此外,当你考虑学生的水平是,文章内容也会发生改变。对于初学者,你会创建包含小块信息的文章。 对于专家,你可以在一篇文章中结合不同的技能。
在这篇文章中,我理想的学生是希望写好编程文章的人。他们写的文章不到二十篇。 一旦你开始考虑文章的目的和学生,也是时候看一看你所使用的例子和类比了。
编程不是抽象的。变成也可以用真实、贴切的方式来解释。
抽象是因为老师使用无意义的变量,如 foo
和 bar
😑。
所以第一条法则就是绝不使用 foo
和 bar
。试着使用学生们可以联想到的例子。
想想你的学生。
他们日常生活中有什么经历?哪个经历可以用来类比你试图要解释的概念?
决定使用一个类比,然后解释它,这样哪些没有感觉到类比的学生仍能够理解你的意思。
举个例子,我是使用一个单向玻璃的类比解释 JavaScript 作用域。阅读这篇文章,看看我是如何解释的。
接下来是你使用的语言。
单词有引起强烈情感的能力。使用不当时,它们会让读者觉得自己是傻瓜。
看到我在那里做了什么吗?
一个句子可能会引起一些疑惑的、无用的或者有罪的感觉,而这些感觉对大多数文章没有好处。
如果你是写文章的初学者,把握情感可能比较困难。但是不要让这些阻拦你写作。
现在,我想让你集中于两件事。当你的经验更加丰富时,我们可以探讨如何在文章中插入和取回情感。
**第一,确保解释你使用的每个术语。**术语使概念比较晦涩。它们感觉像潘多拉的魔盒,无法解释 但是,如果你不解释解释术语,你怎么指望有人能够理解你的意思?
这就是为什么第一件事是让你学习使用简单易懂的语言来解释术语。
第二,注意这些单词,如明显地、简单地及仅仅。
最后,你会希望通过你写编辑为文章润色。
帮助学生理解你教授的概念是文章的工作。你想尽最大努力帮助他们。
一种提高他们理解方法是使用简短的句子。永远记住清晰远比聪明更重要。这是需要时间才能提高的技术。 如果你使用 Hemingway 这样的软件可以加速这个过程。 他会告诉你哪个句子需要返工。
另一种方法是清楚文章中的语法错误。这里,你可以使用 Grammarly 来检查语法错误。
要写好一篇技术文章,你需要考虑五个因素:
- 文章的目的
- 学生是谁
- 使用例子和类比
- 使用的语言
- 易于阅读
有很多技巧和技术用来写好一篇文章。这五个因素都是基本因素。