Agent Skills
返回列表
📁

应用文档生成器

办公效率 更新于 2026.08.29

将以下提示词粘贴到你的 AI 对话框中:

请根据 https://skillhub.cn/install/skillhub.md 的步骤,将 @kunlungrowth/app-docs 安装到 AI 助手中。

技能介绍

要解决的问题

很多内部系统、SaaS 后台和迭代中的 Web 应用并不缺界面,缺的是能教会用户操作的文档。截图堆砌不等于文档:如果只保留页面快照,读者无法知道点哪里、按什么顺序操作、某个表单在什么状态下必填。对刚接手销售后台、运营后台或内部平台的新成员来说,这种信息缺口会直接转化为反复提问和试错成本。

技能如何工作

这个技能把作者当作技术文档工程师。输入是 应用 URL、应用名称、鉴权方式、深度等级 和 读者对象;若应用已在本机运行,也能从 wrangler.jsonc 或开发服务器中探测入口。

工作流分成五个步骤:

  • 收集应用信息:确认 URL、名称、会话复用或测试账号、quick / standard / thorough / exhaustive 深度,以及读者是终端用户、管理员、新成员还是客户。
  • 盘点全部页面:读取侧边栏与顶部导航,点击一级和二级菜单,记录子页面、页内标签页、设置、个人资料、管理区和帮助页,标注表单、按钮、筛选器等交互元素。
  • 逐页撰写:按深度表决定是否覆盖空状态、错误状态、暗色模式、375px 移动端、增删改查边界、设置项、快捷键、搜索筛选组合、角色权限和 API/集成。每个页面输出一句话定位、截图、你会看到什么、你能做什么、主流程分步和提示。
  • 补写支撑章节:入门、导航指南、快捷键参考表、故障排查、管理员指南。
  • 确定输出形式:默认 Markdown 写入 docs/USER_GUIDE.md,截图使用相对路径 screenshots/NN-描述.png;exhaustive 或明确要求时输出单文件 HTML,含目录侧栏、打印友好和暗色支持。

产物是 AppDocsArtifact,可交给 project-docs 或静态站点生成器继续发布。

适用边界

  • 纯后端服务没有界面,不适合截图式文档。
  • 需要真实生产账号又无法提供的私密系统,应改用静态说明。
  • 技能只产出文档,不修改应用代码,也不自动发布。

使用场景

  • 新销售后台上线,需要给销售团队新成员产出一份包含登录、客户列表、创建订单等主流程的可视化操作手册
  • SaaS 产品迭代后文档过期,需要重新截取各功能页面并补充错误状态和空状态说明,形成可发布的 HTML 帮助文档
  • 内部运维平台只有开发能看懂,需要给非技术管理员生成一份 thorough 深度的用户指南,覆盖用户管理、权限差异和数据导出
  • 客服团队需要一份面向终端客户的产品帮助文档,包含页面截图、快捷键参考表和常见错误排查步骤

适合人员

  • 产品经理:上线了新的后台功能但团队没人写文档,需要为产品生成一份读者能照着操作的使用手册
  • 新成员:刚加入销售团队需要快速学会 CRM 后台的日常操作,希望有截图式的分步指引
  • 运维管理员:负责维护内部 SaaS 系统,需要为不同角色的同事生成权限差异化的操作指南
  • 技术文档工程师:需要自动化生成前端应用的截图与说明,减少手工撰写和截图的重复工作