Przejdź do treści
Biblioteka skilli
Programowanie · Pisanie

handover-doc

/handover-doc

Analizuje projekt z historii Git i plików lokalnych, tworząc jeden plik HTML z interaktywną mapą myśli jako dokument przekazania.

Repozytorium
handover-doc ↗
Licencja
MIT
Ostatnia zmiana repozytorium
02.11.2026

Ocena i bezpieczeństwo

100/ 100Klasa: dobry
Format25 / 25
Frontmatter z nazwą i opisem, poprawna nazwa, opis do 1024 znaków, nazwa zgodna z folderem.
Odkrywalność25 / 25
Opis mówi, kiedy użyć skilla, ma sensowną długość i jest w 3. osobie.
Treść35 / 35
Co najmniej 150 słów i do 500 linii, nagłówki, listy kroków, przykłady albo kod.
Higiena15 / 15
Bez zaślepek typu TODO, bez ścieżek Windows, z licencją.
Ryzykobrak sygnałów w skanie
Pliki w paczce
6
Skrypty
0
Komentarze HTML
0
Adresy URL w SKILL.md
2
Przestarzałość

Brak sygnałów. Repozytorium zmienione 02.11.2026, bez odwołań do wycofanych modeli i API.

Licencja

MIT, otwarta: można używać i zmieniać, z zachowaniem informacji o autorze.

Co robi i kiedy

Analizuje projekt z historii Git i plików lokalnych, tworząc jeden plik HTML z interaktywną mapą myśli jako dokument przekazania.

Oryginalny opis (EN)

通过 Git 提交历史与本地文件分析项目,生成含交互式思维导图(simple-mind-map)的前后端通用交接文档(单一 HTML 文件)。当用户提到交接、交接文档、项目交接、离职交接、移交、handover 时调用。

Jak działa

  1. 定位
  2. 产物
  3. 工作流程(六步)
  4. 必填字段:相关人员
  5. 安全红线
  6. 质量要求
Sekcje z nagłówków SKILL.md, w oryginale · 174 linii, 606 słów
Podgląd SKILL.md
---
name: "handover-doc"
description: "通过 Git 提交历史与本地文件分析项目,生成含交互式思维导图(simple-mind-map)的前后端通用交接文档(单一 HTML 文件)。当用户提到交接、交接文档、项目交接、离职交接、移交、handover 时调用。"
---

# 前后端项目交接文档生成(含思维导图)

## 定位

面向任意前端 / 后端 / 全栈项目的通用交接文档生成技能。
**数据来源仅限 Git 仓库与本地文件**,不访问任何外部服务。

核心目标:
1. 明确"做了什么"——每条结论可追溯到提交哈希或文件路径
2. 接手人不问人也能上手——环境搭建、命令、坑位齐全
3. 用交互式思维导图呈现项目全貌

## 产物

| 文件 | 说明 |
|---|---|
| `交接文档-<项目名>.html` | 单一 HTML:思维导图(simple-mind-map,BootCDN)+ 十二章节 + 打印/导出 PDF 样式 |

输出位置默认项目根目录;用户指定路径则按其指定。

## 工作流程(六步)

### 第 1 步:识别项目形态(读本地根目录文件)

| 形态 | 判断依据 |
|---|---|
| 前端 | package.json、vite.config.* / vue.config.* / next.config.*、src/、index.html |
| 后端 | pom.xml、build.gradle、go.mod、requirements.txt、pyproject.toml、*.csproj、composer.json |
| 全栈 / monorepo | 前后端特征同时存在,或含 pnpm-workspace.yaml、apps/*、packages/* |

### 第 2 步:信息收集(并行执行,只读不写)

**A. Git 历史("做了什么"的核心依据)**

```powershell
# 提交明细(哈希|日期|说明),取最近 500 条
git log --no-merges --pretty=format:"%h|%ad|%s" --date=short -n 500
# 贡献者统计
git shortlog -sn --no-merges
# 分支与远程
git branch -a; git remote -v
# 最新提交(写入文档头部)
git log -1 --pretty=format:"%h %ad %s" --date=short
# 首次提交(推算开发周期)
git log --reverse --pretty=format:"%ad" --date=short | Select-Object -First 1
# 变更热度 Top20(定位核心模块)
git log --name-only --pretty=format: | Where-Object {$_} | Group-Object | Sort-Object Count -Descending | Select-Object -First 20
```

按 Conventional Commit 归类:feat(功能)/ fix(修复)/ refactor(重构)/ docs / style / perf / chore。

**B. 本地文件**

1. 项目文档:README.md、记录.md、CHANGELOG.md、技术清单.md、docs/ 目录
    - **README.md 逐项比对引入**(项目自带的官方说明是第一信息源):将 README 内容与环境搭建、构建部署、工程结构、接口等章节逐项比对——已覆盖的不重复;未覆盖的关键信息(如登录/认证流程、代码分割与构建配置细节、特殊部署约定)引入对应章节正文并标注"引自 README.md";附录文档索引中注明"关键信息已引入第 X、Y 章,原文可作交叉核对"
2. 依赖版本:package.json / pom.xml / go.mod 等(取精确版本号)
3. 工程结构:`git ls-files`(排除 node_modules、dist、.git),梳理目录树与模块职责
4. 环境配置:vite/vue 配置、nginx conf、Dockerfile、CI 配置;`.env.*` **只读键名,禁止读取或输出值**
5. 路由与接口:前端 router 配置 → 页面清单;后端 Controller / api 目录 → 接口清单
6. 数据模型:迁移脚本 / 实体类 / 建表 SQL(只取结构,不取业务数据)
7. 相关人员:产品/业务负责人、发布人员无法从代码推断,必须询问用户确认,禁止留空或臆测;对接的前端/后端人员可参考关联仓库 git shortlog 获取候选,仍需用户确认

信息量大时可用 Explore 子代理并行收集(同时不超过 3 个)。

### 第 3 步:归纳"做了什么"

- 每条工作项标注依据:提交哈希、记录.md 章节或代码路径
- 按模块归组:功能开发 / 缺陷修复 / 重构优化 / 文档与工程化
- 汇总工作总量:提交总数、开发周期、主要贡献者、功能模块数
- 拿不准的不写,宁缺毋滥
- **风险定性以用户口径为准**:用户确认项目正常运行 / 无遗留问题时,风险章节定名为"潜在风险与注意事项",开头明示"正常运行上线、无阻塞性遗留问题";偶发缺陷(有兜底、正常运行未触发)标"中"不标"高",原待办任务改定性为"可选优化项";禁止把非阻塞事项夸大为高危问题吓退接手人

### 第 4 步:构建思维导图(simple-mind-map 组件)

大纲模板(按实际项目裁剪,一级节点顺序与章节优先级一致):

```markdown
# <项目名> 交接导图
## 项目概述
### 业务定位
### 当前状态
## 相关人员
### 产品/业务负责人
### 项目发布人员
### 前端/后端对接人员(按项目形态裁剪)
## 快速上手
## 工程结构
## 功能模块
## 潜在风险与注意事项
## 构建与部署
## 接口概览
## 技术栈
## 已完成工作
## 交接确认清单
```

用 Read 工具读取本技能目录下的 `template.html`,将大纲填入脚本区的 `MIND_DATA` 树形对象(`{data:{text}, children:[]}` 递归结构)。

**集成规范**(simple-mind-map 0.14.0,资源固定经 BootCDN):
- CSS:`https://cdn.bootcdn.net/ajax/libs/simple-mind-map/0.14.0/simpleMindMap.esm.min.css`
- JS:`https://cdn.bootcdn.net/ajax/libs/simple-mind-map/0.14.0/simpleMindMap.umd.min.js`
- 构造函数:`window.simpleMindMap.default`(UMD 全局对象只暴露 default 键)
- 固定选项:`readonly: true`、`layout: 'logicalStructure'`、`fit: true`、`theme: 'fresh-green'`
- 容器必须给定高度(模板默认 640px),且加 `#mindMapContainer * { margin:0; padding:0 }` 防止文字偏移
- 工具栏按钮只允许使用已验证的视图 API:`mm.view.enlarge()` / `narrow()` / `fit()` / `reset()`;展开/折叠用组件自带的节点圆点交互,**禁用 `expandAll` / `collapseAll`**(0.14.0 不存在)与 `setFullData` 改 expand 字段方案(实测无效)
- 除导图库外文档零网络依赖;不引入 markmap 等其他思维导图库
- **异步加载(强约束)**:JS 必须写成 `<script defer src="…umd.min.js" onerror="window.__mmLibFailed=true"></script>` 并置于文档**末尾**,严禁在文档中段放同步 `<script src>`。该库 min 版约 6.5MB,同步加载会中断 HTML 解析,导致第 3 章及之后章节长时间不渲染(实测内网下载约 53 秒,用户表现为"内容缺失");CSS 仅约 24KB,保留同步加载不影响
- **初始化与兜底**:初始化脚本自身不做加载,只轮询等待库就绪——每 200ms 检测 `window.simpleMindMap && window.simpleMindMap.default`,就绪则实例化导图;脚本加载失败(`window.__mmLibFailed`)或超时(150s)则渲染 `.mm-fallback` 兜底文案。容器内须预置 `.mm-loading` 加载占位,禁止留空白容器
- **验证须覆盖两个场景**:①拦截/阻断 CDN 请求,确认正文(第 3 章及之后)仍完整渲染且导图区显示兜底提示;②库正常就绪,确认导图节点渲染、工具栏按钮可用

### 第 5 步:生成 HTML 交接文档

基于 `template.html` 的结构与样式生成,**标准十二章节,按接手优先级排序**(让接手人先"跑起来、避坑",再看历史与明细):

1. 项目概述(定位、背景、当前状态、仓库信息 + 相关人员表 + 接手速览五步上手)
2. 思维导图总览
3. 快速上手 / 环境搭建(前置依赖 → 安装 → 启动 → 验证 → 常见问题;版本强依赖项加粗警示)
4. 工程结构与模块职责(目录树 + 职责表)
5. 功能模块详解(只写核心模块,非核心一句话带过)
6. 潜在风险与注意事项(现象 + 定位 + 建议,按高/中/低分级;**项目状态不明时先问用户**——正常运行上线的项目按第 3 步"风险定性以用户口径为准"降级表述,章首明示无阻塞性遗留问题)
7. 构建与部署(命令、产物、Nginx/Docker 要点、多环境)
8. 接口清单(方法 | 路径 | 用途 | 备注)
9. 技术栈清单(前端 / 后端 / 数据与中间件,精确版本,禁止 ^ ~ 模糊表述)
10. 已完成工作(工作总量摘要 + 主干工作一览总表,按功能域归组;**禁止罗列琐碎逐条提交明细**,注明完整明细用 `git log --oneline` 查看)
11. 数据模型(表 / 实体结构,不含业务数据;**纯前端项目无本地数据模型时整章删除**,不输出空壳章节,关键业务字段口径并入接口清单一句话说明)
12. 交接确认清单(可勾选)+ 附录(联系人、文档索引;附录命令速查与构建部署章重复时省略,仅保留其未覆盖的命令)

### 第 6 步:验证与交付

- [ ] 相关人员四类角色已填写或明确标注"待确认"
- [ ] 版本号全部为实测精确值
- [ ] 密钥 / Token / 密码 / 连接串零出现(.env 仅键名)
- [ ] 所有工作项有出处
- [ ] 思维导图经 simple-mind-map 渲染正常(BootCDN 可达环境下打开验证,节点可交互,工具栏按钮可用)
- [ ] 导图库已用 defer 异步加载且置于文档末尾:阻断 CDN 时正文(第 3 章及之后)仍完整渲染、导图区显示 `.mm-fallback` 兜底提示,无空白容器
- [ ] 除思维导图库(BootCDN)外文档零网络依赖,内网直接打开正文可读
- [ ] 环境变量键名逐个核实过实际引用(源码零引用的键明确标注"无效遗留键")
- [ ] README.md 已逐项比对:未覆盖的关键信息已引入对应章节并标注出处,索引注明交叉核对关系
- [ ] 打印预览 A4 分页正常

交付时用 computer:// 链接告知用户文件位置。

## 必填字段:相关人员

每个项目的交接文档必须包含"相关人员"表,**按项目形态裁剪**(本项目自身角色不填,只填对接方):

| 项目形态 | 需填写的角色 |
|---|---|
| 前端项目 | 产品/业务负责人、项目发布人员、**后端人员**(对接方) |
| 后端项目 | 产品/业务负责人、项目发布人员、**前端人员**(对接方) |
| 全栈 / monorepo | 产品/业务负责人、项目发布人员、前端人员、后端人员 |

填写要求:
- 产品/业务负责人:必填;负责需求对接与业务答疑,代码中无法推断,必须询问用户
- 项目发布人员:必填;按实际发布方式填写——①有 CI/CD 则填"CI/CD 流水线(注明 GitLab CI / Jenkins 等平台)";②手工发布则写明发布途径:"自发布(开发者自行构建手动部署)"或"自发布 / 可委托 XX 代发",接手人需知道发布职责可自持也可移交;确无则填"无(待确认)"
- 前端/后端人员:填本项目的对接开发负责人,可参考关联仓库 git shortlog,需用户确认
- 未涉及的角色整行不输出;确实未知时填"待确认",并同步列入第 12 章交接确认清单
- 多人时全部列出,并注明各自负责的模块
- 思维导图中必须有"相关人员"一级节点,逐角色展开(同样按形态裁剪)

## 安全红线

- 禁止输出 .env 值、密钥、账号密码、数据库连接串;敏感项写"已配置,交接时线下提供"
- 数据库只交接结构,不导出业务数据
- 遵守仓库许可与公司保密要求

## 质量要求

- 全文简体中文;代码、命令、包名保留英文
- 优先表格与列表,长段落拆短
- 术语首次出现时给一句话解释
- **受众适配**:默认按"接手人为前端/后端开发者"编写——Conventional Commit 类型(feat/fix/refactor 等)不逐条释义,一行统计即可;贡献者只留主力与交接人,次要人员不列流水账;axios/moment/sass 等通用常识依赖不单列表格行(package.json 可查);与前置章节重复的附录内容直接省略
Pliki w paczce (6)
  • .gitignore 1 KB
  • LICENSE 1 KB
  • README.en.md 6 KB
  • README.md 6 KB
  • SKILL.md 12 KB
  • template.html 31 KB

Wersje

W bazie nie ma innych skilli o nazwie handover-doc.

Migawka bazy z 13.11.2026 · wersja paczki 37057dcfb2c8 (skrót SHA-256 całej paczki)

Pobrania w ostatnich 30 dniach: 0 · ranking

Zgłoś problem z tym skillem: szkodliwa treść, błędny opis albo prośba autora o usunięcie.

Podobne skille

  • 90project-handover-generator
    Przygotowuje dokument przekazania projektu na podstawie kodu i artefaktów: architekturę, wdrożenie, konfigurację, ryzyka i zaległe prace.
  • 100release-doc
    Tworzy notatki wydania lub dokument wydania z historii git dla dowolnego zakresu (tag, gałąź, przedział czasu), jako markdown i samodzielną prezentację HTML.
  • 100release-doc
    Tworzy notatki wydania lub dokument wydania z historii git dla dowolnego zakresu (tag, gałąź, przedział czasu), jako markdown i samodzielną prezentację HTML.
  • 100vibe-handover-doc
    Pisze dokument przekazania pracy, by inna osoba, agent albo narzędzie mogło wznowić wieloetapowe zadanie od zera.
  • 90handover
    Zapisuje krótki, datowany wpis o stanie sesji kodowania w pliku RepoHandover.md, aby można było wznowić pracę.
  • 100resumable-handover
    Przygotowuje wersjonowany dokument przekazania pracy z jednym konkretnym punktem wznowienia dla osoby przejmującej.

Uwagi i zgłoszenia

Wiadomość trafi do Bartosza Sokolińskiego. Adres e-mail jest potrzebny tylko do odpowiedzi. Szczegóły w polityce prywatności.