跳轉到內容

同儕教育手冊 V1.0/風格指南

來自華夏公益教科書,開放的世界,開放的書籍

同儕教育手冊 v1.o 真的救了我的命。謝謝。

保持簡短

[編輯 | 編輯原始碼]

最容易閱讀的部分是那些比較短的,包含一些視覺效果(影片或影像),並具有一定的個人聯絡(例如,它們講述了一個故事)。對於任何較長的部分,請將其分解成子頁面,新增視覺效果,確保每個子頁面都對某個人(誰是目標讀者?)易於理解。清晰地思考這個讀者,與他們交談。

清晰明瞭

[編輯 | 編輯原始碼]

我們將透過示例說明這一點。本書的最初完整標題是“同儕教育手冊:自組織自學者的資源”。但是,“自組織”是一個技術術語,“自學者”是一個令人困惑的新詞。除非我們解釋它們,否則我們不應該使用技術術語。因此,我們不應該在本書的第一句話或段落或標題中使用它,因為我們會嚇跑或迷惑人們。如果我們想解釋“自組織”的含義以及它與同儕教育的相關性,那麼我們可以花一章時間在書中較後的部分進行詳細說明。同時,我們也不應該試圖“用更簡單的方式表達同樣的事情”。我們應該嘗試完全擺脫技術概念,看看剩下什麼。在這種情況下,最簡單的方法是完全刪除這句話並重新開始:如有疑問,請直白地說。

不要過度使用專案符號

[編輯 | 編輯原始碼]

也許這只是一個“個人怪癖”,但我發現當包含多個專案符號時,文字非常難讀。對我來說,將專案符號替換為編號列表(仍然應該謹慎使用)效果更好。似乎當出現許多不連貫的專案符號時,作者實際上只是在索引其他人的敘述中更好地呈現的主要要點。因此,考慮用對其他人的書籍/網頁/章節的引用來替換整個專案符號列表。在當今的超連結世界中,讀者很容易去其他地方獲取好的內容(事實上,我們應該讓他們更容易找到最好的內容!)。特別是,閱讀分類法並不完全令人愉快。如果需要,也許可以將這類內容移到附錄中。

包含活動

[編輯 | 編輯原始碼]

在今天的生活會議中,我們一致認為,活動並不能神奇地解決所有可能的使用/可讀性問題,但它們仍然很有用。根據我們的頁面佈局,每個章節都應該至少包含一項活動(從側邊欄連結)。因此,在閱讀本書時,請注意可以包含的任何活動。(也請注意,不會透過新增活動解決的問題!)

不要過於口語化

[編輯 | 編輯原始碼]

在我們努力擺脫學術語言,簡化手冊中的文字時,務必確保我們沒有走向另一個極端——過於口語化。當我們與某人交談時,我們傾向於在想法中加入過渡性或關鍵性短語(“無論如何”、“話說回來”、“正如我在其他地方提到的”等),這有助於保持談話流暢。我們也會偏離主題,然後回到主要話題,有時還會用長句表達自己。雖然這在口語中是完全正常的,但當被閱讀(在我們的手冊或其他地方)時,可能會令人困惑和複雜。讓我們意識到我們的受眾,並努力在我們的寫作中達到簡單而專業的完美平衡。

額外的風格加分項

[編輯 | 編輯原始碼]
  • 避免在段落後使用雙空格;這是打字機時代的遺留問題,會導致空白處出現“河流”。
  • 將專案符號列表中每個專案的第一個單詞大寫,特別是如果專案包含動詞形式(本列表和上面的列表就是例子!)。
  • 將標題和副標題的第一個單詞大寫;其他單詞全部小寫。
華夏公益教科書