天天看點

如何使用線上工具編輯優質的内部知識庫文檔?

作者:Baklib

公司内部知識庫是指将公司内部的大量有價值的方案、策劃、成果、經驗等知識進行分類存儲和管理,積累知識資産避免流失,積累知識資産避免流失,促進知識的學習、共享、教育訓練、再利用和創新,有效降低組織營運成本,強化其核心競争力。

如何編寫優質的内部文檔?

步驟1–定義明确的目标

首先也是最重要的一點,您需要明确您希望通過内部文檔實作什麼。這可能類似于改進知識管理、提高生産力或促進知識共享。

文檔是一項團隊工作,是以在建立内容時,您需要確定每個人都在同一頁上。需要向檔案的所有貢獻者簡要介紹項目的目标,以便他們能夠有效地做出貢獻。

步驟2–為内容導航建構結構

每個知識管理項目都有一個結構。在建立内部文檔時,它可能以内部知識庫的形式,包含内容類别,以保持頁面的組織。

通讀你的知識,找出可用于将内容分組的合理類别。設計應該是直覺的,對員工來說是有意義的,而不會将内容嵌套到太多的子類别中。保持知識庫的結構簡單,以便員工在嘗試查找内容時可以輕松浏覽。

步驟3–設計模闆

文檔模闆對于标準化内容非常有用,無論是誰參與建立内容。它們通過包含基本元素(如目錄、标題和副标題、引言和結語以及虛拟内容),使編寫内容更容易。

花時間建立可供整個團隊使用的文檔模闆。這些内容可以存儲在您的知識庫軟體中,隻要有人想建立新文章,就可以複制。

步驟4–就想法進行頭腦風暴決策

接下來是令人興奮的部分。召集一個知識冠軍團隊,集思廣益,提出應包含在知識庫中的内容的想法。邀請來自整個組織的不同人員,他們每個人都應該有一個獨特的觀點,包括哪些内容。

雖然所有的想法都是好主意,但重要的是要記住不要過度記錄。如果您的知識庫過于複雜,員工将很難找到資訊并保持内容的準确性。目标是簡潔和相關性,而不是全面性。

如何使用線上工具編輯優質的内部知識庫文檔?

步驟5–添加文本、相關圖像和視訊

下一步是實際編寫文檔。當然,您應該遵循風格指南,并確定文檔能夠很好地反映公司的品牌。如果您正在編寫操作指南,請将文本格式化為帶有編号清單的分步說明。

你知道文檔不需要隻寫文字嗎?如果你的公司有資源,可以找到相關的圖檔和視訊,并附上你的文字。這将使您的員工更加投入,并促進不同的學習風格。

第6步–包括特殊呼叫

大多數知識庫軟體應允許您包含重要資訊(如警告或注意事項)的特殊标注。這些通常會以不同的顔色背景出現,以引起對内容的關注,并将其與文章的其他部分區分開來。

特别重要的是,在技術文檔中包含标注,員工在繼續之前應注意關鍵警告。這是為了防止他們在技術上出錯或可能導緻系統崩潰。

步驟7–添加相關文章的連結

使用搜尋功能并不是員工在知識庫中查找資訊的唯一方式。在您的内容中添加相關文章的連結将引導員工了解更多資訊,這些資訊可能更接近他們正在尋找的内容。

将内容連結起來是讓員工發現知識并充分利用知識庫的重要方式。這鼓勵員工在網站上花費更多的時間,并提高其實用性。

步驟8–與同僚一起回顧内容

當您的内容準備就緒時,進行同行審查以檢查文檔的準确性至關重要。您應該有不同類型的員工來審查您的内容,例如文檔的最終使用者和主題專家。

無論你花多長時間來完善你的内容,第二雙眼睛總是能為你畫龍點睛。同行評審員可以告訴你你的文檔是否合理,并指導你如何改進。不要忘記文檔過程中的這一關鍵步驟。

步驟9–在知識庫上釋出

最後,你已經準備好在一個中心知識庫上釋出你的内容了。您應該已經選擇了正确的知識庫軟體,該軟體可以托管文檔并顯示給最終使用者使用。

當您的内容處于活動狀态時,請檢查知識庫,以確定其在所有裝置上都顯示正确且外觀良好。確定圖像是渲染的,視訊是加載的。您可能會在最後一刻發現文檔中的錯誤,是以請盡快傳回并修複這些錯誤。

在組織内盡可能廣泛地推廣内部文檔。鼓勵員工提供回報,并確定這是一個協作過程。

一個直覺的内部知識庫軟體,可輕松添加内容并将其與任何應用程式內建。試試Document360!

步驟10–監控、跟蹤和維護已釋出的内容

一旦你的知識庫釋出,這項工作就不會完成。分析将告訴您使用者參與度,您可以使用它來改進和完善您的内容。您可以跟蹤諸如文章浏覽次數、文章評分和失敗搜尋等名額。請記住,您的企業中的情況總是會發生變化。這意味着您的文檔需要更新。至少每季度安排一次時間來檢視您的知識庫内容,并标記不再準确的文章。

編寫内部文檔的最佳實踐和技巧

使用普通語言

沒有人願意閱讀充斥着行話和縮略語的知識庫。員工不應該需要公司字典來從您的文檔中獲益。確定你用通俗易懂的日常語言寫作。如果必須使用技術術語,請包含定義。

遵循風格指南

如前所述,在編寫文檔時,請確定遵循樣式指南。風格指南確定文檔标準化,并符合您公司的品牌。您的風格指南甚至可以包含在每個人都可以通路的知識庫中。

確定導航清晰

始終思考使用者如何浏覽您的内容,這不僅僅是提供搜尋欄。導航可以包括諸如帶有類别的清晰菜單之類的元素,也可以包括分解長文章的目錄,以及顯示目前頁面位置的面包屑。

用圖像和視訊贊美内容

圖像和視訊将您的内容帶入生活,并打破原本可能是一堵文本牆的局面。例如,使用螢幕截圖可以向員工展示如何遵循程式。另一方面,圖表可以分解複雜的過程。

使用标簽和元描述優化内容

想想你的内容将如何在搜尋使用者時出現。使用搜尋引擎可以索引的相關标簽和元描述來優化它,并幫助使用者查找相關内容。

必要時限制閱聽人(私人文檔)

您的某些内容在釋出時應僅限于少數個人或團隊。大多數知識庫軟體應該允許您限制對内容或類别的通路,例如,如果您有關于您的銷售前景的資訊,您希望将其保密給您的銷售團隊。

閱讀更多:建立銷售文檔的分步指南

基于分析重新整理和更新内容

知識庫永遠不會完成。使用Document360等解決方案的内置分析功能,讓您的内容保持新鮮并與使用者相關。如果文章被否決,考慮修改内容,使其更有幫助。如果您的内容被浏覽了很多次,請考慮将其顯示在您的知識庫首頁上,以幫助更多使用者。

線上編輯知識庫工具——Baklib

Baklib以一個網頁形式呈現,在這個網頁頁面進行線上編輯文檔,衆多使用者都将其用來建構幫助中心,産品手冊,FAQ,還有企業知識庫等等,應用場景還是很廣泛的,而我作為個人使用,我就把它用來做線上的電子筆記,因為它有移動端,我随時随地都可以進行編輯。

如何使用線上工具編輯優質的内部知識庫文檔?

建立個人站點

建立個人站點就是線上制作一個網站,Baklib可以建立多個站點,站點之間可以随意切換,将站點連結分享到各個平台,隻需要點開連結就能通路。這樣就可以建立并分享屬于自己的多個不同作用的站點,使用起來很友善。

如何使用線上工具編輯優質的内部知識庫文檔?

文檔結構化

我之是以沒有選擇用word,是因為word隻能形成單獨的一個個文檔,把它放在一個檔案夾裡,但Baklib支援富文本和Markdown編輯,采用樹狀結構的呈現方式,最多支援六級欄目,将内容分門别類,對于我做專題類的知識庫提供了很大的幫助。

如何使用線上工具編輯優質的内部知識庫文檔?

備份和導出

官方介紹Baklib采用先進而靈活的雲服務架構、SaaS化服務,從内部編輯到外部分享全程保障客戶資料的獨立而安全,每一步線上編輯都儲存雲端,不用擔心内容的丢失,并且Baklib還支援多種格式的資料導出和備份,這一點真的深得我心。

如何使用線上工具編輯優質的内部知識庫文檔?

簡單易上手

進入Baklib的使用頁面,相比于其它使用起來複雜的應用讓人直接被勸退,對于一個小白來說它提供的保姆級教程真的很人性化了,讓人很快就能get到它的各種功能如何使用。

如何使用線上工具編輯優質的内部知識庫文檔?

多模闆,頁面簡潔清晰

Baklib提供了許多好用的模闆,最關鍵的是可以一鍵使用,真的是為我們省了不少事,也讓制作的頁面更加清晰明了了。

如何使用線上工具編輯優質的内部知識庫文檔?

繼續閱讀