產品文檔終極指南：創建出色文檔所需的一切

產品文檔......它可能不是經營企業最性感的部分，但如果您希望您的企業成功，它是您不應該忽視的關鍵領域。

創建高質量的產品文檔可以幫助您使您的客戶更加成功，減輕您的支持負擔，並且通常可以建立更好的業務。

但是創建產品文檔需要什麼？ 以及如何在您的網站上設置自己的文檔？

這些只是我們將在產品文檔最終指南中回答的幾個問題。 這是我們將介紹的所有內容：

• 為什麼你應該關心你的產品文檔策略
• 一流文檔的一些真實示例
• 最好的產品文檔軟件
• 創建更好的文檔的八個技巧

您準備好改進您的企業處理文檔的方式了嗎？ 讓我們深入挖掘！

為什麼你應該關心你的產品文檔策略

讓我們先來看看為什麼您不應該吝嗇您的產品文檔策略。

它使您的客戶更成功

創建產品文檔的最大好處是它使您的客戶更加成功。 擁有更多成功的客戶意味著更高的轉化率、更低的流失率等等。

這是有道理的——如果客戶無法弄清楚如何從您的產品中獲得價值，他們將不會長期保持客戶身份。

產品文檔是教育客戶的一種有用方法，以便他們獲得盡可能多的價值。 當他們從您的產品中獲得更多價值時，他們將更有可能繼續付款，將您推薦給他們的朋友/同事等等。

它減少了您的支持負擔

產品文檔也是減輕人工支持渠道負擔的好方法。

如果您的產品文檔質量低下或不存在，這意味著您的客戶每次出現問題時都需要聯繫您的人力支持團隊。 這意味著花費更多時間響應支持請求。

您要么需要從發展業務中抽出時間來自己處理這些響應，要么需要聘請專門的支持人員（這需要花錢）。

憑藉高質量的文檔，客戶將能夠解決他們自己的許多問題，從而消除了他們尋求支持的需要。 您還可以構建您的支持流程，以促使人們在提出請求之前檢查您的文檔。

它可以成為一個很好的營銷和銷售工具

雖然很多人在幫助已經決定購買的人的背景下考慮產品文檔，但良好的產品文檔也可以幫助您首先吸引和轉化更多客戶。

從營銷的角度來看，產品文檔是長尾 SEO 關鍵字的金礦，您可以對文檔進行排名。 您可能會對直接從 Google 訪問您的產品文檔的人數感到驚訝。 如果你組織好你的文檔，你就有機會將這些人轉變為客戶。

您的文檔也可以成為對購買產品猶豫不決的人的有用銷售工具。 產品文檔可以解決他們可能遇到的潛在售前問題，讓他們相信您的產品可以滿足他們的需求，並讓他們相信他們會在需要時獲得幫助。

例如，Stripe 以擁有一些最好的產品文檔而聞名。 如果你去 Twitter，你會看到很多人推薦 Stripe，因為 Stripe 的文檔質量很高：

它使您的員工更有效率

產品文檔不僅適用於客戶，它還可以成為您的團隊成員在需要時了解您的產品和參考的重要資源。 對於新員工來說尤其如此，他們可能對您的產品沒有廣泛的知識基礎。

四個偉大的真實產品文檔示例

為了給您更多靈感，讓我們看一些來自成功公司的真實產品文檔示例。

1.條紋

我們之前提到 Stripe 是作為營銷/銷售工具的質量文檔的最佳示例之一，因此您知道 Stripe 文檔必須在我們的列表中排名第一。

2.阿迪恩

Adyen 是一個用於電子商務、移動和銷售點支付的支付平台。 與 Stripe 一樣，這意味著開發人員需要將其集成到自己的平台中，這需要出色的文檔。 Adyen 並沒有讓人失望——在此處查看完整的 Adyen 文檔。

3. 暮光之城

如果您不熟悉 Twilio，它是一種工具，可幫助企業通過短信、電子郵件、電話等方式在其平台中建立通信。 與 Stripe 和 Adyen 一樣，這意味著企業需要將 Twilio 集成到他們現有的服務中，這需要一流的文檔。 您可以瀏覽 Twilio 文檔以查看一個很好的示例。

4. 鬆弛

Slack 是另一種工具，它具有非常好的編寫和有用的文檔。 您可以在此處瀏覽完整的 Slack 文檔。

要查看更多示例，請查看我們關於最佳用戶文檔示例的完整帖子。

最佳產品文檔軟件

現在，讓我們來看看如何開始在您的網站上提供更好的產品文檔。

我們將在下一節討論實際編寫文檔。 但是，在您編寫文檔之前，您需要一個地方來存儲這些文章並讓您的用戶可以訪問它們。

雖然您可以直接將這些文章添加到您的站點，但最好使用專用的產品文檔軟件。 除了組織您的內容並使訪問者可以訪問之外，好的產品文檔軟件還將包括其他有用的功能，例如……

• Ajax 搜索功能幫助訪問者瀏覽文檔。
• 搜索分析，以便您可以查看人們正在尋找的主題。
• 有用性數據，以便您可以跟踪每篇文章的有用性並在需要時進行改進。

這裡有兩個最好的解決方案……

英雄知識庫（英雄知識庫）

Heroic Knowledge Base 是免費的開源 WordPress 軟件的插件，可讓您輕鬆創建自己的自託管產品文檔中心。

如果您已經將 WordPress 用於您的企業網站，您可以將 Heroic Knowledge Base 添加到您的網站以創建您自己的文檔中心。 或者，如果您不這樣做，您可以為您的文檔創建一個專用的 WordPress 安裝。 在後一種情況下，您可能還對KnowAll WordPress 文檔主題感興趣。

Heroic Knowledge Base 讓您可以使用 WordPress 的內容編輯器添加所有文檔，這樣可以在需要時輕鬆包含多媒體內容。 您還可以訪問 WordPress 的內置內容版本控制系統，該系統可讓您輕鬆跟踪更改並比較文檔的先前版本。

Heroic 知識庫還添加了許多有用的功能，包括：

• 即時 Ajax 搜索。
• 搜索分析。
• 文章有用性評級。
• 文章文件附件。

英雄知識庫僅需 129 美元。

Adobe 機器人幫助

如果您只是在網絡上發布您的文檔，那麼像 Heroic Knowledge Base 這樣的解決方案就是您所需要的。 但是，對於更多的企業級文檔需求，您可能會遇到需要跨多個平台發布文檔的情況，包括 Web、物理紙張、移動應用程序、PDF 等。

在這種情況下，您可能更喜歡 Adob​​e RoboHelp 等多平台文檔創作工具。 個人使用每月 29.99 美元起，比 Heroic Knowledge Base 貴。 但是，如果您需要多平台創作，那麼額外的價格可能是物有所值的。

如何優化您的產品文檔結構和內容

現在您已經擁有了管理文檔所需的軟件，讓我們來談談如何編寫高質量的文章。 以下是構建文檔和編寫更好的幫助文章的八個關鍵技巧……

1. 了解你的聽眾

為了編寫出色的產品文檔，您需要了解您所寫的受眾（即您的客戶）。

您為誰寫作將影響您包含哪些信息以及您如何構建所有內容。 例如，如果您正在為開發人員編寫文檔，那麼您的文檔應該與為普通用戶編寫的文檔完全不同。

您不想假設您的受眾是專家並掩蓋關鍵細節，但您可能會根據他們的身份假設一些基本知識。

2.了解不同的產品文檔類型

有不同的產品文檔類型，每種都需要不同的方法。 一些常見的類型是：

• 概述——這些文章概述了您的產品的某個領域是如何工作的，例如“入門”指南。
• 分步教程——這些文章向人們展示瞭如何執行特定任務。
• 參考- 這些文章解釋了您產品中的特定概念。
• 故障排除——這些文章解釋瞭如何調試/排除客戶可能遇到的常見問題。

您正在處理的文檔類型應該會影響您的編寫方式和文檔結構，因此在深入研究之前了解目標是什麼很重要。

3. 在你的風格和命名約定上保持一致

為了使您的產品文檔更易於客戶使用，在整個文檔中保持相同的樣式和命名約定非常重要。 這將使客戶更容易遵循您的文檔並避免任何潛在的混淆。

為了幫助您做到這一點，為基本格式和術語提供樣式指南可能會很有用。

4.使用簡單的語言並保持簡潔

凡事平等，簡短而簡單的語言總是勝過單詞沙拉。 您的目標應該是用盡可能少的文字傳達所有必要的信息。

您還應該盡可能避免使用行話或複雜的術語。 並非所有客戶都擁有相同的知識庫，有些客戶甚至可能不是以您的文檔語言為母語的人，因此使事情盡可能簡單可確保每個人都能從您的文檔中獲得價值。

5. 在邏輯的、“問題大小”的文章中組織文檔

為了讓人們更容易瀏覽您的文檔並找到針對他們特定問題的文章，您需要將文檔分成邏輯段。 一般來說，每篇文章都應該專注於解決一個特定的問題。

當然，在這個主要問題中可能有多個子問題，但我們的想法是，您不想將兩個完全獨立的問題混入同一篇文章中，因為這會使人們難以搜索這些主題並且他們當他們登陸文章時可能會感到困惑。

您的客戶不會像閱讀書籍那樣以線性方式閱讀您的文檔。 相反，他們會根據他們目前遇到的問題跳來跳去。 將您的文章分成邏輯段有助於您解釋這種行為。

6. 融入多媒體元素

雖然書面文本應該構成產品文檔的核心，但它不應該是唯一的東西。 在有意義的地方包含圖像和視頻內容也很有幫助。

如果包括屏幕截圖，您還可以在圖像中添加註釋以闡明關鍵細節。

7.使用標題並添加目錄

在單個產品文檔文章中，確保使用標題將文章劃分為邏輯段，而不是只寫一堵長長的文字牆。

為了幫助人們瀏覽文章，您還可以添加一個目錄，讓讀者快速跳轉到特定部分。

一些產品文檔軟件可以幫助您自動添加目錄。 例如，Heroic Knowledge Base 插件帶有一個內置功能，可以根據每篇文章的標題自動生成目錄。

8. 始終改進和更新您的文檔

最後，重要的是要記住創建產品文檔不是一次性的事件。 這是一個持續的過程。

在基本層面上，您的產品可能會發生變化，因此更新您的文檔以說明這些變化和您添加的任何新功能非常重要。

但除此之外，如果您選擇 Heroic Knowledge Base 等產品文檔軟件，您將可以訪問分析，以幫助您了解人們如何使用您的文檔。 您可以使用這些分析來：

1. 跟踪人們正在搜索的內容，這可能表明您需要圍繞這些主題創建文檔（如果您還沒有這樣做的話）。
2. 查看哪些文章沒有像您希望的那樣幫助用戶，這可能表明您需要對這些文章進行改進以提高他們的幫助。

立即開始創建出色的產品文檔！

創建高質量的產品文檔是對您業務長期成功的投資。 它可以幫助您……

• 讓您的客戶更成功。
• 減輕支持團隊的負擔。
• 首先吸引和轉化更多客戶。
• 提高員工對產品的了解。

在這篇文章中，我們分享了一些來自成功公司的優秀產品文檔示例，以及一些關於如何編寫和構建文檔的技巧。

如果您準備好創建自己的產品文檔中心，您可以使用 Heroic Knowledge Base 插件來構建您自己的由 WordPress 提供支持的自託管解決方案。 單擊以了解有關英雄知識庫的更多信息。