組織起來！ 如何創建知識庫樣式指南
已發表: 2017-05-03編寫知識庫已經夠難的了。 所以我為我在這篇文章中要做的事情道歉。 我要告訴你，這不僅僅是關於你知識庫中的想法，還與你如何呈現它們有關。
看，除了這些想法之外，您還需要確保您始終：
- 使用適當的語氣
- 始終如一地格式化所有內容
出於我將在下一節中說明的原因，這實際上是非常困難的。 這就是知識庫風格指南發揮作用的地方。
為什麼你的知識庫可能是不同風格的混亂
如果您的知識庫是不同風格的混雜，請不要太擔心。 它發生在很多公司身上，通常是出於兩個原因之一（或者有時兩者兼而有之！）。
首先，如果您是團隊的一員，您可能會有不同的人編寫支持文檔。 因此，如果：
- 吉姆寫文章 A
- 莎莉寫文章 B
這些文章可能會有截然不同的風格和格式……除非你有一個預定義的風格指南。
現在，如果你不是團隊的一員，你可能會說， “我是一隻獨狼——我自己寫所有東西。 所以我不需要把任何東西寫在紙上——全是我！”
情況可能就是這樣……如果您一口氣寫完所有知識庫文章。
但我們都知道事情通常不是這樣運作的，對吧？ 當您第一次發布產品時，您可能寫了一堆知識庫文章。
但是，三個月後，您發布了一項新功能。 現在您必須為該新功能編寫知識庫條目，而且……人類的記憶並不是那麼好。 很有可能你最終會做一些不同的事情，即使你沒有嘗試這樣做。
因此，無論您是獨自一人還是團隊成員，將您的知識庫風格指南寫在紙上都是值得的。
公司真的這樣做嗎？ 知識庫風格指南是真實的嗎？
好的，我馬上會告訴你如何創建你的風格指南。 但首先，我想以一些實際這樣做的公司為例。 這實現了兩個目標：
- 它向你展示了我不只是為了創造更多的博客內容而編造東西
- 它為您提供了一個真實的示例，您可以從中提取自己的風格指南。
讓我們先看看Mozilla。 Mozilla 在其知識庫的樣式指南中有完整的條目。 因為 Mozilla 是開源的，所以他們有一個風格指南尤其重要，用他們自己的話來說，“使 Firefox 支持知識庫保持一致，從而形成一個易於閱讀和貢獻的知識庫。”。 易於閱讀？ 對於您的知識庫來說，這聽起來是一個不錯的目標，對吧？
該指南深入淺出，帶您了解從大寫、空格到連續逗號的所有內容。
接下來，MailChimp 的 Voice & Tone 是另一個值得一讀的內容。 雖然它不是 100% 專注於知識庫，但它確實有許多用於知識庫和教程內容的條目：
Mozilla 的風格指南更關注風格和格式，而 MailChimp 選擇更多地關注語音和語氣，而不是細節格式。
如何為您的知識庫創建樣式指南
我向你扔了幾個例子，但我還沒有給你一個實際創建你自己的知識庫風格指南的過程。 所以讓我們解決這個問題！
使用一致的人
你有沒有讀過作者在“我”和“我們”之間來回切換的文章？ 我有，我們可以告訴你，這非常令人困惑。
所以，如果你要使用第一人稱——選擇一個並保持一致。 即使你是獨奏，你仍然可以選擇使用“我們”。 由你決定！ 只需使用相同的。
此外，您甚至不需要使用第一人稱。 您可以選擇完全避開“我”和“我們”。
這裡沒有真正正確的答案——它只是關於一致性。
標準化您的格式
如果您閱讀了我們的終極知識庫文章模板指南，您就會知道好的知識庫使用大量的小步驟說明。 在某些時候，這些說明將包括如下語言：
點擊文件。
那麼——是嗎：
- 點擊文件
- 點擊“文件”
- 點擊文件
當您實際編寫列表時，是不是：
- 第一步：點擊這個
- 第2步：點擊那個
或者是這樣的：
- 點擊這裡
- 點擊那個
再一次——你可以選擇你最喜歡的一個——但無論你選擇哪一個，都要在你的整個知識庫中一致地使用它。
您還需要做出其他格式選擇 - Mozilla 樣式指南讓您對要涵蓋的所有內容都有一個很好的了解，但這裡有一些入門想法：
- 標題大寫——你會使用句子大小寫還是標題大小寫？
- 數字——是 10 還是 10？
- 縮寫詞——不要還是不要？
- 首字母縮略詞——CDN 還是內容交付網絡？
如果您使用我們的知識庫 WordPress 主題或插件之一，我們的內置短代碼和格式化選項可以幫助您在格式化時保持一致
獲得正確的聲音
最後，您需要超越格式並標準化您的聲音。
你是你客戶的朋友嗎？ 或者你是星際迷航中的史波克，冷靜地散發著冷酷的智慧？
在合理範圍內，兩者都可以。 只要是一致的。
一般來說，您應該確保遵循 MailChimp 的知識庫指南提示。 我建議他們不僅是因為 MailChimp 實際發布了他們的指南，還因為我認為 MailChimp 擁有最好的知識庫之一。
他們的建議是這樣的：
- 始終將回答問題和告知讀者放在首位。 笑話有時是可以的，但如果它們分散了那個基本目標，那就不行了。
- 避免像營銷人員一樣說話——你只是想提供幫助。
在哪裡存儲您的風格指南？
你不應該只是做出這些決定。 實際上，您還需要將它們寫在安全的地方。
就個人而言，我使用的大多數樣式指南都是 Google Docs 文檔。 這樣，您可以輕鬆地共享您的風格指南並從不同的計算機訪問它。
但是，如果您更喜歡其他方法，請使用您熟悉的方法。 唯一真正重要的是：
您將知識庫風格指南的副本存儲在安全的地方，當您需要重新了解如何格式化知識庫時，您或其他人可以訪問它。
因此，將其寫在紙上並開始創建更一致的知識庫文章！