Agent Skills
返回列表
代码与 UI 业务逻辑文档生成器

代码与 UI 业务逻辑文档生成器

开发编程 更新于 2026.08.30

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

请根据 https://skillhub.cn/install/skillhub.md,安装 @user_35d642b5/code-to-doc-generator。

技能介绍

文档为什么会失真

很多系统的代码能编译、有 CI,但业务文档没有同样反馈回路:接口变了、规则调整了,文档仍停留在上一版。这个技能解决的问题,是把代码和 UI 中已经存在的业务事实提炼成可维护文档,而不是从旧文档里继续抄。

技能如何工作

  • 先判断模式:没有文档时走生成模式;文档存在但可能漂移时走反向同步模式,以代码为真相源校准。
  • 先确认文档类型:如 PRD、HLD、LLD、测试文档、运营手册、管理员速查手册;类型未明确时不启动分析。
  • 识别项目骨架:从根目录、入口文件、现有文档判断技术栈和模块边界。
  • 提取高密度信息:路由、菜单、i18n、数据模型、权限中间件、错误码、状态机、CI 配置等,按目标读者选择关注点。
  • 按类型深写:PRD 偏用户故事与验收标准,LLD 偏接口、数据结构和异常路径,运营手册偏操作影响、危险等级和业务规则命名。
  • 生成与校准:先建章节骨架,再填内容;推断内容标 [INFER],代码验证事实标 [FACT|文件:行号],完成后检查关联文档是否需要同步。

适用边界与注意点

它适合已有可运行代码、UI 路由或配置文件的业务系统,尤其适合需求文档、架构文档、运维/运营文档的补全与校准。资料不足时不会凭空补全,而是标注不确定项;如果实现偏离设计意图,会把问题交还给用户裁决。

使用场景

  • 接手陌生后台项目,需要从路由、菜单和权限逻辑整理一份运营手册。
  • 代码已改但接口文档和代码不一致,需要按代码校准 HLD 与 LLD。
  • 发布前缺少可测试验收标准,需要从 Service 和状态机提取 PRD 规则。
  • 为新管理员编写速查手册,需说明系统链路、读者路径和危险操作。

适合人员

  • 刚接手遗留管理后台、需要把代码里的权限和业务规则整理成运营手册的运营/产品。
  • 要补齐架构设计、从目录依赖和接口签名提炼 HLD/LLD 的后端工程师。
  • 需要在发布前把异常路径和错误码整理成测试文档的 QA。
  • 要为新管理员编写系统定位、读者路径和危险操作说明的 SRE/管理员。