作者:探碼科技, 原文鏈接: http://nbbskj.com/blog/758
信息架構 (IA) 對于技術作家來說可能具有挑戰性。有許多因素需要考慮:從用戶如何使用信息到如何在在線百科全書中對其進行索引。讓我們首先看看信息架構代表什么,然后了解它的創建。
信息架構是一門主要關注我們如何組織文檔中的信息的學科。它是用戶、上下文和內容的融合。
在《信息架構(IA)的信息理論-第1部分》、《信息架構(IA)的信息理論-第2部分》中,我們對什么事信息架構也是做了詳細的講解。
?
技術寫作不僅僅涉及您使用的單詞或語法,還涉及向讀者展示信息,使他們能夠理解并輕松快速地找到他們需要的內容。
為了創建信息架構,首先必須了解擁有哪些類型的內容。信息按內容類型組織,而不是按目標受眾或其他次要因素組織。
在這個過程中,必須考慮內容的不同類型。以下文章提供了各種技巧,介紹了為下一個技術寫作項目創建知識層次結構的方法。
???
在規劃信息架構時,您需要確定內容庫中哪些主題最重要。
例如,商業制冷設備制造商的內容庫包括產品描述、用戶手冊和安裝指南。此外,制冷循環將是您的內容庫中的一個重要主題。在知識庫術語中,將其視為您的第一級類別。
在組織內容時區分必要的主題和不太重要的主題非常重要,因為它將決定信息的層次結構。您可能有幾個與您的許多主題相關的次要主題。
例如,制冷循環可能包括系統效率、壓縮機類型和振動分析。制冷循環至關重要,其他主題是內容庫中可能引用的次要主題。在知識庫術語中,將其視為子類別和文章。
如果您的內容是模塊化的并且可以重新組織或改變用途,那么最好等到最后再建立邊界。這樣,您可以采用模塊化方法來組織內容并根據需要進行調整。
例如,您的內容庫可能包含與特定產品線相關的文檔集合。在這種情況下,您可能需要根據產品線創建邊界并確保沒有內容重疊。
但是,如果您的內容不是模塊化且緊密耦合的,您可以更快地建立邊界。技術作家在為模塊化內容創建信息架構時應牢記以下幾點:
邊界可以基于
例如,如果您想要創建基于組織單位(例如客戶服務或人力資源)的信息架構。在這種情況下,您可能希望根據跨組織問題(例如人才招聘、員工幸福感、運營等)創建邊界。
根據您的目標受眾,您將希望將某些方面納入您的信息架構中,以便讀者更輕松地導航、理解和找到他們需要的內容。
例如,如果您的目標受眾主要是非技術讀者,您可能需要包含與您的行業或產品相關的術語表。如果您的內容適合技術和非技術讀者,請確保您在呈現的技術信息中取得平衡。要記住的重要一點是,非技術讀者應該像技術讀者一樣輕松導航和理解您的內容。
某些基本實踐可以幫助您的內容更易于理解,例如用簡單的語言編寫,包括術語表,創建復雜流程的視覺表示(圖像、Gif、視頻),以及創建邏輯性且易于遵循的信息架構。
技術傳播者應該始終尋找方法為其內容構建易于理解且合乎邏輯的框架。適用于任何類型內容的通用框架是流程或過程框架,通常表示為流程圖或序列圖。
您可以根據多種形式為您的內容創建框架。
這將幫助讀者更好地理解您的內容并輕松找到他們需要的內容。
一旦確定了基本主題和邊界,您就可以確定信息架構中內容的級別和類型??紤]這個問題的一個很好的方法是決定要將內容放置在多少層上。
內容的級別和類型可以包括主要、次要、第三和第四主題。
例如,假設您的重要主題是制冷循環。制冷循環中有三個次要主題:系統效率、壓縮機類型和振動分析。這些次要主題中的每一個都將被置于不同的級別??梢詫⑵淅L制為目錄,以方便讀者閱讀。建議在文檔中使用標題標簽(H1、H2、H3…)。
為您的內容創建信息架構是技術寫作過程中的關鍵步驟。在這個階段,您將找出最重要的主題、創建框架并決定內容的級別和類型。一旦你有了一個固定的架構,寫作部分就像在你的信息架構的設定車道上行駛一樣。
直觀的技術文檔軟件,可輕松添加內容并將其與任何應用程序集成。嘗試一下Baklib,將企業的所有數字媒體資產進行統一管理,并通過網站、知識庫、社區、Chat等多種形式多場景應用展示。 全面實現對企業數字資產、媒體內容、知識沉淀的統一管理應用,幫助企業多方收集各項反饋數據,提升企業員工效率與客戶體驗。