| name | coding-session-notes |
| description | 为 vibe-coding 和代码修改会话维护持续追加的 Markdown 变更记录。Use when Codex 被要求编写、继续修改、审查或总结源代码变更,并且需要用中文把每次会话的目标、修改文件、关键决策、验证结果和后续事项记录到仓库根目录 coding/ 文件夹下的 Markdown 文件中,后续会话继续在同一个文件里追加。 |
编码会话记录
使用这个 skill,为 vibe-coding 和代码修改会话维护一份可持续追踪的中文工程记录。
核心流程
- 从当前工作目录定位仓库根目录。优先选择最近的、包含
.git 的上级目录;如果找不到,就使用当前 workspace 根目录。
- 在开始或结束代码修改前,确保仓库根目录下存在
coding/ 文件夹。
- 使用
coding/ 中的一个 Markdown 文件作为持续追加的会话记录。按以下优先级选择已有记录文件:
coding/session-notes.md
coding/ 中唯一的 .md 文件
coding/ 中最近修改过的 .md 文件
- 如果没有合适的文件,创建
coding/session-notes.md。
- 每次有实质代码修改的会话,都追加一条带日期时间的新记录。不要覆盖旧记录。
- 在实现和验证基本完成后再更新记录,让总结反映本次会话实际发生的改动。
记录格式
追加记录时使用下面的结构,并用中文填写内容:
## YYYY-MM-DD HH:mm - 会话标题
### 目标
- 简要说明用户希望完成什么。
### 修改
- 列出重要的文件或模块变更,以及这些变更带来的行为影响。
### 决策
- 记录不明显的实现选择、取舍、约定或假设。
### 验证
- 记录运行过的命令、测试或人工检查,以及对应结果。
- 如果没有验证、验证失败或无法运行验证,直接说明原因。
### 后续
- 只记录有用且具体的后续事项。
如果环境中能知道用户的地区或时区,使用用户当地时间。记录要简洁,但需要足够具体,让后续 Codex 会话可以快速恢复上下文。
应该记录
- 用户意图和本次范围。
- 新建、编辑、重命名或删除的文件。
- 重要设计决策及其原因。
- 测试、构建、lint 或人工验证结果。
- 已知限制、未完成工作、阻塞点和推荐后续行动。
避免记录
- 不要包含 secret、token、私钥或凭据。
- 不要粘贴长 diff 或完整文件内容。
- 不要记录无关的 shell 噪声或探索过程,除非它能解释某个决策。
- 不要虚构验证。如果某个命令没有运行,就明确说明没有运行。
后续会话
在同一仓库继续修改前,如果 coding/ 下已有 Markdown 记录,先阅读它以理解之前的决策。当前工作完成后继续追加新记录。如果已有记录具备清晰格式,保持原有风格。