交接给另一位同事或新会话时,对方不应依赖你记得的聊天内容。下面接续小型静态站案例,给出一份完整交接文件。它的职责是告诉接手人“从哪里开始、哪些结论有证据”,而不是保存全部对话。
先收集现状,不先写成绩
在项目根运行只读检查:
Get-Location
node --version
git status --short
git diff --stat
git diff --cached --stat
Get-Content -LiteralPath package.json
不要把存在某命令解释为已运行,更不能把退出码 0 解释为全部业务正确。若本轮获准运行构建,可在创建 output/ 目录后保存真实记录:
npm run build *> output/build-handoff.log
$buildExitCode = $LASTEXITCODE
$buildExitCode
若退出码不是 0,保留原错误,不写“已通过”。该命令会生成文件,只有授权的工作阶段才执行。记录构建时的分支、提交或文件状态,便于之后判断日志是否过期。
一份完整交接文件
保存为 docs/handoff.md。以下是教学模板,刻意把未获得的实测证据标成“尚未执行”,不能直接作为完成报告发布。
# 首页副标题任务交接
记录性质:教学模板;以下待验证项不能视为实测结果。
目标:更新首页副标题,保留标题、页面结构和输出位置。
项目:site-map-demo;接手时重新核对实际绝对路径。
状态:内容源已准备,生成与浏览器检查待执行。
## 当前文件与职责
- content/home.json:手写 title/subtitle,是内容来源。
- templates/home.html:页面模板,占位符决定内容位置。
- scripts/build.mjs:读取内容和模板,写出 public/index.html。
- public/index.html:生成物,不能只改它完成需求。
## 已确认决定
- 只改 subtitle;不更换模板和构建方式。
- 生成物由脚本更新,避免下次构建覆盖手工改动。
- 本任务不包含提交、推送或部署。
## 环境与运行
- Node.js 20+,不需要第三方依赖。
- 命令必须在项目根运行。
- 构建:npm run build。
- 本例没有 npm test 脚本,不要写测试通过。
- 验证:对照 JSON 与生成页面,再人工查看页面。
- 实际 Node 版本、分支和提交:接手时填写。
## 验证状态
- 源文件字段检查:待接手人核对。
- npm run build:尚未执行。
- output/build-handoff.log:计划证据位置,目前不代表文件存在。
- 浏览器查看:尚未执行。
- 部署:未执行,也不在本轮范围。
## 未完成与第一步
1. 先读当前 content/home.json,确认 subtitle 是否已经被别人更新。
2. 核对 git status 与 diff,保留已有修改。
3. 无冲突时运行构建,记录真实退出码。
4. 核对 public/index.html 的副标题与特殊字符转义。
5. 把本节改成实际结果和遗留问题,再交接。
## 风险与停止条件
- 若实际路径、生成器或需求与本记录不同,先报告差异。
- 不用 git reset 或全目录覆盖来消除现有改动。
- 没有部署授权,不上传 public/。
交接里写“计划证据位置”,可以让人知道应保存到哪里;但必须与“已有证据”区分。实际完成后填入可访问文件,删掉已不成立的待办。不要复制模板中的教学状态,当成真实工程结论。
让接手人独立走一遍
把任务交给未参与上一轮的人或新会话:
先只读 docs/handoff.md 和相关源文件。
指出文档与实际状态不一致之处,回答内容源、生成物、运行目录、未完成项和禁止范围。
不要自动执行构建;先给出你准备继续的第一步。
能回答文件关系仍不等于能运行;之后在已授权范围让接手人执行那一步,查看是否缺少依赖、环境或证据路径。记录他实际卡住的位置,修改对应说明,而不是继续扩长历史背景。
旧记录与文件不一致时
如果文档说 subtitle 未改,文件却已经是新值,先看当前 diff 和最近修改,可能是另一人完成了;如果日志显示通过,但源码后来改过,日志只证明旧状态。以当前需求、当前文件和可定位记录重新对账。
事实写“哪个文件、哪次命令得到了什么”;决定写“为什么采用这个范围”;风险写“什么仍未证实、谁能处理”。这样接手人才能判断哪一步可以继续,而不是把一长串“已优化、已检查”当作可信状态。
资料来源
- Git status
核对工作区与暂存区状态。
下一步
继续阅读与你当前问题相关的教程:


