同侪教育手册 V1.0/风格指南
同侪教育手册 v1.o 真的救了我的命。谢谢。
最容易阅读的部分是那些比较短的,包含一些视觉效果(视频或图像),并具有一定的个人联系(例如,它们讲述了一个故事)。对于任何较长的部分,请将其分解成子页面,添加视觉效果,确保每个子页面都对某个人(谁是目标读者?)易于理解。清晰地思考这个读者,与他们交谈。
我们将通过示例说明这一点。本书的最初完整标题是“同侪教育手册:自组织自学者的资源”。但是,“自组织”是一个技术术语,“自学者”是一个令人困惑的新词。除非我们解释它们,否则我们不应该使用技术术语。因此,我们不应该在本书的第一句话或段落或标题中使用它,因为我们会吓跑或迷惑人们。如果我们想解释“自组织”的含义以及它与同侪教育的相关性,那么我们可以花一章时间在书中较后的部分进行详细说明。同时,我们也不应该试图“用更简单的方式表达同样的事情”。我们应该尝试完全摆脱技术概念,看看剩下什么。在这种情况下,最简单的方法是完全删除这句话并重新开始:如有疑问,请直白地说。
也许这只是一个“个人怪癖”,但我发现当包含多个项目符号时,文本非常难读。对我来说,将项目符号替换为编号列表(仍然应该谨慎使用)效果更好。似乎当出现许多不连贯的项目符号时,作者实际上只是在索引其他人的叙述中更好地呈现的主要要点。因此,考虑用对其他人的书籍/网页/章节的引用来替换整个项目符号列表。在当今的超链接世界中,读者很容易去其他地方获取好的内容(事实上,我们应该让他们更容易找到最好的内容!)。特别是,阅读分类法并不完全令人愉快。如果需要,也许可以将这类内容移到附录中。
在今天的生活会议中,我们一致认为,活动并不能神奇地解决所有可能的使用/可读性问题,但它们仍然很有用。根据我们的页面布局,每个章节都应该至少包含一项活动(从侧边栏链接)。因此,在阅读本书时,请注意可以包含的任何活动。(也请注意,不会通过添加活动解决的问题!)
在我们努力摆脱学术语言,简化手册中的文本时,务必确保我们没有走向另一个极端——过于口语化。当我们与某人交谈时,我们倾向于在想法中加入过渡性或关键性短语(“无论如何”、“话说回来”、“正如我在其他地方提到的”等),这有助于保持谈话流畅。我们也会偏离主题,然后回到主要话题,有时还会用长句表达自己。虽然这在口语中是完全正常的,但当被阅读(在我们的手册或其他地方)时,可能会令人困惑和复杂。让我们意识到我们的受众,并努力在我们的写作中达到简单而专业的完美平衡。
- 避免在段落后使用双空格;这是打字机时代的遗留问题,会导致空白处出现“河流”。
- 将项目符号列表中每个项目的第一個单词大写,特别是如果项目包含动词形式(本列表和上面的列表就是例子!)。
- 将标题和副标题的第一個单词大写;其他单词全部小写。