前言¶

接手存量项目时，常见情况是：代码和界面能跑，但 BRD、PRD、设计说明、测试用例、运营手册要么没有，要么和当前实现不一致。人工从仓库和 UI 里梳理业务逻辑再按各文档模板重写，耗时长，且不同人写的章节结构、分析视角容易不统一。

下面介绍 SkillHub 上的社区 Skill「从代码和 UI 逆向提取业务逻辑文档」（坐标 @user_35d642b5/code-to-doc-generator，版本 1.0.0）。它的思路是：在 Agent 读取代码与 UI 的前提下，按 Skill 内约束的写作维度与格式规范，生成或更新多种类型的项目文档，并支持用自然语言触发「逆向分析」「同步文档」「文档漂移」等维护动作。

这是什么¶

一句话定位：面向任意项目类型（Web、后端服务、移动端、桌面应用等），从代码与 UI 反向归纳业务逻辑，并输出多类标准化文档的 Agent Skill。

维护与分发：由 SkillHub 社区发布者 user_35d642b5 提供，分类为 dev-programming，来源标记为 community。SkillHub 页面显示该 Skill 评分为 100000、下载 2654 次；标签标明 requires_api_key=false，安装使用本身不依赖额外 API Key 配置。

它解决的核心问题是：在缺少或过时文档时，用同一套分析视角把「实现里真实存在的业务」落到 BRD/MRD、PRD、概要/详细设计、测试与运维类文档上，减轻文档漂移和手工对齐成本。

核心功能¶

以下能力均来自 SkillHub 官方简介与页面说明，可按文档类型与触发词在对话中选用。

文档类型¶

Skill 声明可生成或完善的项目文档包括：

• 需求与商业类：BRD、MRD、PRD
• 设计类：HLD 概要设计、DDD 领域设计、LLD 详细设计、编码指南
• 测试类：BDD / SIT / E2E / UAT 等测试文档
• 运营与工程类：运营手册、操作指南、SLI/SLO 监控文档、CI/CD 文档

写作约束¶

简介中强调：会约束文档的写作维度、分析视角和格式规范，而不是只输出一段自由发挥的说明。具体章节模板与检查项写在 Skill 自带的 SKILL.md 及引用材料中，由 Agent 在安装后按 Skill 规范执行。

触发方式¶

官方列出的触发词包括：生成文档、业务文档、运营手册、操作指南、需求文档、PRD、BRD、MRD、概要设计、HLD、详细设计、LLD、DDD、领域设计、测试文档、编码指南、逆向分析、完善文档、更新手册、同步文档、文档漂移、反向同步。在已启用该 Skill 的 Agent 会话里，用上述词组说明目标文档类型与范围即可唤起对应流程。

安装与启用¶

Skill 基于通用 SKILL.md 格式。官方页面给出的安装指引是：让 Agent 依照 SkillHub 安装说明 安装坐标 @user_35d642b5/code-to-doc-generator。

1、安装 SkillHub CLI（如尚未安装）¶

先确认本机是否已有 skillhub：

command -v skillhub && skillhub --version

若未安装，可按安装文档执行完整安装（CLI + 默认 Skill）：

curl -fsSL https://skillhub-1388575217.cos.ap-guangzhou.myqcloud.com/install/install.sh | bash

仅需 CLI 时：

curl -fsSL https://skillhub-1388575217.cos.ap-guangzhou.myqcloud.com/install/install.sh | bash -s -- --cli-only

2、安装本 Skill 到当前 Agent 的 skills 目录¶

安装文档要求：必须用 --dir 指向当前 Agent 识别的 skills 目录，否则默认装到 ./skills/ 可能不会被加载。

skillhub install user_35d642b5/code-to-doc-generator --dir <skills 目录>

常用客户端的 skills 路径（摘自官方安装文档）：

• Cursor：~/.cursor/skills/
• Claude Code：~/.claude/skills/
• Codex：~/.codex/skills/ 或项目下的 .agents/skills/

也可将下面提示词发给支持 Skill 的 AI，由其按安装文档完成安装：

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

安装后按你所用客户端的要求重启或刷新 Agent，使 Skill 生效。

典型用法¶

官方页面未提供单独的业务案例仓库；可复现的用法是：在已打开目标项目的工作区中启用 Skill，用触发词说明文档类型、范围与输出位置。下面步骤与官方能力描述一致，便于自行验证。

1、在 Cursor（或其他已配置 skills 目录的 Agent）中打开待分析的项目仓库，确认 @user_35d642b5/code-to-doc-generator 已安装到对应 skills 目录。

2、在对话中明确文档类型与素材范围，例如：

逆向分析当前项目，生成 PRD：覆盖用户注册与登录模块，依据后端 API 与前端页面实现，按 Skill 规定的 PRD 格式输出到 docs/prd-login.md。

3、若要补齐设计或测试文档，可换用对应触发词：

根据现有代码生成 HLD 概要设计，说明服务边界与主要数据流。

完善文档：对照当前实现更新运营手册中的部署与回滚步骤，处理文档漂移。

4、生成后由人工评审：Skill 输出的是基于代码与 UI 的归纳，权限边界、合规表述、未实现需求等仍需团队确认，不宜直接当作对外正式基线而不审阅。

适用场景与注意¶

适合谁

• 维护存量系统、文档缺失或严重过时的开发、架构或 QA 同学
• 需要在较短时间内补齐 PRD、设计说明、测试说明、运营/CI 文档清单的团队
• 希望多种文档在结构、视角上保持一致、减少「每人一套模板」的情况

使用上需注意

• 逆向文档反映的是当前实现；若代码本身存在临时方案或技术债，文档会如实体现，不能替代产品决策。
• 大仓库应缩小模块范围（目录、服务名、功能点），否则单次上下文可能无法覆盖全部逻辑。
• SkillHub 统计为社区 Skill（下载 2654、安装数在 API 侧可能为 0），升级与问题反馈需通过 SkillHub 页面与发布者渠道，本文不臆测 SLA 或企业支持。
• 未在官方说明中要求 API Key；若你本地 Agent 另有模型或工具链配置，与 Skill 本身无关。

结尾¶

「从代码和 UI 逆向提取业务逻辑文档」把「读代码 + 读 UI → 按类型写规范文档 → 后续同步防漂移」收敛成一条可在 Agent 里重复执行的 Skill 路径，适合作为存量项目文档建设的起点，而不是终点——审阅与产品对齐仍不可省略。

官方 SkillHub 页面：https://www.skillhub.cn/skills/user_35d642b5/code-to-doc-generator
API 元数据地址：https://api.skillhub.cn/user_35d642b5/code-to-doc-generator