跳到內容
登入免費開始寫
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 裡圍繞一個有用的結果、一套實用的流程和讀者能跟上的範例,做出你的操作指南。

免費開始寫你的書

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