SuperAPI AI 工具集

kb-authoring

写作与研究

查看项目

更新于 10-16 02:36

技能介绍

用途:kb-authoring 用于撰写或更新知识库文章、FAQ、故障排查指南和已知问题文档,帮助团队产出可被客户搜索到、可直接解决问题的支持内容。

主要能力:提供文章结构规范,每篇文章包含标题、摘要、正文、交叉引用和元数据(分类、标签、目标读者、最后修改日期)。给出四类文章蓝图:操作指南(How-To)、诊断排查(Troubleshooting)、快速问答(FAQ)和已知问题通告(Known-Issue)。同时规定标题写法、关键词策略、开头句式、格式标准(标题层级、编号列表、项目符号、加粗、代码块、表格、提示框、段落长度)以及分类层级与交叉链接原则。

使用方式:按文章类型套用对应蓝图。操作指南按“开始前准备—分步指令—确认成功—故障排查—另见”组织;诊断文章按“现象—原因—修复方案—预防复发—更多帮助”组织;FAQ 首句直接作答;已知问题通告需标注状态、影响范围、最后更新日期、临时方案、解决时间线和变更日志。标题应使用客户会输入搜索框的语言,包含具体工具名、症状或原始错误字符串。

适用场景:客户支持知识库、产品文档、FAQ 页面、故障排查库和已知问题公告的编写与维护。

限制:资料未提供具体安装命令、代码示例、平台支持、收费方式或效果数据;内容生命周期部分给出维护节奏建议(如同行评审、季度审计、月度陈旧内容检测、每周刷新已知问题状态),但未说明具体工具集成方式。