[15]_數位產品PM的開發小抄本_The Documentation System操作指南How-to guides

撰寫How-to內容說明,注重可實現的步驟內容,不要讓其他內容分散注意力

在「The Documentation System」下一個循環內容就是操作指南How-to-guide,

這與前面的引導教學Tutorials比較不一樣的地方是「具體的隱討使用者完成解決實際問題」會比較像常見的FQA或User guide的內容模式

  • 說明文獻中點出兩者不同的之處
    • A tutorial is what you decide a beginner needs to know.
      引導教學是要讓初步使用者了解的內容
    • A how-to guide is an answer to a question that only a user with some experience could even formulate.
      How-to 說明是要基於有一定操作經驗的使用者才會想要知道內容或回答

撰寫How-to

提供一系列的步驟,提供一整個系列的需要執行步驟,不一定是要重頭開始,但是要有一整個情境的操作步驟。

How-to的內容要注重可實現的步驟內容,不要讓其他內容分散注意力,但是也不用做到非常詳盡的描述細節。

以「我如何…?」為開頭的情境開始,模擬使用者遇到類似的問題時,將要執行那些步驟可以完成問題。

需要一定的靈活性,如果使用者看的實際問題與實際描述的內容略有不同時,仍還是可以完成執行目標

在這階段可以忽略部分細節,How-to內容的實用性比完整性更具有價值。How-to內容需要完整步驟、點到點的操作說明,但是要避免過於臃腫的說明。

Take away

How-to的主要目標是讓使用者可以按照實際步驟執行,就可以解決問題,讓使用者一步一步的完成,解決問題。

但這階段並非要詳細解釋步驟內容,而是要點出明確步驟內容,就可以完成情境任務內容。

How-to維持靈活彈性,讓使用者在閱讀過程中,雖不是完全相同的內容,但是仍可以完成目標任務。


內容同步刊載於2024IT鐵人賽