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