产品文档引擎
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_99b1d2cb/chanpinwendangyinqing
技能介绍
要解决的问题
产品文档不是没人写,而是写了没人用、找不到、跟不上版本。常见情况是:FAQ 散落在聊天记录里,API 文档和 SDK 版本脱节,发版日志写得像内部通告,用户搜不到就提工单。这个技能针对的不是"文档写得不够多",而是文档体系缺少可执行的流程设计。
核心能力
它覆盖五类核心文档:API 文档、用户手册、发版日志、快速入门指南和技术白皮书。但重心不在写作本身,而在五个工程化维度:
- 信息架构:输出三层目录树,从大类(入门指南 / API 参考 / 功能手册 / 常见问题)到子类再到具体文档节点
- 模板设计:基于
templates/中的标准模板,填入产品信息后即可发布 - 版本管理:文档分支采用
main线上版 /next草稿版,废弃文档打标记而非删除 - SEO 优化:标题格式统一为
{功能名} - {产品名} 帮助中心,并配置 HowTo / FAQPage 结构化数据 - 自助率衡量:跟踪搜索命中率、浏览后工单创建率、无结果关键词 Top20 等指标
工作流程
使用前必须先判断产品阶段:
- 阶段识别:
0→1冷启动、已有产品补文档、还是现有文档重构 - 信息对齐:至少追问 3 个问题——产品定位、目标用户画像、核心功能与 API 情况、现有文档载体
- 生成方案:输出信息架构、Top5 优先文档清单、填好的模板、维护流程、上线后 30 天衡量指标
- 风险自查:检查是否虚构功能、示例参数是否泄露敏感信息、链接是否过期、是否标注适用版本
适用边界
这个技能不代替产品决策——文档是功能的说明,不是 PRD。模板中的示例必须基于用户提供的真实信息,不得虚构。涉及安全、合规、金融场景时需附"请以官方最新说明为准"提示;接入第三方 API 时提醒关注对方服务条款变更。
使用场景
- 产品即将上线,需要从零搭建帮助中心的目录树和首批文档
- 产品迭代快,每次发版后更新文档和发版日志都跟不上
- 开发者把 FAQ 散贴在聊天里,想整理成结构化自助文档
- 用户搜不到已有解答就提工单,需要用指标判断该补哪些文档
适合人员
- 初创团队的工程师,要在功能上线前搭好 API 文档和快速入门
- SaaS 产品的开发者体验负责人,需要统一 SDK、Webhook 与 REST API 的文档结构
- 客服负责人,想把重复回答沉淀成自助文档并降低工单量
- 产品经理,要在每个版本发布时同步发版日志与用户手册