如何寫出好的產(chǎn)品幫助文檔？

Baklib

+ 關(guān)注

2022-03-23 18:32

546次閱讀

如今，大多數(shù)軟件產(chǎn)品通過互聯(lián)網(wǎng)為用戶提供服務(wù)，在線文檔是最有效的客戶服務(wù)渠道，我們熟悉的開源軟件都配備了高質(zhì)量的在線文檔。

好的文檔是優(yōu)秀產(chǎn)品的標(biāo)準(zhǔn)配置，它不僅可以幫助你帶來更多的用戶，還可以幫助你為更多的用戶服務(wù)。作為一名互聯(lián)網(wǎng)程序員，如果你不知道如何寫一份好的技術(shù)文檔，你會不好意思向別人打招呼，更不用說制作好的產(chǎn)品了。

好文檔的評價標(biāo)準(zhǔn)

“不知道從何開始，找不到好的角度寫，寫什么內(nèi)容等等”，這都是我們經(jīng)常會遇到的情況，那么為什么會發(fā)生這種情況呢？通常沒有找到寫作的意義，如果它是為了交換差異，頭很容易卡住，思想無法擴(kuò)展。

所以在敲擊鍵盤之前，我們必須弄清楚這個文檔是誰寫的，以及通過這個文檔可以幫助讀者解決什么問題。寫作是我們輸出影響力的一種能力，它的最終目的是改變讀者的信息、行為或信仰，否則它將是一個無用的垃圾。在明確了目標(biāo)讀者和意義之后，我們的想法就會被打開。

在編寫文檔的過程中會遇到哪些常見問題？

通常我們習(xí)慣于詳細(xì)介紹產(chǎn)品的特點(diǎn)，具體如何安裝、配置和使用等，事實(shí)上，大多數(shù)潛在用戶是第一次接觸這些產(chǎn)品，他沒有完全了解我們的產(chǎn)品，不知道產(chǎn)品能幫助他解決什么問題，對他有什么價值，深入細(xì)節(jié)很容易讓潛在用戶。

說一個小故事，我記得研究生畢業(yè)后準(zhǔn)備防御幻燈片。導(dǎo)師教我們一些經(jīng)驗(yàn)：方御是向評委展示他們的研究成果，改變評委對這個研究項(xiàng)目的認(rèn)知，并對自己的印象，以獲得更高的分?jǐn)?shù)。幻燈片最好從Why開始，告訴評委這個研究項(xiàng)目的背景和意義。有了這個基礎(chǔ)，評委可能會對你的研究感興趣，并跟隨你了解一下What和How。

非功能特性依賴于功能特性。一個對用戶毫無價值的產(chǎn)品，即使它的非功能特性非常優(yōu)秀，也不會引起用戶的興趣。

文檔的開頭必須通過介紹產(chǎn)品或方案的價值與用戶建立聯(lián)系，讓他知道產(chǎn)品或方案與他的工作密切相關(guān)，這可以幫助他優(yōu)化工作。接下來是讓用戶知道什么是產(chǎn)品或方案，以及如何使用它。這實(shí)際上類似于軟件研發(fā)的過程。從用戶需求開始，首先分析和梳理用戶的痛點(diǎn)，然后設(shè)計產(chǎn)品來解決用戶的痛點(diǎn)，最后進(jìn)行開發(fā)和實(shí)現(xiàn)。

文檔目錄設(shè)計和用戶思維

當(dāng)我們明確了文檔的目標(biāo)讀者和可以為讀者解決的問題時，寫作本身就有了方向和價值，這樣我們就可以調(diào)動我們的身心和大腦，讓我們的文本思維涌動，這就是用戶的思維。在此基礎(chǔ)上，我們可以開始考慮文檔應(yīng)該包含什么，如何安排和設(shè)計目錄章節(jié)，以更符合用戶的學(xué)習(xí)規(guī)則。

文檔是我們的外部輸出產(chǎn)品，做產(chǎn)品學(xué)習(xí)同理心，從用戶的角度考慮他們需要什么樣的產(chǎn)品或方案，用戶在技術(shù)選擇中也首先確認(rèn)產(chǎn)品或方案是否有價值，等他認(rèn)識到價值將進(jìn)一步了解產(chǎn)品或方案的功能特點(diǎn)和使用方法。

如何幫助用戶獲得控制感或安全感？

全景視圖

全景視圖，讓用戶有上帝的視角，從整體上把握產(chǎn)品或方案，這個視圖不會包含太多的細(xì)節(jié)。就像穿過熱帶雨林到達(dá)一個地方，如果一端進(jìn)入森林，那么我們很容易迷路，最好爬上高地或樹冠，觀察整個森林，包括河流方向和地標(biāo)特征，掌握這些信息后我們會更安全，更確定走出森林。

全景視圖就像一個裝載信息的框架。我們應(yīng)該首先幫助用戶建立這個框架，然后向用戶介紹詳細(xì)的信息。此時，用戶可以將其存儲在框架的不同位置，因此他不會輕易迷路。因此，文檔的第一部分是產(chǎn)品概述，包括背景描述、功能定位和優(yōu)勢比較。

構(gòu)建演示環(huán)境

在對該產(chǎn)品有了全面的了解后，應(yīng)用程序架構(gòu)師的角色將構(gòu)建一個演示環(huán)境，以便對該產(chǎn)品有更感性的了解。在這個階段，他不需要對各種細(xì)節(jié)有特別全面或深入的了解，只需要知道如何以最簡單、最快的方式配置它，他可以在這個環(huán)境的幫助下向團(tuán)隊(duì)中的開發(fā)測試人員介紹該產(chǎn)品。因此，文檔的第二部分是快速介紹，主要是幫助應(yīng)用程序架構(gòu)師將對概念理論的理解轉(zhuǎn)化為一個真實(shí)的演示環(huán)境。

介紹產(chǎn)品特性的開發(fā)指南

通過以上兩部分，我們讓用戶知道該產(chǎn)品可以幫助他解決什么問題，以及它是如何工作的。接下來，將介入用戶的開發(fā)、測試工程師和其他角色。他們需要深入了解產(chǎn)品的功能特性和使用方法，以指導(dǎo)具體的編碼實(shí)現(xiàn)。

因此，文檔的第三部分是介紹產(chǎn)品特性的開發(fā)指南。不同角色的用戶對文檔有不同的需求，文檔章節(jié)目錄的設(shè)計應(yīng)符合上述順序。

監(jiān)控微服務(wù)

第四部分，除了知道如何使用本產(chǎn)品外，用戶還將關(guān)心如何在日常使用過程中操作和維護(hù)，是否有一些配套工具或管理控制臺，借助其監(jiān)控微服務(wù)的運(yùn)行，以及微服務(wù)的控制和治理。

梳理常見問題

第五部分，如何處理使用過程中遇到的問題，特別是一些非常頻繁的問題，這部分將梳理這些常見問題，方便用戶在遇到問題時咨詢。

1.產(chǎn)品簡介
2.快速入門
3.開發(fā)指南
4.操作指南
5.常見問題
6.經(jīng)典案例
7.歷史版本
8.下載說明

常用的文檔工具

文末再推薦一款可以日常寫作用的軟件工具：

Baklib是一款在線的文檔編輯及內(nèi)容分享工具，在操作習(xí)慣支持Word文檔常用全系編輯操作，任意插入表格、代碼塊、圖片、本地音視頻、在線多媒體、讓知識創(chuàng)作更加輕松。

產(chǎn)品需求文檔創(chuàng)作完成后，需要進(jìn)行內(nèi)部之間的查閱。使用Baklib在線制作的文檔內(nèi)容會自動轉(zhuǎn)化成網(wǎng)站，通過設(shè)置的url鏈接就能進(jìn)行訪問，訪問的過程中通過不同權(quán)限查閱的設(shè)置，可以有效的做到內(nèi)部資料的保護(hù)。

產(chǎn)品優(yōu)勢

簡單易操作

這款工具無需下載輸入網(wǎng)址就能在線使用（零試錯成本）。操作過程簡單，不需要有代碼基礎(chǔ)，會基礎(chǔ)的電腦操作就行。

支持Word文檔常用編輯操作，任意插入表格、代碼塊、圖片、本地音視頻、在線多媒體、使得幫助中心/知識庫搭建過程更為簡單。

結(jié)構(gòu)化文檔

提供了多級欄目和標(biāo)簽云的功能做到知識內(nèi)容的分層梳理，通過文檔大綱，自動生成文檔要點(diǎn)，讓多篇文檔結(jié)構(gòu)化，像書一樣清晰，使需求文檔通過結(jié)構(gòu)化布置更容易被理解。

可靠的數(shù)據(jù)

提供數(shù)據(jù)手動備份功能，用戶可以將線上數(shù)據(jù)保存到本地。開放api接口，通過接口的調(diào)用實(shí)現(xiàn)數(shù)據(jù)的快速導(dǎo)出導(dǎo)入。在內(nèi)容創(chuàng)作時具備歷史數(shù)據(jù)自動緩存功能，避免了錯誤操作帶來的數(shù)據(jù)丟失。