围绕实用问题组织解读知识库
知识库如果按读者带来的问题组织,就会更好用。想记录不确定出生时间的人,需要实际方法;想知道一件历史塔罗实物能说明什么的人,需要关于实物的证据。把两者都塞进宽泛的主题标签,可能看不见用途上的区别。
本文为 Mystilink 知识库提出一种组织方式。它是待审的编辑方案,不是在介绍现有公司项目,也不承诺未来会发布什么。决定采用哪种结构之前,可以先用当前这批内容试验。
先列出问题清单
用普通语言汇总各篇文章回答的问题。“怎样记录不确定的输入?”比“个人洞见”这种大标签,更有助于组织指南。“图像来自哪个版本?”则指明了一项研究任务,也可能连到几个象征传统。
每篇稿件都写一个主要问题,再列出它确实回答的次要问题。主要问题如果需要几项互不相关的分句才能说清,就拆开文章或缩小范围。读者打开知识库搜索结果前,应已大致知道能学到什么。
有获准使用的来源时,可以采用真实提问,并作适当隐私审查。预先准备的编辑问题可以填补空缺,但应标为编辑策划材料。没有真实证据支持,就不应把它们称为客户需求。
给不同阅读任务安排不同路径
学习指南应帮助读者完成一项范围明确的任务,比如比较两份解释、记录一次咨询,或给学习卡附上出处。例子要具体到别人能照着做;虚构时,标注也要清楚。
研究文章应解释,证据允许读者作出怎样的判断。写历史牌组,应指出实物与版本;写翻译,应展示措辞为什么会影响问题。文章可以引出实际练习,但证据仍须看得见。
产品帮助应描述已按相关版本核查的行为。仅依据仓库检查写成的教程,在核实已发布构建版本之前,需要标明它描述的是代码实现。提案应有清楚独立的状态,避免读者去找尚未证实可用的控件。
编辑流程文章可以说明拟议标准、示例标签和纠错方式。在负责团队采纳之前,应保持草案状态。知识库分类不能把提案变成公司政策。
谨慎借助方法连接不同传统
保留不确定输入这类跨主题方法,可以帮助使用不同体系的读者。但相连的例子仍应保留各自术语和约定。塔罗牌位、命盘宫位和咨询时选读的文本段落,不能因为放得进同一笔记模板,就互相替代。
用一段简短过渡,说明哪些方法可以共用。比如,记录出处的指南可用于几种体系,因为它们都有读者想追溯的说法。随后还要说明哪些仍是各自特有的,例如相关版本或计算约定。
不要用发现命运、解码人格这类宽泛承诺来统领所有内容。这种标签会遮住实际任务,也可能夸大知识库能够证明的事。一个实际问题,能更准确地告诉读者为什么要打开文章。
让文章入口有助于选择
每个条目应展示标题、简短摘要,以及涉及哪类任务。读者在入门指南与来源比较之间选择,点击前知道区别会有帮助。政策草案和拟议产品功能,需要时应显示状态标签。
前置要求应简短具体。文章可能需要已有命盘、几个术语的基础,或查阅特定资料的条件。练习能用虚构数据,就明确说明。读者不应觉得,只为学习一种记录方法,就必须输入私人信息。
链接应指向接下来有用的行动。看完翻译文章,可以在笔记中比较两小段文字;看完分享案例的指南,可以检查同意与隐私遮盖流程。不要为了增加链接数量,硬加关系松散的去处。
检查组织方式是否有效
用几个贴近实际的任务测试草案结构。请审阅者寻找如何记录不确定出生时间、核查产品说法,以及区分引文与解释的帮助。观察他们去哪里找,又被哪些标签误导。
依据观察修改类别和摘要。某个主题文章很多,也可能完不成常见任务;另一个主题,或许一篇细致指南就足够回答现有问题。覆盖数量能帮助发现空缺,却不能单独证明有用。
不只记缺什么主题,也记缺什么证据。拟议产品教程可能要等构建版本核查,研究稿可能需要更好的来源。把依赖条件标出来,可以避免为了填满分类而降低发布标准。
随文章变化维护知识库
一套正式采纳的流程,应给失效链接、变化的产品行为和已纠正的说法分别指定负责人。文章用途改变时,也更新摘要和指向它的链接。指南变成提案后,导航标签不应还让人以为那是当前操作说明。
从一张小而可查的内容图开始,首轮审阅后再改。知识库应帮助读者找到问题、理解所提供的证据,并选一个做得完的下一步。扩充之前,可以用这些具体任务判断拟议结构是否合适。