iT邦幫忙

2024 iThome 鐵人賽

DAY 17
0
IT 管理

數位產品PM的開發小抄本系列 第 17

[Day17]_數位產品PM的開發小抄本_The Documentation System資訊解釋Explanation

  • 分享至 

  • xImage
  •  

在這一個階段,即是將要說明詳實特定範圍的內容,擴大問件內容討論的範疇及細節,可以採以易於閱讀理解的方式進行撰寫,以利於閱讀對於特定主題想要更深入了了解,且可以做討論對話使用。

撰寫Explanation資訊解釋內容的注意事項

  • 以理解做為導向,內容可以做深入討論使用,可以採話語性用字進行撰寫。
  • 可以採以更高的層次,不同的角度來詳實說明相關主題內容;可想像平常生活閱讀討論文本內容,而不是閱讀技術文件內容的方式撰寫。
  • 主題採以大範圍領域來定義的,因此討論主題的劃分可以採以好理解主題角度進行分類。從多個角度分析、考慮事物。說明解釋為什麼現階段採用這樣方式進行,已可描述評估過糟糕或晦澀難懂的替代方案,以利於閱讀者了解脈絡
  • 該階段目的是將知識並使其更加豐富,即使它不是我們可以隨時隨地會應用實際的知識,但是可以讓整個脈絡更為清楚。
  • 可以在日常生活中也可以容易閱讀的內容。閱讀者是人,也許不需要知道為什麼以某種方式做事,但知道該內容,很可能會帶來一種滿足感和舒適感,使閱讀者成為產品的更快樂的使用者。

如何寫出好資訊解釋Explanation:

  • 提供上下文的脈絡內容:

    • 說明為什麼現行會這樣發生的過程,可以包含設計決策、歷史原因、技術限制。
  • 提供討論替代方案和意見

    • 說明可以考慮有什麼樣的替代方案,或對相同問題可採取多種不同解決方法。
  • 不要指導或提供技術參考

    • 資訊解釋,不是指導用戶該如何做某事。

    • 不應提供技術描述,因為整個文件中,已有其他階段處理該內容。

Take away

資訊解釋其主要的目標是可以讓閱讀者輕鬆地了解到,某一個主題的前因後果脈絡,但實際上可能執行也無法完成詳實紀錄,但可保持的原則是讓閱讀者可以了解脈絡,作為對話討論使用。

應避免把其他技術性指導內容,也在這階段內容重複說明,可避免資訊不同,且閱讀者較不好集中於內容目標上。

資訊解釋內容採以主題性的概念進行撰寫,包含當時的決策、原由、限制,來說明現在的方案是目前最合適方案。


上一篇
[Day16]_數位產品PM的開發小抄本_The Documentation System關鍵元件參照說明Reference
下一篇
[Day18]_數位產品PM的開發小抄本_預想情境
系列文
數位產品PM的開發小抄本30
圖片
  直播研討會
圖片
{{ item.channelVendor }} {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

1 則留言

1
Leodaddy
iT邦新手 3 級 ‧ 2024-10-01 08:47:32

上下文的脈絡這真的是重點,之前遇過寫到最後文具不通,使用者看越看越confuse @@

byxblife iT邦新手 5 級 ‧ 2024-10-02 23:21:52 檢舉

以前的前輩說,如果我寫的SPEC連一個剛入職一週的人都可以理解,那就成功一半了

Leodaddy iT邦新手 3 級 ‧ 2024-10-03 09:18:25 檢舉

沒錯!!!

我要留言

立即登入留言