有關如何建立和管理產品文件的逐步指南 | 產品管理#31

已發表: 2023-10-02
產品管理不僅僅是創造新功能或優化現有功能。 這還包括創建產品文檔，這對於用戶有效使用產品並解決他們可能遇到的任何問題至關重要。 那麼這樣的文檔應該包含哪些內容呢？ 閱讀我們的文章並找出答案。

產品文件 - 目錄：

  1. 什麼是產品文件？
  2. 如何建立產品文件？
  3. 發布和分發產品文檔
  4. 概括

什麼是產品文件？

產品文件是描述產品、其功能、使用方式以及其他相關細節的文字、視覺效果和影片的集合。 建立文件的主要目的是幫助使用者了解如何使用產品，尤其是其高級功能。

文件非常重要，尤其是當您創建的數位產品不僅可以為最終用戶提供服務，還可以與其他產品整合時，例如，允許您將資料匯出到另一個應用程序，或使用本地化或聯絡人資料庫。

例如，專案管理工具的文件可能包括有關如何建立新專案、如何將團隊成員新增至專案並授予他們僅更改某些任務的權限、如何同時將任務指派給多人以及如何追蹤他們的進度。

產品文件的要素

產品文件可能包括：

  • 使用者手冊– 提供有關產品功能、安裝、設定和故障排除資訊的文件。
  • 使用者指南– 解釋如何使用產品執行各種任務的文檔，例如如何使用照片編輯程式或如何玩電腦遊戲。
  • 知識庫－回答常見問題或提供有關產品的附加資訊的文章或網頁的集合。 一個例子是網站上的「幫助中心」或「支援」部分。 它也經常被用作幫助客戶的聊天機器人的資訊來源。
  • 常見問題– 有關產品的常見問題和解答清單。 例如，包含以下問題答案的網站或 PDF 文件：“如何重設密碼？”、“如何聯絡客戶支援？” 或「產品的系統需求是什麼？」。
  • 教學– 通常發佈在公司網站或 YouTube 上的視頻，示範如何使用產品或執行某些任務。
  • 圖表和資訊圖表－產品結構、功能或流程的圖形表示。 例如，該圖顯示了配置 API 時要選擇的選項。

如何建立產品文件？

了解目標受眾

建立產品文件的第一步是了解該特定文件的目標受眾。 回答下列問題：

  • 誰將使用該文件？ – 是初次使用者還是更進階的使用者？
  • 用戶什麼時候會存取該文件？ 他們是否正在尋找有關該工具功能的一般或額外信息，或者特定問題的解決方案？
  • 他們將在什麼設備上使用它？ 如果是行動設備，影片夠清晰嗎？
  • 他們的需求和期望是什麼？ 用戶喜歡觀看動態影片還是圖表？

一旦您了解了您的受眾及其需求，您就可以開始建立文件。 例如，如果您的目標群體是新手用戶，則文件應該可以在每個步驟中訪問，並以簡單、易於理解的語言編寫，並包含詳細的說明。

請記住，組織良好的文件不僅可以幫助使用者了解產品，還可以節省他們尋找問題答案的時間。 這可以減少客戶流失率，也就是客戶停止訂閱服務的百分比。

清晰的溝通

建立有效的產品文件不僅涉及選擇正確的溝通形式（例如影片、視覺效果、知識庫），還涉及清晰簡潔的寫作和溝通。 產品文件中有效溝通的基本原則如下：

  • 使用簡單的語言－避免技術語言和複雜的術語。 例如，您可以說“開始一個專案”，而不是說“啟動一個專案”。
  • 具體– 提供範例來幫助使用者了解如何使用該產品。 例如，不要說“允許您將團隊成員添加到專案中”，而是說“通過單擊專案管理頁面底部的綠色按鈕將團隊成員添加到專案中”，並添加帶有視覺線索的螢幕截圖。
  • 避免被動語態－主動語態更容易理解和閱讀。 例如，不要說“經理可以啟動該專案”，而是說“經理可以啟動該專案”。

還有許多其他原則需要遵循，但最重要的是要記住，有效的產品文件應該是使用者可以理解的，並幫助他們有效地使用產品。

在產品文件中使用視覺效果

影像、GIF、短影片、圖表和資訊圖表等視覺效果可以大大提高對產品文件的理解。 例如，顯示「新增團隊成員」按鈕在頁面上的位置的螢幕截圖對於初次使用者來說可能非常有幫助。 建立文件時，還可以使用清晰的標題和簡單的字體來組織文字。

更新和維護產品文檔

產品文檔不是靜態文檔。 它必須定期更新以反映產品的變化。 定期更新對於文件實現其目的至關重要。 例如，如果您要向產品管理軟體引入新功能，則應更新其產品文件來解決該問題。

發布和分發產品文檔

發布和分發產品文件與建立產品文件同樣重要。 您需要確保使用者可以輕鬆存取您的文檔，無論他們身在何處或使用什麼設備。 例如，您可以將產品文件上傳到您的網站，或透過電子郵件直接傳送給使用者。

產品經理的頂級文件管理系統

產品經理可以使用許多工具來幫助他們建立和管理產品文件。 流行的解決方案包括：

  • Google Docs是一項基於雲端的服務，用於建立和編輯文件。 它是產品經理常用的工具，因為您可以在任何裝置上存取它，並且可供多個團隊成員使用。
    • product documentation
  • Firmbee是一款全面的專案和團隊管理工具，可讓使用者在世界任何地方即時完成任務。 產品經理可以輕鬆地組織自己和同事的工作、追蹤進度、控制預算並進行招募流程。
    • product documentation
  • Notion是一個任務和專案管理應用程序，可用於追蹤任務、筆記和文件。 Notion 是產品經理的一個流行選擇，因為它靈活且可以客製化。
    • product documentation
  • Zendesk Guide是一種客戶服務解決方案，可用於建立和分享知識庫文章。 Zendesk Guide 是產品經理的熱門選擇，因為它允許他們提供支援並幫助客戶解決問題。
    • product documentation
概括

建立和管理產品文件是一項經常被低估的任務。 許多數位產品開發人員認為，設計良好的產品是不言自明的。 然而，產品文件不應只是使用者指南。

它也應該是一個可以幫助提高客戶對產品的認知度並分析他們對新功能的興趣以及特定文章或解釋的瀏覽量的工具。 此類分析有助於公司更好地管理其產品並改善用戶體驗。 因此，值得花費時間和精力來建立可以為您和您的使用者服務的有效產品文件。

如果您喜歡我們的內容，請在 Facebook、Twitter、LinkedIn、Instagram、YouTube、Pinterest、TikTok 上加入我們的忙碌蜜蜂社群。

A step-by-step guide on how to create and manage product documentation | Product management #31 andy nichols avatar 1background

作者：安迪‧尼科爾斯

具有 5 個不同程度和無盡動力儲備的問題解決者。 這使他成為完美的企業主和經理。 在尋找員工和合作夥伴時，開放性和對世界的好奇心是他最重視的特質。

查看所有帖子

產品管理：

  1. 產品管理簡介
  2. 產品經理的角色是什麼？
  3. 為什麼產品生命週期管理很重要？
  4. 如何制定高效的產品策略？
  5. OKR 與 SMART 目標。 哪個框架可以帶來更好的結果？
  6. 如何定義價值主張？
  7. 識別客戶需求和市場區隔
  8. 打造制勝的產品概念。 技巧和步驟
  9. 透過有效的產品路線圖獲得優勢
  10. 製作您的數位產品原型
  11. 如何打造 MVP？
  12. MVP vs MMP vs MMF。 產品開發的關鍵里程碑
  13. 掌握假設檢驗
  14. 改善產品品質管理的行之有效的方法
  15. 成功產品發布的策略和策略
  16. 透過產品優化提高獲利能力
  17. 衡量產品成功
  18. 如何為產品定價？ 最受歡迎的定價策略
  19. 產品設計的未來。 熱門趨勢和預測
  20. 何時退役產品？ 影響 EOL 決策的關鍵因素
  21. 敏捷的產品管理
  22. 產品管理中的 Scrum 和看板。
  23. 什麼是精實產品管理？
  24. 待完成的工作。 創造顧客真正需要的產品
  25. 什麼是成長駭客？
  26. 什麼是數據驅動的產品管理？
  27. 產品管理中的 A/B 測試
  28. 有用的產品管理範本。 哪裡可以找到他們？
  29. 產品管理中的 Strategyzer 工具
  30. 5 個有用的產品管理工具
  31. 如何建立和管理產品文件？