產品經理|高效產品文檔撰寫指南
Baklib
關注
2022-09-29 17:42
585次閱讀
對于企業而言，如何推銷自己的產品，是一個很重要的問題，而建立一個公司的產品小冊子是必不可少的，這對品牌的宣傳很有幫助，尤其是那些大公司，更是如此。因為它能更全面地展示產品，能寫出一個合理而高效的產品文件，讓顧客對產品有更多的認識，顧客也能理解公司的工作方式。
提供高質量，快速，預判性好的產品。
產品文件是怎樣幫助您有效率地完成這些工作的？
1.一開始就進行合理的思想
在開發團隊花更多的錢來設計工具架構，執行代碼開發，完善界面設計，測試工具質量之前，編寫文檔會讓你對每個細節都有更多的想法。這樣可以提升你的決定品質，減少不希望發生的事情。
2.有效的交流
你經常要與各種利益有關者進行交流（支持、工程、設計、金融、管理等）。產品文件能讓你在交流過程中事半功倍，避免在口頭交流中出現模棱兩可的情況，而且整個團隊成員都能更好的了解你的意圖，更有針對性地作出回應。
3.權力和義務的劃分
明確項目目標評估的標準，并向社會公布獎勵和懲罰，各利益攸關方都知道在最后關頭更改要求意味著什么，工程師也會仔細考慮。
產品文件應當清楚地傳達出要制作“什么”的產品和“為什么”。有很多種方法可以用來解釋一個產品，重要的是，要把這五個方面都說清楚：
- 問題。請說明常見問題，并說明為何要處理此問題。說明應盡量詳細，并提供有關的資料。
- 可測量的目標清楚地表明了對實現和結果的承諾，并清楚地表明了什么是超越了該計劃范圍之外的。每個目標都要能清楚地測量“是否達成”。
- 需求情境能讓聽眾了解目前的問題，并能接受你的建議。包含假設，用例，數據指標等，但不限于此。
- 解決方案細節您的建議應包含足夠詳細的細節，便于小組成員容易理解和實施。
- 時間軸，列出你的小組一致同意的Dead line和其它關鍵時刻。這一節的開頭也許不太清楚，但應該在文件審查前完成。
上述五個要點對產品文件的內容覆蓋至關重要。
只要項目順利推進，工程師和產品經理之間的交流就會大大降低，這就是一個好的產品文檔。
1.產品的邏輯性和條理性
產品文檔必須要有條理，要有條理，要有一個完整的體系，要有一個完整的體系，然后才能有一個完整的體系。
2.避免在產品功能方面出現遺漏
比如說，會不會影響到其它的模塊？異常流的說明，邊界條件等。
3.文件易于閱讀
能用圖來形容的肯定會覺得太麻煩了，用流程圖、例圖、時序圖等來描述你的產品，如果是非常詳細的互動，給開發人員提供一個高逼真的模型。
1.盡可能短
在文檔撰寫方面，沒有什么更重要的建議。簡明的意思是清楚的思想和交流，同時也表示你的文件更容易讀懂-這是非常關鍵的。
2.采用普通的語言和簡潔的形式
用短而非華麗的句子，用清單和突出的重點來讓你的文章更加清晰，讓你的文章看起來輕松愉快，不要一成不變。
3.將時間留給開發小組
只有經過審核和同意的文件才算是完整的文件。如果您想要在以后的某個迭代式 Sprint中開發這個項目，那么您應該在2-3個星期之前就開始編寫該產品的文件。
4.以工程師的思維方式
當一個項目開始發展的時候，經常會遇到很多意想不到的問題，但事實上，這是可以避免的。如果您仔細地思考了項目的全部需要，那么您就可以預先了解到這些問題（比如，您的手機上有沒有互聯網聊天？）。
5.保證每個人都能跟上你的步伐
在我安排產品審核的時候，大多數人都對我要說的話有了一個大概的概念，因為我在研討會上和每天的閑聊中都談到了這件事。既然大家都明白了“要做什么”和“為什么要做”這個問題，那么在文件評審中，我們只需要把重點放在執行的細節上。
6.處理圖表
流程圖、線框圖等可以用簡單易懂的方法來提供大量的信息，但是在繪制圖表的過程中會花費大量的時間。
7.花費0.5-3天的時間來考慮和撰寫文件
具體的時間取決于項目的規模。你在編寫文件上花的時間越多，你得到的好處也就越少。尤其要注意的是，沒有人可以閱讀5到6頁以上的文件。
8.明確目標和明確遠景
你不僅要給一個功能下定義，還要說明“我們為什么要這么做”和“我們要達到什么目的”，要在文件里說明該計劃對更高層次的計劃有何影響，還有后續的發展。
9.確定讀者已經看過文件
如果你的文件很難看，很長，或者從不與別人共享，那么你最好不要把它寫出來。一定要保證你的文件已經被相應的人看過，我在前面提到的，在審核的時候要有足夠的時間來讀這些文件，這是一個很好的參考。
10.獲得真實的回饋
你的文件是要追蹤眾所周知的東西嗎？還是缺少詳細的文件？在隨后的執行過程中，有沒有出現過多的邊界情形？還是說，你花了很多時間來做規劃和審核文件？你必須在任何時候都與你的團隊進行交流。
上面的十個小貼士可以幫助你編寫有效的、實際的產品文件，如果你有基本的寫作技巧。
市面上有很多文檔編寫工具，但是 Baklib是一個很受歡迎的工具。
Baklib是一個在線的文字編輯與主機，它可以為企業用戶提供 FAQ幫助文檔，也可以編寫知識庫，產品文檔，幫助中心，發行說明。
為熱愛寫作的讀者，可以寫日志、寫日志、寫自己的日志，功能非常棒！獨立的域名、多個模板，可將創意內容按照模板引導成不同的美觀界面，讓內容共享更加便捷，更利于建立個性化的品牌口碑。
- 容易編輯，有條理
- 豐富的主題模板，清晰的顯示界面，多終端的適應性
- 全文本檢索
- 可以綁定獨立的域名，打造一個專門的公司站點，支持 SEO。
- 不需要下載，可以在后臺編輯和存儲，可以直接實時顯示，維護費用低廉
- 還可以用作團隊知識庫，在線產品說明書等。
現在的企業，文檔的編寫非常的重要，而不是過去那種沒用，浪費時間的東西。希望上面的內容能對你有所幫助。
Baklib
+
關注
0
