为什么您的在线课程需要样式指南以及如何立即编写样式指南

当我们启动我们的语言学习平台LinguaLift时,我们已经拥有成千上万的日语学习课程。 在过去的两年中,我们自己编写了这本教科书,并根据学生的反馈逐堂改进。

问题?

现在,我们必须在两个月内达到一个相同的结果,这需要一个新的作者团队来教授我们都不懂的语言。 显然,前进的唯一方法是创建清晰的指导方针,以凝聚我们过去的学习和教学哲学。

我们的目标:

给新员工足够的结构来编写适合每种特定语言的课程,而且我们的学习者显然会认为这是LinguaLift产品。

在今天的帖子中,我将向您展示如何创建edtech样式手册,该手册将:

  • 在整个课程中确保一致的声音
  • 将您的教育者团结在共同的价值观之下
  • 为您的人群带来有效的复制
  • 为内容编辑器省钱

如何编写教育风格指南

了解您的客户

为了确保您的工作不会浪费,首先要充分了解您的学生,这一点很重要。

以下是您应该回答的一些问题:

  • 他们有什么问题可以解决?
  • 他们感兴趣的与切线相关的主题是什么?
  • 他们多大和受过教育?
  • 他们的生活方式共有哪些特征?

我建议您问尽可能多的问题,并确保每个人都参与其中。 给每个团队成员一个笔和空白的抽认卡,将计时器设置为3分钟,并要求他们写出尽可能多的想法。 疯狂,更好!

然后,在会议的其余时间中,集思广益地回答每个问题,并建立您的客户角色。

确定要投影的值

当您考虑样式指南时,可能会想到拼写和标点符号。

实际上,最重要的部分是导言,它定义了书写方式背后的更广泛的哲学。

这是《经济学人风格指南》的开头:

《经济学人》的第一个要求是它应该易于理解。 清晰的文字通常遵循清晰的思想。 因此,请想想您想说的话,然后再尽可能简单地说出来。

我建议您阅读全文,读者的来信和重要作家的名言都使信息更加有力。 但是,即使前三句话也包括了新作家所需要的全部内容,并预言了完整指南中将遇到的每条规则。

这是另一个示例,来自LinguaLift的作者使用的我们自己的样式手册:

我们如何教学
固执己见的方法论
一门好的课程可以帮助学生,而不是试图安抚所有的教学方式。
带领学习者充满信心,不要让他们怀疑哪种方法最好。

自助学习
自学是最好的学习方法,但是缺乏动力和指导会导致失败。
从背后支持和授权自学者,提供有关前进道路的见解。

立即可行,但长期关注
您将永远不会忘记可以立即使用的功能。 要个性化和有用。
不要引入会妨碍长期了解的捷径。

超越幻想的进步
鼓励在狂欢学习中养成持久的习惯。
在学习之前强制复习。

我们采用了与《经济学人》不同的格式,但是概念保持不变。 我们希望团队中的每个人都能生活和呼吸我们的方法,这种方法完全适合我们试图吸引的客户。

阐明您认为好的散文

接下来,是时候将您先前定义的值与您的作者希望采用的写作风格联系起来了。

再次,从《经济学人风格指南》的介绍中:

请记住,乔治·奥威尔(George Orwell)的六项基本规则(“政治与英语”,1946年):

  1. 切勿使用隐喻,明喻或其他通常用于印刷品的比喻。
  2. 切勿在短单词会用到的地方使用长单词(请参阅短单词)。
  3. 如果可以切出一个单词,请务必切出(请参见不必要的单词)。
  4. 切勿在可以使用主动装置的地方使用被动装置。
  5. 如果您能想到每天相当于英语的单词,请不要使用外来短语,科学单词或专业术语。
  6. 打破所有这些规则要比直言不讳的行为更早打破(请参阅圣像集)。

注意每个观点如何强化“经济学人”的首要要求,即清晰性,但这一次是针对作者的更具体建议。

您还会注意到,《经济学人》经常引用著名作家的话。 自那以后,这家英国报纸已成为其权威,但引号有助于进一步增强样式指南在用户眼中的有效性。

同样,我们自己的《样式手册》中的示例:

我们如何写作
好的课程的指导原则应简洁,一致和清晰。 写下您要向好朋友解释的方式。 最好的课程读起来就像是对您发送的问题的电子邮件回复,您最喜欢的老师亲自回答过。

“如果我们希望用户喜欢我们的软件,我们应该将其设计为像一个可爱的人:尊重,慷慨和乐于助人。”
—艾伦·库珀

简明扼要
用伟大的爱德华·塔夫特(Edward Tufte)来形容,每一滴墨水都必须有其原因。 写出清晰的句子,用最少的单词传达信息,而又不影响清晰度。

“我只看到一条规则:要明确。”
—斯坦达尔

始终如一
选择一种组织解释,呈现助手并强调重要内容的方法。 然后在整个课程中坚持下去。

一致性是最强大的可用性原则之一:当事物始终表现相同时,用户不必担心会发生什么。 相反,他们根据先前的经验知道会发生什么。”
—雅各布·尼尔森(Jakob Nielsen)

使用简单的语言
不要随便,而要使用受过良好教育的日常语言。 避免使用语言行话,演讲繁华和闲话。

“无论界面多么漂亮,界面多么酷,如果界面越少越好。”
—艾伦·库珀

一旦有了更广泛的目标,就该讨论一下您可能会遇到的拼写,标点和其他技术问题。

如果不予回答,那么一些小的技术性工作最终可能会浪费您和您的编辑者来回重复的时间,或者导致不一致的内容激怒读者。

对于一组专业作家而言,编写完整的风格手册是一项全职工作。 因此,我建议您只涵盖出版物中最重要的要点,然后选择一个既定的样式指南,并请您的作家引用该指南,以了解是否没有涵盖特定的要点。

以下是英国和美国英语的一些受欢迎的选择:

  • 《经济学人风格指南》(BrE,免费)
  • 芝加哥风尚手册(AmE,每人每年$ 35)
  • 守护者和观察者风格指南(BrE,免费)
  • 《纽约时报》样式和用法手册(AmE,15.95美元)
  • 美联社新闻手册(AmE,每人每年$ 26.00)
  • 雅虎! 风格指南(AmE,$ 17.47)

为您的作家准备一份分步清单

专业作家已经研究了多年最佳实践,阅读和重新阅读了不同的风格指南,并消耗了其他才华横溢的作家大量的散文。

结果,他们几乎可以在不知不觉中应用所需的样式。

当然,没有文案写作或新闻背景的团队成员也不会期望得到同样的结果。 这就是为什么我们使用清单将我们的《风格手册》关闭的原因,作者可以着手改进其初稿。

该列表改编自《华尔街日报》的Shani Raja及其出色的课程《与Flair写作:如何成为Udemy的杰出作家》。

完成课程的编写后,逐点浏览下面的清单,以改进您的工作:

  • 我是否始终使用简单,熟悉的词?
  • 我是否已消除所有行话和陈词滥调,套期保值?
  • 我是否避免重复单词,重点?
  • 我在任何地方都没做太多细节吗?
  • 我有避免歧义吗?
  • 我要避免使简单的观点听起来复杂吗?
  • 我所有的区别/比较都清晰吗?
  • 我可以再删掉一些单词吗?
  • 是否有句子太长或包含太多子句?
  • 我会使用主动语音吗?
  • 我要避免转成句子吗?
  • 我的时态一致吗?
  • 我可以避免回声吗?
  • 我的作品是否反映出清晰,逻辑的思维?
  • 读者会被迫重读吗?
  • 我是否已清除所有不必要的杂物?
  • 我马上明白了吗?
  • 我有一个逻辑的叙述结构吗?
  • 我会引导读者阅读我的故事吗?
  • 句子中的所有创意是否井井有条?
  • 我的段落是否适当安排?

风格指南是一项开放式练习

像公司文化或客户服务保存的答复一样,您的风格指南将永远不会完成。

随着您逐渐了解客户,从学生那里获得反馈并受益于加入团队的专业作家的经验,您将完善本文档并进一步阐明公司的声音。