如何创建知识库风格指南
现代商业环境下，知识库成用户首选求助途径。知识库风格指南对规范内容、提升体验至关重要，其涵盖文章内容、结构格式、写作风格等多方面，还涉及视觉媒体、SEO及AI应用等内容。
知识库通常包含与您的产品相关的复杂信息。如果您的知识库采用一致的风格编写，文章遵循相同的惯例，而不是混合使用分散实际内容的不同声音，那么密集的信息更容易理解。
风格指南有助于提升使用知识库的整体体验，并确保您的组织用同一个声音说话。无论谁撰写文章，听起来都像是来自同一个品牌。
现在，我们将继续探讨如何具体编写您的知识库风格指南，并提供关于包含内容的建议。
第一节：文章内容
1.1 选择文章主题
您的作者可以从许多潜在文章中进行选择。提供关于选择文章主题的最佳方式的指导应成为您风格指南的一部分。例如，您可以指示作者查看知识库中的空白搜索词，这在 Baklib 中很容易做到。您可以要求他们查看帮助台中热门工单主题，或者系统地记录一项新功能。
1.2 制作有效的标题
标题是用户访问您内容时首先看到的内容，也会被您的 AI 搜索（Baklib 中提供）所检索。这些标题应简短，并将关键词放在标题开头附近。标题对于搜索引擎也很重要（后面会提到）。
1.3 使用标签
就如何使用标签提供一致的建议。在您的知识库中，您可以对内容添加标签，以便使用与文章主体相关的词语和短语进行逻辑分组。这使得更多用户无需使用精确的搜索词就能找到所需的帮助。
1.4 撰写清晰的摘要
您知道AI可以为您撰写文章摘要吗？这在Baklib中完全可以实现。用户可能不想阅读整篇文章，而文章摘要通过提供内容的精简版本为他们节省了时间。请为您的文章摘要应该多长以及作者应如何撰写摘要制定规则，或者至少检查AI生成的内容是否符合正确的要求。
1.5 添加和格式化链接
作者在文章中使用链接的方式可能有很大差异，因此您需要就如何添加和格式化链接提供一致的建议。您可能希望指定链接应添加到关键词上，并设置颜色和下划线，以适应不同用户的视觉需求。
1.6 使用注释、提示和警告
就如何在内容主体中穿插使用注释、提示和警告提供指导，以便让用户清楚地知道他们应该注意这些信息。告知作者它们应该使用什么颜色以及何时使用，明确每种形式都有其适用的场景。
第二节：结构与格式
2.1 清晰的标题与副标题
知识库文档应包含关于格式规范的部分。拆分内容至关重要，你需要指导撰写者何时使用标题和副标题。这些通常是 H1、H2 和 H3 级别的标题，因此要告知撰写者可用的格式选项以及如何编写理想的标题（在您的风格指南中保存一个模板是理想的做法）。标题应清晰概述该部分的内容，并使用能够被搜索引擎索引的关键词。
2.2 简短段落与项目符号
为了让您的内容更具可读性，请告知撰写者如何使用简短的段落和项目符号来拆分冗长的文本块。指导撰写者只写两到三个句子的段落，并在编写列表时使用项目符号。
2.3 分步说明
在您的 Baklib 知识库中，很可能会编写分步说明来帮助读者排查常见问题。要求撰写者使用编号列表，以帮助用户跟随操作并理解他们在过程中哪里出错了，同时尽量限制每个步骤的句子数量，以提高可理解性。
2.4 关键术语加粗
还建议将关键术语加粗显示，这样您就可以利用格式来吸引读者对重要词汇的注意。请确保强调使用加粗，而不是斜体或下划线，以保持格式的一致性。
2.5 术语一致性
你需要包含一个关于术语一致性的章节，以帮助撰写者了解如何称呼你组织中的重要部分。将词汇表作为风格指南的附件在这方面很有帮助。例如，在Baklib中，你可以将重要术语保存到你的AI辅助词汇表中，从而确保所有人都在同一认知层面上。
第3部分：写作风格
3.1 简洁明了
作为文档风格指南的一部分，你需要用几句话来说明如何撰写内容，这意味着要让撰写者知道他们应该保持简洁明了。风格指南的这一部分指的是你在知识库中使用的语调。避免漫无边际的离题，而应提供直接的说明。
3.2 使用主动语态
要求你的撰写者使用主动语态而非被动语态：这意味着要说“点击按钮”，而不是“按钮应该被点击”。这能使你的写作更清晰、更有活力，并帮助用户更好地理解你的内容。
3.3 第二人称（您/您的）
你应该始终指导你的撰写者在撰写内容时使用第二人称，即使用“您/您的”，而不是“他/他的”或类似称谓。这是因为你希望将文档的关注点放在用户身上，并让他们更多地参与到你的内容中。
3.4 中立与专业的语调
语调的另一个方面是保持中立和专业。展现个性和幽默感有它的时机和场合，但知识库用户希望直接获得答案。所有技术文档撰写者都必须了解这一点，并遵守专业标准。
💛🧡🧡客户评价：由于我们使用Baklib来管理所有内部培训知识库，因此我们将每天使用该程序（以及每天多次）。内容需要有序直观，以便我们的员工在我们扩大规模时自助检索。除了拥有强大可定制的搜索功能外，Baklib 是一个易于使用的分层组织系统，在我们交叉链接文章时非常有用。
第四节：视觉与媒体使用
4.1 截图与GIF动图
请让您的作者了解如何使用截图和GIF动图来直观地说明您的帮助文档。这可能包括标注截图的适当方式、通常应在何时何地使用它们，以及如何保存图片以便于参考。
4.2 图片替代文本
为了使您的知识库更易于访问，请说明作者应如何为图片使用替代文本。这意味着为您在知识库中使用的每张图片提供基于替代文本的描述，这有助于在图片无法加载或读者使用辅助技术时提供信息。
4.3 标注框
标注框包含与正文分离的辅助性文本。它应与正文区别对待，因此请让作者了解在何种情况下适合使用这种传达信息的方式，同时避免过度使用。
第五节：SEO与可读性
5.1 关键词优化
在为知识库撰写文档时，您不能忽视SEO的重要性。指导您的作者使用关键词优化，以确保您的内容能够被搜索引擎轻松索引，从而在用户搜索特定问题的帮助时显示在搜索结果中。要求您的作者在整个内容中使用正确的关键词以进行全面优化。
5.2 描述性标题与网址
搜索引擎偏爱描述性标题和网址，因此请务必要求撰写者在标题和网址中使用恰当的描述。这意味着不要将网址保留为一串数字，而应清晰描述文章内容，并用短横线分隔单词。在Baklib中，您可以自动生成适合搜索引擎的标题，用于您的文章。
5.3 内部链接
通过确保撰写者在内容中包含指向知识库相关页面的内部链接，来展示您内容之间的关联性。内部链接向搜索引擎传递信号，表明您的站点充满有用的内容。内部链接应像任何其他链接一样构建：使用清晰的关键词短语，并链接到包含该主题的页面。
第6部分：可访问性与本地化
6.1 简洁语言
与写作风格类似，您需要指导撰写者在所有面向最终用户的文档中使用简洁的语言。这意味着尽可能使用直白的术语，例如使用“使用”而非“利用”，并为产品的每个组件使用最直观的名称。
6.2 便于翻译
为了更有效地在不同语言中本地化您的内容，请以便于翻译的方式撰写内容。无论您使用机器还是专业翻译人员来翻译内容，都应避免使用母语特有的习语，并尽可能使用短句，减少从句数量。
6.3 可读性
可读性意味着不同教育水平和技术能力的用户都能轻松理解您的内容。请告知您的撰稿人，可读性是首要关注点：像 Hemingway 这样的工具可以帮助您将可读性分数尽可能降低。
第 7 部分：风格指南中的人工智能与自动化
7.1 AI 生成的摘要
让您的撰稿人知道您正在使用 Baklib 等软件通过 AI 生成文章摘要。这些摘要可以对您的文章进行简洁的解释，而无需用户阅读全文，从而为您的技术撰稿人和目标受众节省时间。
7.2 自动化标签
AI 可以自动为您的文档生成标签，为用户提供更多方式来搜索与其初始查询相关的有用内容。撰稿人无需自己思考更多标签，他们可以直接向 Baklib 请求一系列与所讨论文章完美相关的标签。
7.3 元数据和搜索优化
提供关于元数据和搜索优化的有用指导。AI 可以根据您的内容正文自动生成文章元数据，以显示在搜索引擎结果中。元描述是对文章主题的简洁描述，对搜索引擎友好。
并非所有内容都关于撰写。您的知识库风格指南应指导写作者找到可提供内容效果洞察的AI驱动分析，从而使您能够优化文档，使其对用户更有帮助。与其持续创建更多内容，不如识别出可以改进的文章。
观看我们的视频，了解如何仅需几次点击即可完成文章的创建和发布，从草稿到上线
关键要点回顾
创建知识库风格指南时，您需要包含许多元素，以为您的技术写作者提供最全面的支持。知识库风格指南是一份内部文档，包含如何为您公司独特的知识库编写文档的说明。
从图像的使用到语调和语气，再到对搜索的考量，您应该讨论您希望标准化的知识库的任何方面，以确保知识库内容以一致的声音传达。即使是链接的呈现方式，也可能区分出专业资源和业余拼凑的网站。
当然，您的风格指南本身也可以成为一个知识库：在 Baklib 中，您可以创建一个额外的知识库来配合您的文档，用以指导您的员工如何编写内容。如果将风格指南和文档放在一起，技术写作者更有可能使用前者。
借助强大的知识库风格指南来标准化您的文档流程。
