SuperAPI AI 工具集

support-docs

写作与研究

查看项目

更新于 10-15 23:25

技能介绍

用途:当创始人或团队成员需要创建面向客户的文档,帮助用户自行解决问题时启用。触发场景包括“写一篇帮助中心文章”“创建 FAQ”“记录我们的 API”“写故障排查指南”“构建入门指南”,或“支持工单总在问同样的问题”。

主要能力:提供五类模板——帮助中心文章、故障排查指南、FAQ 页面、API 文档、入门指南。核心方法包括:问题—解决—验证模式;以用户语言描述问题再给方案;渐进式披露(先给 80% 用户适用的答案,边缘情况与高级配置后置);可搜索性(标题匹配搜索词、逐字包含错误信息、同时使用技术术语与口语说法);“凌晨 3 点规则”检验能否 2 分钟内解决;文末添加相关文章链接。

使用方式:先确定文档类型与用户入口(搜索、报错、客服链接、应用内帮助按钮),据此定标题与开头;按模板撰写 Markdown 文档;写作使用第二人称现在时、具体 UI 路径(如 Settings > Integrations > Slack)、先展示操作再解释;术语与界面保持一致;每篇文章打标签并标注日期,随产品发布复审;跟踪自助解决率,加入“是否有帮助”反馈组件。

适用场景:面向终端用户、管理员或开发者的自助文档;新用户入门;API 与 webhook 参考;高频工单主题的排查指南。

限制:需要提供产品类型、目标用户技术水平、现有文档、主要工单类别、文档托管工具(如 Notion、GitBook、Zendesk、ReadMe)等上下文;具体主题、受众与常见故障点也需用户提供。资料未提供具体收费、价格或平台支持范围。相关技能:process-docs(需要内部 SOP 处理升级时)、onboarding-flow(入门指南作为新用户引导一部分时)。