跳到內容
登入免費開始寫
Bookeen

操作指南電子書

撰寫操作指南,是為了幫助讀者完成一項具體任務。先講清楚成果,再按可行的順序展示步驟,並說明如何判斷每一步是否成功。

免費開始寫你的書

什麼是操作指南電子書?

操作指南是一部圍繞「動手做」組織起來的方法類書籍:建立一套流程、學習一項實用技能,或完成一個專案。每一章都應讓讀者更接近所承諾的成果。背景知識放在有助於判斷的地方,排錯放在讀者可能卡住的那一步附近。

操作指南應該如何組織步驟?

操作指南應按照讀者必須執行的先後順序來安排動作。先說明起始條件,再描述動作,並展示如何檢查成果。多步驟流程要編號,讓讀者知道自己進行到哪一步。

A procedure is a sequence of numbered steps for accomplishing a task.

譯文: 所謂流程,就是為完成一項任務而排列的編號步驟。

Google 開發人員文件風格指南,Procedures
  • Google 的流程指引建議:單一步驟的流程用一句話加一個項目符號,而不是只含「1」的編號清單。
  • 對於包含兩個以上動作的流程,要把有順序的步驟與無序的材料或選項清單區分開。
  • 在這個 Bookeen 工作坊範例中,使用三個檢查點:確認受眾、核准活動方案、檢查材料。這個數字屬於本範例,而不是每一份操作指南。

用 Bookeen 從你的流程筆記發展出章節順序。然後親自執行這些說明,或請合適的讀者試一遍;看起來清楚的編號步驟,並不能證明流程真的可行。

來源查核 .

何時選擇這種書籍類型

  • 當讀者需要一套可重複的流程時,選擇操作指南。
  • 先界定讀者已經知道什麼,以及開始之前還需要什麼。
  • 如果練習和書面作答承擔了大部分價值,就改用練習本。

實用大綱

  1. 說明成果和起始條件。
  2. 彙整材料、資訊或前提條件。
  3. 用一個貫穿全書的範例走完各個步驟。
  4. 檢查成果、排解問題,並規劃下一步。
範例

一份規劃第一場社區工作坊的指南

跟著一位主辦者,從模糊的主題走到一份可行的活動方案。談受眾的那一章確認誰應該參加;下一章把這些受眾轉成學習目標,再轉成議程和材料清單。讀者可以拿自己的決定與這個貫穿全書的範例對照,不必在每一章都從頭開始。

操作指南應該寫給誰看?

操作指南應該針對一位明確定義的讀者,並從一個清楚的起點出發。動筆之前先定義讀者。專業術語在使用它的地方解釋,不要因為自己熟悉這個主題就隨意增加章節。

  • 一開始就說明前提條件。
  • 把必要步驟和可選的改進分開。
  • 讓成果可以被觀察到。

檢驗操作說明

一份指南讀起來可能很清楚,卻漏掉了關鍵動作。像讀者那樣把整個流程走一遍。對照工具或畫面的目前行為,檢查步驟之間的相依關係、範例以及所有引用。

  • 同一個動作始終使用一致的名稱。
  • 在關鍵步驟之後加上檢查點。
  • 說明常見錯誤和補救方式。

在 Bookeen 中建立草稿

把受眾、成果和流程筆記交給 Bookeen。用這些輸入先發展出大綱,再逐章檢查是否遺漏步驟。你的經驗和查核,才讓這些說明真正有用。

  • 讓一個範例貫穿整份指南。
  • 用具體的決定和行動取代空泛的建議。
  • 在準備讀者檔案之前,通讀整個流程。

比較書籍類型

讀者、檔案與下一步

探索一個相關的寫作情境,然後選擇適合你讀者的版本。

探索 Bookeen 書籍創作工具

操作指南電子書:常見問題

操作指南和練習本有什麼不同?

操作指南說明一套流程;練習本給讀者空間和提示去實踐它。兩者可以結合,但應讓其中一種主導結構,讀者才知道是照著做,還是完成練習。

每一章都需要一樣長嗎?

不需要。給每一步足夠的說明,讓它可用即可。複雜的決定可能需要替代方案和一個範例;簡單的動作也許只要一句簡短說明和一次檢查。

操作指南應該包含排錯內容嗎?

應該,前提是你找得到真正的失敗點。在相關步驟附近說明症狀、可能的原因和下一步。不要為了把一章寫長而編造問題。

可以把我現有的文章改寫成一份指南嗎?

可以,但要把它們改寫成一條連貫的流程。刪掉重複的引言,補上步驟之間的缺口,並保持術語一致。一份有用的指南需要一段連續的閱讀旅程,而不只是文章的合集。

應該選擇哪種檔案格式?

EPUB 適合讀者會在不同螢幕上調整大小的文字;PDF 保留固定的版面。修訂期間保留一份可編輯的書稿,對外分享前先檢查匯出的版本。

把你的經驗變成清楚的步驟。

在 Bookeen 裡圍繞一個有用的成果、一套實用的流程和讀者能跟上的範例,做出你的操作指南。

免費開始寫你的書

簡單的月付方案隨時取消一切都歸你所有