信息架构 (IA) 对于技术作家来说可能具有挑战性。 有许多因素需要考虑:从用户如何使用信息到如何在百科全书中索引信息。 让我们首先看看信息架构代表什么,然后了解它是如何创建的。
信息架构是一门专注于如何组织文档中信息的学科。 它是用户、上下文和内容的混合体。
技术写作不仅仅是关于你使用的单词或语法。 它还涉及向读者展示您的信息,以便他们能够理解它并轻松快速地找到他们需要的内容。
要创建信息架构,您必须首先知道您拥有的内容类型。 信息按内容类型组织,而不是按目标受众或其他次要因素组织。
但是有哪些不同类型的内容呢?以下文章介绍了为您的下一个技术写作项目创建知识层次结构的各种技巧。
在规划信息体系结构时,需要确定哪些主题在内容库中最为重要。
例如,商用制冷设备制造商的内容库包括产品说明、用户手册和安装指南。 此外,制冷循环将是内容库中的一个重要主题。 在知识库术语中,将其视为您的第一级类别。
在组织内容时,区分必要和不太重要的主题很重要,因为它将决定信息的层次结构。 您可能有几个次要主题与您的许多主题相关。
例如,制冷循环可能包括系统效率、压缩机类型和振动分析。 制冷循环至关重要,其他主题是次要主题,可以在内容库中引用。 在知识库术语中,它被视为一个子类别和一篇文章。
如果你的内容是模块化的,可以重新组织或重新调整用途,最好等到最后再建立边界。 这样,您可以采用模块化方法来组织内容并根据需要进行调整。
例如,您的内容库可能包含与特定产品线相关的文档集合。 在这种情况下,您可能需要根据产品线创建边界,并确保没有内容重叠。
但是,如果您的内容不是模块化且紧密耦合的,则可以更快地建立边界。 在为模块化内容创建信息架构时,技术编写人员应牢记以下几点:
边界可以基于:
主题。 观众。
产品线。 品牌。
组织单位。 更多。
例如,如果要基于组织单位(如客户服务或人力资源)创建信息体系结构。 在这种情况下,您可能希望根据跨组织问题(如人才招聘、员工福利、运营等)创建边界。
根据您的目标受众,您需要将某些方面合并到您的信息架构中,以使读者更容易导航、理解和找到他们需要的内容。
例如,如果您的目标受众主要是非技术读者,您可能希望包含与您的行业或产品相关的词汇表。 如果您的内容既适合技术读者,也适合非技术读者,请确保在所提供的技术信息中取得平衡。 要记住的重要一点是,非技术读者应该像技术读者一样轻松地浏览和理解您的内容。
某些基本做法可以帮助使您的内容更易于理解,例如用简单的语言编写,包括词汇表,创建复杂过程(图像、gif、**)的可视化表示,以及创建逻辑且易于遵循的信息架构。
技术布道者应该始终寻找方法来为他们的内容构建一个易于理解和逻辑的框架。 适用于任何类型的内容的通用框架是流程或流程框架,通常表示为流程图或序列图。
您可以以各种形式为您的内容创建框架。
基于流程或程序的信息架构。
时序图。 流程图。
决策树。 决策清单。
以结果为导向的矩阵。
这将帮助读者更好地理解您的内容并轻松找到他们需要的内容。
一旦确定了基本主题和边界,就可以确定信息体系结构中内容的级别和类型。 考虑这个问题的一个好方法是决定你想把你的内容放在多少层上。
内容的级别和类型可以包括主要、次要、第三和第四主题。
例如,假设您的重要主题是制冷循环。 制冷循环中有三个次要主题:系统效率、压缩机类型和振动分析。 这些次要主题中的每一个都将放在不同的级别。 为了方便读者,它可以绘制为目录。 建议在文档中使用标题标签(h1、h2、h3...))。
为您的内容创建信息架构是技术写作过程中的关键步骤。 在这个阶段,你将找出最重要的主题,创建一个框架,并决定内容的级别和类型。 一旦你有了固定的模式,编写部分就像在信息架构的既定车道上行驶一样。
直观的技术文档软件,可以轻松添加内容并将其与任何应用程序集成。 试试 baklib!