Creating a Taxonomy from the Ground Up with Findability in Focus

从头开始创建分类法,重点关注可查找性

2023-06-01 04:00 clickhelp

本文共1496个字,阅读需15分钟

阅读模式 切换至中文

The creation of content is an on-going process. The company’s technical writers constantly create content to support the product, incorporating new features and developments. Additionally, it is common for similar issues to be covered in different documents, as is typical for CCMSs (component content management systems). These circumstances give rise to the challenges of searchability and findability. Companies dealing with extensive documentation, particularly those utilizing content reuse and single sourcing, face the task of enhancing searchability of their knowledge to improve its effectiveness. One solution to this problem is the implementation of taxonomies. Taxonomies are descriptive metadata added to content to enable efficient searching. Taxonomy labels work like tags. They are assigned to the pieces of content during the creation process. A taxonomy can also be compared to an index, providing a list of reference terms that facilitate information retrieval for readers. The purpose of this blog is to describe the importance and benefits of taxonomies while offering practical tips on creating and managing them. Understanding Findability Traditionally, information search relied on a one-dimensional folder system. This approach was time-consuming and often yielded inaccurate results, as relevant information could be scattered across different folders. Consequently, the content blocks discovered were often only partial. Taxonomies have revolutionized the concept of findability by taking it to a whole new level. Through the use of taxonomy tags, the entire knowledge base of a company can be indexed, transforming the search for information into a comprehensive multi-dimensional process. In a folder-based search, users navigate through folders, document names, chapters, and sections, which can be challenging since it requires familiarity with the information architecture and documentation organization philosophy. In reality, very few employees possess this level of expertise. Typically, individuals have a fragmented understanding of information, limited to their specific areas of expertise. Only a select few have a comprehensive view of the entire range of issues. While these individuals may be effective in conducting folder-based searches, what about others? A simpler method of information retrieval must be provided for them. Taxonomy-based search differs from the traditional folder system as taxonomy tags enable content categorization regardless of its location in folders. Tags, or taxonomy labels, allow users to search for content by category, establishing a metasystem that describes the content structure. As a result, the findability of information improves. All parties benefit from this approach: technical writers can streamline and expedite the content creation process, while product users can swiftly find answers to their product-related queries. Planning for the Taxonomy Taxonomy planning is closely related to logic or, in simpler terms, how we conceptualize information. It involves categorization, classification, generalization, and other methods of organizing information. The main purpose of a taxonomy is to mirror human logic. Otherwise, the tags created will not effectively connect the search input (the words entered in the search bar) to the search output. For example, you’ve got a large amount of information concerning flowers. You can index this information using taxonomy tags such as color, shape, aroma, species, perennial/annual plants, inflorescence, and more. As you can see from the example, both botanical and general categories can be applied. In fact, the more tags you create, the better. Expanding the scope of the taxonomy enables more precise searches, as additional filters can be applied to the search parameters. When planning taxonomy creation, it is crucial to consider the target audience. Primarily, this audience consists of technical writers and other stakeholders involved in content usage and development. The best approach to taxonomy planning is to involve all team members in a collaborative brainstorming process. Ask everyone who is concerned how they perceive the content and the terms they use to think about. Conduct a simple questionnaire to extract the necessary information from team members. Each person will offer unique perspectives on the matter, which is exactly what you need to capture during this process. Creating the Taxonomy Once the team has finalized the taxonomy tags, you can proceed with creating them. Their taxonomy system is hierarchical and, if represented visually, it will resemble a branching structure or a tree of terms. On a basic level, a taxonomy structure may appear as separate index entries or a list of references, similar to how it is organized in the final pages of a book. In a more complex taxonomy, a hierarchical structure is established, consisting of primary term and additional (derivative) terms that the users may search for. Therefore, when constructing a taxonomy, it is essential to consider the categories and subcategories that the tags may fall under. Before implementing the taxonomy, it is crucial to conduct a thorough testing. It is recommended to perform a usability test, where you scan through the taxonomy tags to ensure that all the possible ways of information search have been accounted for. Improving Findability with Metadata Metadata can be defined as ‘data used to describe data’. Imagine your content as the foundation of a pyramid, forming a bulk of information. The upper part of the pyramid represents the superstructure, which is comprised of metadata. These metadata elements assist both humans and artificial intelligence in organizing data and transforming it into valuable information. To summarize the points mentioned above, metadata plays a crucial role in enhancing information retrieval from the company’s knowledge base. Each piece of content is assigned one or more tags, allowing it to be included in search results. Thus, metadata is employed to enhance findability. Taxonomies are instrumental in providing users with a comprehensive overview by retrieving all content related to a specific concept. The following best practices can be applied when utilizing metadata: Linking related content through taxonomies. Taxonomies establish connections between content items that share the same taxonomic category, even if they are located in different folders or pertain to different topics in terms of navigation. Multifaceted navigation. Taxonomies enable users to apply multiple filters during their search, leading to highly focused and specific results. Search suggestions. As users type their search queries, the system can offer results derived from the existing taxonomy. This feature can facilitate the search process, particularly when users encounter difficulties in formulating their queries. Implementing the Taxonomy ClickHelp is a system that also serves as a powerful taxonomy management tool. Within the platform, users have the capability to add index keywords to topics, thereby enhancing navigation. The comprehensive full-text search functionality implemented in the platform analyzes not only the content of topics but also the index keywords. This results in an accelerated search process, saving valuable time for writers, developers, and product users. Furthermore, the system offers easy refinement options. In cases where a term has synonyms, users can include them as additional keywords. This ensures that users can discover all aspects related to a particular topic. Another notable advantage is the ability to address situations where a feature's name has been changed, but customers still recognize and use the old name. By adding the old version to the index keywords, customers will never lose access to crucial information. Overall, ClickHelp provides a robust solution for managing taxonomies, optimizing search capabilities, and ensuring users can efficiently access the information they need. Maintaining the Taxonomy Taxonomy management is an ongoing and continuous process that remains active as long as the product exists. The taxonomy scope will expand and evolve over time, requiring consistent maintenance akin to managing a piece of equipment or a machine. Neglecting this maintenance can result in a faulty taxonomy that will require subsequent fixes. Therefore, it is crucial to continuously build relationships between concepts and determine hierarchical connections. Taxonomy governance also entails regularly reviewing the taxonomy with all stakeholders involved. This includes the participation of UXers, who will test the taxonomy from a user's perspective. The long-term functionality and effectiveness of the taxonomy rely on regular reviews and maintenance. This means being actively engaged in tasks such as adding and removing terms, grouping keywords, and more. By diligently tending to the taxonomy and ensuring its accuracy and relevance, you can optimize its usability and keep it aligned with the evolving needs of the product and its users. Conclusion Taxonomies play a crucial role in navigating the information architecture of a company's knowledge base. They establish hidden connections between content elements, and when organized and maintained effectively, they significantly improve search results and refinements. By maintaining the taxonomy properly, your team will be able to locate the desired content much faster compared to navigation-based search methods. However, the effectiveness of a taxonomy extends beyond accelerated information retrieval. It leads to increased content reuse by technical writers and streamlines the overall workflow. A well-maintained taxonomy empowers your team to maximize productivity and efficiency by leveraging existing content resources. It enhances collaboration, promotes consistency, and ultimately contributes to the success of your documentation and knowledge management processes. Good luck with your technical writing! ClickHelp Team Author, host and deliver documentation across platforms and devices
内容的创建是一个持续的过程。该公司的技术作家不断创造内容来支持产品,融入新的功能和发展。此外,在不同的文档中涵盖类似的问题是很常见的,这对于CCMS(组件内容管理系统)来说是典型的。 这些情况带来了可搜索性和可查找性的挑战。处理大量文档的公司,特别是那些利用内容重用和单一来源的公司,面临着增强其知识的可搜索性以提高其有效性的任务。 这个问题的一个解决方案是实现分类法。 分类法是添加到内容中的描述性元数据,用于实现高效搜索。 分类标签的工作方式与标记类似。它们在创建过程中被分配给内容片段。分类法也可以与索引相比较,提供便于读者进行信息检索的参考术语列表。 这个博客的目的是描述分类法的重要性和好处,同时提供创建和管理它们的实用技巧。 了解可查找性 传统上,信息搜索依赖于一维文件夹系统。这种方法很耗时,而且往往产生不准确的结果,因为相关信息可能分散在不同的文件夹中。因此,发现的内容块通常只是部分的。 分类学彻底改变了可查找性的概念,将其提升到了一个全新的水平。通过使用分类标签,可以对公司的整个知识库进行索引,从而将信息搜索转变为全面的多维过程。 在基于文件夹的搜索中,用户在文件夹、文档名称、章节和节之间导航,这可能具有挑战性,因为它需要熟悉信息体系结构和文档组织理念。事实上,很少有员工拥有这样的专业知识。 通常情况下,个人对信息的理解是支离破碎的,仅限于其特定的专业领域。只有少数几个人对整个问题有全面的看法。虽然这些人可能在进行基于文件夹的搜索时很有效,但其他人呢?必须为他们提供一种更简单的信息检索方法。 基于分类的搜索与传统的文件夹系统不同,因为分类标签支持内容分类,而不管其在文件夹中的位置。 标签或分类标签允许用户按类别搜索内容,建立描述内容结构的元系统。 结果,信息的可查找性提高。所有各方都受益于这种方法:技术作者可以简化和加快内容创建过程,而产品用户可以快速找到与产品相关的查询的答案。 规划分类 分类学规划与逻辑密切相关,或者用更简单的话来说,就是我们如何概念化信息。它涉及分类、归类、概括和其他组织信息的方法。分类法的主要目的是反映人类的逻辑。否则,所创建的标签将不能有效地将搜索输入(在搜索栏中输入的词)连接到搜索输出。 例如,您已经获得了大量有关花卉的信息。您可以使用分类标签(如颜色、形状、香气、物种、多年生/一年生植物、花序等)为这些信息编制索引。从示例中可以看出,植物学和一般类别都可以应用。事实上,你创建的标签越多越好。 扩展分类法的范围可以实现更精确的搜索,因为可以对搜索参数应用额外的过滤器。 在规划分类法创建时,考虑目标受众是至关重要的。这些受众主要包括技术作者和其他参与内容使用和开发的利益相关者。分类法规划的最佳方法是让所有团队成员都参与到协作的头脑风暴过程中。 询问每一个关心的人,他们如何看待内容和他们使用的术语。进行简单的问卷调查,从团队成员中提取必要的信息。每个人都将提供关于这个问题的独特观点,这正是你在这个过程中需要捕捉的。 创建分类 一旦团队完成了分类标记,您就可以继续创建它们。他们的分类系统是分层的,如果直观地表示,它将类似于分支结构或术语树。 在基本的层次上,分类法结构可以显示为单独的索引条目或引用列表,类似于在书的最后几页中组织它的方式。在更复杂的分类法中,建立了一个层次结构,由用户可以搜索的主要术语和附加(衍生)术语组成。因此,在构建分类法时,必须考虑标签可能属于的类别和子类别。 在实现分类法之前,进行彻底的测试是至关重要的。建议执行一个可用性测试,在此测试中,您可以浏览分类法标记,以确保所有可能的信息搜索方式都已考虑在内。 使用元数据提高查找能力 元数据可以定义为“用于描述数据的数据”。想象你的内容是金字塔的基础,形成了大量的信息。金字塔的上部表示由元数据组成的上层结构。这些元数据元素帮助人类和人工智能组织数据并将其转换为有价值的信息。 总结上面提到的几点,元数据在增强公司知识库的信息检索方面起着至关重要的作用。每一条内容都被分配了一个或多个标签,允许它被包含在搜索结果中。因此,采用元数据来增强可查找性。 分类法有助于通过检索与特定概念相关的所有内容为用户提供全面的概述。在利用元数据时,可以应用以下最佳做法: 通过分类法链接相关内容。分类法在共享相同分类类别的内容项之间建立连接,即使它们位于不同的文件夹中或在导航方面属于不同的主题。 多方位导航分类使用户能够在搜索过程中应用多个过滤器,从而获得高度集中和特定的结果。 搜索建议。当用户键入他们的搜索查询时,系统可以提供从现有分类法导出的结果。此功能可以促进搜索过程,特别是当用户在制定其查询时遇到困难时。 实现分类 ClickHelp是一个系统,也是一个强大的分类法管理工具。在该平台内,用户能够向主题添加索引关键字,从而增强导航。 平台中实现的全面全文搜索功能不仅分析主题的内容,还分析索引关键字。这将加速搜索过程,为作者、开发人员和产品用户节省宝贵的时间。 此外,该系统提供了简单的细化选项。在术语具有同义词的情况下,用户可以将它们作为附加关键字包括在内。这确保用户可以发现与特定主题相关的所有方面。另一个值得注意的优点是能够解决功能名称已更改但客户仍然识别并使用旧名称的情况。通过将旧版本添加到索引关键字,客户永远不会失去对关键信息的访问。 总的来说,ClickHelp提供了一个强大的解决方案,用于管理分类法、优化搜索功能并确保用户能够有效地访问所需的信息。 维护分类 分类管理是一个持续不断的过程,只要产品存在,它就保持活动状态。分类法的范围将随着时间的推移而扩展和发展,需要一致的维护,类似于管理一台设备或机器。忽略此维护可能会导致错误的分类法,需要后续的修复。 因此,关键是要不断建立概念之间的关系,并确定层次连接。分类法治理还需要与所有相关的利益相关者一起定期审查分类法。这包括用户体验人员的参与,他们将从用户的角度测试分类法。分类法的长期功能和有效性依赖于定期的审查和维护。这意味着要积极参与添加和删除术语、对关键字进行分组等任务。 通过努力维护分类法并确保其准确性和相关性,您可以优化其可用性,并使其与产品及其用户不断变化的需求保持一致。 结论 分类法在导航公司知识库的信息体系结构方面起着至关重要的作用。它们在内容元素之间建立了隐藏的联系,当组织和维护有效时,它们可以显着改善搜索结果和改进。 通过正确维护分类法,您的团队将能够比基于导航的搜索方法更快地找到所需的内容。然而,分类法的有效性超出了加速信息检索的范围。它可以提高技术作者的内容重用率,并简化整体工作流程。 维护良好的分类法使您的团队能够通过利用现有的内容资源来最大限度地提高生产力和效率。它增强了协作,促进了一致性,并最终有助于文档和知识管理流程的成功。 祝你的技术写作好运! 单击帮助团队 跨平台和设备编写、托管和交付文档

以上中文文本为机器翻译,存在不同程度偏差和错误,请理解并参考英文原文阅读。

阅读原文