產品經理必看的高效產品文檔撰寫指南
Baklib
關注
2022-03-24 14:24
522次閱讀
對于企業來說，如何推廣自己的產品是一個非常重要的話題，而其中必要的就是創建企業產品宣傳冊，這對于產品宣傳非常重要，尤其是一些大公司，非常重視這種產品展示方式。因為它可以更完整地展現產品，撰寫一份合理有效的產品文檔，讓客戶了解產品，客戶甚至也可以了解企業的工作風格。
為了以更高的質量、更快的速度和更佳的預判來交付正確的產品。
產品文檔如何幫助你高效地做到這一切呢？
1.從一開始就理性思考
在團隊開始付出更高成本去設計軟件架構、實施代碼開發、完善界面設計、測試軟件質量之前，寫文檔可以迫使你提前思考每一個細節。這將會提高你決策的質量，降低意外事件發生的概率。
2.高效溝通
你常常需要和不同的利益相關方（支持團隊，工程團隊，設計團隊，財務團隊，管理層等等）溝通你的方案。產品文檔可以幫助你事半功倍地完成溝通，避免口頭溝通中產生的歧義，團隊中的所有人可以更好地理解你的意圖，并且更有的放矢地做出答復。
3.明確權責
明確項目目標的評價標準，公開承諾獎懲激勵機制：利益相關方可以知曉如果最后一刻變更需求會意味著什么，工程師們也會在預估工期時再三斟酌。
產品文檔應該明確溝通要做一個「什么」產品，以及「為什么」要這么做。用來說明清楚一個產品的表達方式很多，但最核心的，一定要說清楚這五件事情：
- 問題描繪你此次打算解決的問題。更重要的是，解釋為什么要去解決這個問題。描述要盡可能地具體，并且提供相關的數據指標。
- 可衡量的目標明確承諾交付和成果，明確哪些事情超出了此項目的范疇。每一個目標，都應該可以明確衡量「是否達到目標」。
- 需求背景提供你的觀眾理解當前問題以及接受你的提議所需的所有背景信息。包括但不限于假設、用例、數據指標等信息。
- 解決方案詳情你的提議應該有充足的細節，易于團隊成員消化理解及執行——可以把這部分內容想象成對人腦進行編程和執行。
- 時間軸列出你的團隊共同認可的截止日期和其他重要時間點。這部分內容開始的時候可能會比較模糊，但是在最后一次文檔評審之前應當完全敲定。
對于產品文檔的內容涵蓋來說，以上五點是必不可少的。
只要能夠順暢推動項目前進，在產品開發和測試過程中能夠大幅度減少工程師和產品經理反復溝通的文檔，就是優秀的產品文檔。
1.產品邏輯要清晰且流暢
產品文檔的內容要前后一致，邏輯通暢，這也是最基本的,要秉承先整體后局部的原則，先要從全局去定義整體的產品邏輯，再去逐步分解細節。
2.避免產品功能的疏漏
比如會不會對其他模塊產生影響？異常流程的描述，邊界情況等。
3.文檔的可讀性要強
能用圖描述的一定嫌麻煩用文字，多用流程圖、用例圖、時序圖等去描述你的產品,在涉及到很細 節的交互時，最好將相關功能做出高保真原型圖供研發人員參考。
1.盡量簡短
沒有比這更重要的文檔寫作建議了。簡潔意味著清晰的思路和溝通，也意味著你的文檔更加易于閱讀和理解——這一點至關重要。
2.使用平白的語言和簡單的格式
使用簡短而不是花哨的語句，使用列表和加粗強調可以使文章更一目了然，以放松有趣的方式寫作而不是一板一眼，如果你有得體的幽默感就再好不過了。
3.為開發團隊預留時間
通過評審并且達成一致通過的文檔才是完善的文檔。如果你希望在未來的某一個迭代 Sprint 中開發此項目，就應該提前兩到三周開始這個產品文檔寫作流程。
4.像工程師一樣思考
在項目得以進入開發之時，常常會發現大量未預料到的邊緣情況——但這種情形其實可以避免。如果你認真考慮過項目進入開發的所有必要條件，你就可以提前發現這些問題（例如，是否在移動設備中可以使用在線聊天功能？）。
5.確保每一個人都跟上了你的節奏
當我組織產品評審時，會議室里的大部分人都已經大致了解我要講的內容——因為我已經提前在討論會和日常聊天中溝通過這個事情了。既然大家都已經清楚了「做什么」和「為什么要做」的問題，文檔評審會上我們只要關注實施細節就好了。
6.在圖表中下功夫
流程圖、線框圖等圖表可以通過易于理解的方式提供很大的信息量，但同時也需要消耗非常多的時間來制作這些圖表。
7.在思考和寫文檔上花 0.5-3 天時間
具體時間根據項目大小而定。花費在寫文檔上的時間越長，所帶來的邊際收益就會遞減。特別需要指出的是，沒有人能夠讀的下去超過 5-6 頁的文檔。
8.指明方向，明晰愿景
你不僅僅是在定義一個功能，也是在解釋「為什么我們要做這件事情」以及「我們的目標是什么」，在文檔中指出這個項目將會對更高層面的規劃造成什么影響，以及接下來會發生什么。
9.確保你的觀眾閱讀了文檔
如果你的文檔又臭又長，或者從來不分享給對應的人，那你還不如不寫文檔。務必確保你的文檔被對應的人閱讀了，我上面關于評審開始時留時間給大家讀文檔的建議值得大家參考。
10.獲取真誠的反饋
你的文檔是否是在贅述人盡皆知的事情？或者是文檔缺乏足夠的細節？是否在后續實施中發現了太多的邊緣情況？又或者，是否在制定計劃和文檔評審上耗費了太多的時間？你應該和你的團隊時刻保持溝通。
如果你已經掌握了基礎的產品文檔撰寫技能，那么以上十條建議就能夠為你寫出高效實用的產品文檔提供指南。
市面上的文檔撰寫軟件并不少，但這里比較推薦Baklib，一款小眾的文檔編輯軟件。
Baklib是一款在線的文本編輯和托管的工具，對于企業用戶不僅可以制作FAQ幫助文檔，還可以編寫知識庫、產品文檔、幫助中心、發行說明。
對于愛好寫作的用戶來說，可以編寫日記手帳和個人博客，功能超級贊！獨立域名，多種模板支持將創作的內容按模板導成各種漂亮的界面，使內容分享更方便，更有利于個人品牌口碑的形成。
產品評價
- 易于編輯，結構清晰
- 豐富的主題模板，展示界面清晰簡潔，多端適配
- 全文檢索，搜索
- 可綁定獨立域名，做企業專屬網站，支持seo
- 在線使用，無需下載，后臺編輯保存，前臺直接同步展示，運維成本低
- 也可以用來作為團隊知識庫、在線產品說明書等
現如今產品文檔的撰寫對于企業來說格外重要，不再是以前人們口中“無用又浪費時間金錢”的事了。所以寫好產品文檔只是關鍵，希望以上內容能給你一定的啟發。
Baklib
+
關注
0
