資訊架構 (IA) 對於技術作家來說可能具有挑戰性。 有許多因素需要考慮:從使用者如何使用資訊到如何在百科全書中索引資訊。 讓我們首先看看資訊架構代表什麼,然後了解它是如何建立的。
資訊架構是一門專注於如何組織文件中資訊的學科。 它是使用者、上下文和內容的混合體。
技術寫作不僅僅是關於你使用的單詞或語法。 它還涉及向讀者展示您的資訊,以便他們能夠理解它並輕鬆快速地找到他們需要的內容。
要建立資訊架構,您必須首先知道您擁有的內容型別。 資訊按內容型別組織,而不是按目標受眾或其他次要因素組織。
但是有哪些不同型別的內容呢?以下文章介紹了為您的下乙個技術寫作專案建立知識層次結構的各種技巧。
在規劃資訊體系結構時,需要確定哪些主題在內容庫中最為重要。
例如,商用製冷裝置製造商的內容庫包括產品說明、使用者手冊和安裝指南。 此外,製冷迴圈將是內容庫中的乙個重要主題。 在知識庫術語中,將其視為您的第一級類別。
在組織內容時,區分必要和不太重要的主題很重要,因為它將決定資訊的層次結構。 您可能有幾個次要主題與您的許多主題相關。
例如,製冷迴圈可能包括系統效率、壓縮機型別和振動分析。 製冷迴圈至關重要,其他主題是次要主題,可以在內容庫中引用。 在知識庫術語中,它被視為乙個子類別和一篇文章。
如果你的內容是模組化的,可以重新組織或重新調整用途,最好等到最後再建立邊界。 這樣,您可以採用模組化方法來組織內容並根據需要進行調整。
例如,您的內容庫可能包含與特定產品線相關的文件集合。 在這種情況下,您可能需要根據產品線建立邊界,並確保沒有內容重疊。
但是,如果您的內容不是模組化且緊密耦合的,則可以更快地建立邊界。 在為模組化內容建立資訊架構時,技術編寫人員應牢記以下幾點:
邊界可以基於:
主題。 觀眾。
產品線。 品牌。
組織單位。 更多。
例如,如果要基於組織單位(如客戶服務或人力資源)建立資訊體系結構。 在這種情況下,您可能希望根據跨組織問題(如人才招聘、員工福利、運營等)建立邊界。
根據您的目標受眾,您需要將某些方面合併到您的資訊架構中,以使讀者更容易導航、理解和找到他們需要的內容。
例如,如果您的目標受眾主要是非技術讀者,您可能希望包含與您的行業或產品相關的詞彙表。 如果您的內容既適合技術讀者,也適合非技術讀者,請確保在所提供的技術資訊中取得平衡。 要記住的重要一點是,非技術讀者應該像技術讀者一樣輕鬆地瀏覽和理解您的內容。
某些基本做法可以幫助使您的內容更易於理解,例如用簡單的語言編寫,包括詞彙表,建立複雜過程(影象、gif、**)的視覺化表示,以及建立邏輯且易於遵循的資訊架構。
技術布道者應該始終尋找方法來為他們的內容構建乙個易於理解和邏輯的框架。 適用於任何型別的內容的通用框架是流程或流程框架,通常表示為流程圖或序列圖。
您可以以各種形式為您的內容建立框架。
基於流程或程式的資訊架構。
時序圖。 流程圖。
決策樹。 決策清單。
以結果為導向的矩陣。
這將幫助讀者更好地理解您的內容並輕鬆找到他們需要的內容。
一旦確定了基本主題和邊界,就可以確定資訊體系結構中內容的級別和型別。 考慮這個問題的乙個好方法是決定你想把你的內容放在多少層上。
內容的級別和型別可以包括主要、次要、第三和第四主題。
例如,假設您的重要主題是製冷迴圈。 製冷迴圈中有三個次要主題:系統效率、壓縮機型別和振動分析。 這些次要主題中的每乙個都將放在不同的級別。 為了方便讀者,它可以繪製為目錄。 建議在文件中使用標題標籤(h1、h2、h3...))。
為您的內容建立資訊架構是技術寫作過程中的關鍵步驟。 在這個階段,你將找出最重要的主題,建立乙個框架,並決定內容的級別和型別。 一旦你有了固定的模式,編寫部分就像在資訊架構的既定車道上行駛一樣。
直觀的技術文件軟體,可以輕鬆新增內容並將其與任何應用程式整合。 試試 baklib!