wrap-session

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Session Wrap-Up Workflow

会话收尾工作流

Execute this workflow when ending a working session to maintain project continuity.
结束工作会话时执行此工作流,以保持项目的连续性。

Execution Steps

执行步骤

1. Identify Project Root

1. 确定项目根目录

Locate the project root containing README.md and CHANGELOG.md. If uncertain, ask the user.
找到包含README.md和CHANGELOG.md的项目根目录。若不确定,询问用户。

2. Update README.md

2. 更新README.md

Update the project description and status to reflect current state. Keep changes minimal — only update what has meaningfully changed.
更新项目描述和状态以反映当前情况。尽量减少变更——仅更新发生实质性变化的内容。

3. Update CHANGELOG.md

3. 更新CHANGELOG.md

Append changes to the
[Unreleased]
section using Keep a Changelog format. See
references/changelog-format.md
for format details.
Change categories:
  • Added
    — New features/files
  • Changed
    — Modified functionality
  • Fixed
    — Bug fixes
  • Deprecated
    — Soon-to-be removed
  • Removed
    — Deleted features
  • Security
    — Vulnerability fixes
If CHANGELOG.md doesn't exist, create it using
assets/CHANGELOG.template.md
.
使用Keep a Changelog格式,将变更内容追加到
[Unreleased]
章节。格式细节请参考
references/changelog-format.md
变更分类:
  • Added
    — 新增功能/文件
  • Changed
    — 修改功能
  • Fixed
    — 修复Bug
  • Deprecated
    — 即将移除的内容
  • Removed
    — 已删除的功能
  • Security
    — 漏洞修复
若CHANGELOG.md不存在,使用
assets/CHANGELOG.template.md
创建该文件。

4. Update Agent Context Files

4. 更新Agent上下文文件

Create/update files in
AGENTS/<model>/
(e.g.,
AGENTS/claude-opus-4.5/
):
FilePurposeWhen to Update
CONTEXT.md
Current project stateAlways
TODO.md
Task trackingWhen tasks change
DECISIONS.md
Technical decisionsWhen decisions are made
If AGENTS folder doesn't exist: Create the full structure:
AGENTS/
└── claude-opus-4.5/
    ├── CONTEXT.md
    ├── TODO.md
    ├── DECISIONS.md
    ├── SESSION-LOG/
    └── PLANNING/
See
references/context-files.md
for file formats.
创建/更新
AGENTS/<model>/
目录下的文件(例如
AGENTS/claude-opus-4.5/
):
文件名称用途更新时机
CONTEXT.md
当前项目状态每次都需更新
TODO.md
任务追踪任务发生变化时
DECISIONS.md
技术决策记录做出决策时
若AGENTS目录不存在: 创建完整目录结构:
AGENTS/
└── claude-opus-4.5/
    ├── CONTEXT.md
    ├── TODO.md
    ├── DECISIONS.md
    ├── SESSION-LOG/
    └── PLANNING/
文件格式请参考
references/context-files.md

4b. Save Planning Artifacts (When Applicable)

4b. 保存规划工件(适用时)

If the session involved planning, review, or analysis work that produced artifacts requiring review, save them to
AGENTS/<model>/PLANNING/
:
When to create PLANNING documents:
  • Architecture proposals or design documents
  • Code review summaries and recommendations
  • Investigation reports and research findings
  • Implementation plans and roadmaps
File naming:
  • Use descriptive, kebab-case names:
    auth-system-design.md
    ,
    api-migration-plan.md
  • Prefix with date for time-sensitive docs:
    2025-01-14_performance-analysis.md
Required front matter:
yaml
---
created: YYYY-MM-DD
updated: YYYY-MM-DD
sessions:
  - SESSION-LOG/YYYY-MM-DD_HH-MM_session.md
status: draft | in-review | approved | superseded
tags: [planning, review, analysis]
---
若会话涉及规划、评审或分析工作,且产生了需要后续评审的工件,请将其保存到
AGENTS/<model>/PLANNING/
目录:
需创建规划文档的场景:
  • 架构提案或设计文档
  • 代码评审总结与建议
  • 调查报告与研究成果
  • 实施计划与路线图
文件命名规则:
  • 使用描述性的短横线分隔命名:
    auth-system-design.md
    api-migration-plan.md
  • 对时效性文档添加日期前缀:
    2025-01-14_performance-analysis.md
必填前置内容:
yaml
---
created: YYYY-MM-DD
updated: YYYY-MM-DD
sessions:
  - SESSION-LOG/YYYY-MM-DD_HH-MM_session.md
status: draft | in-review | approved | superseded
tags: [planning, review, analysis]
---

5. Create Session Log

5. 创建会话日志

Create
AGENTS/<model>/SESSION-LOG/YYYY-MM-DD_HH-MM_session-<4-6 word summary separated by hypens>.md
with:
  1. Summary (2-3 sentences)
  2. Key accomplishments
  3. Decisions made
  4. Issues encountered
  5. Next session recommendations
  6. Next session prompt (copy-paste ready prompt for continuing work)
  7. Session highlights (key prompts/responses, not full transcript)
See
references/session-log-format.md
for template.
创建
AGENTS/<model>/SESSION-LOG/YYYY-MM-DD_HH-MM_session-<4-6个单词组成的短横线分隔摘要>.md
文件,包含以下内容:
  1. 摘要(2-3句话)
  2. 主要成果
  3. 已做出的决策
  4. 遇到的问题
  5. 下一次会话的建议
  6. 下一次会话的提示语(可直接复制粘贴用于继续工作)
  7. 会话亮点(关键提示/回复,而非完整记录)
模板请参考
references/session-log-format.md

6. Confirm Completion

6. 确认完成

Report to user:
  • Files updated/created
  • Key changes documented
  • Recommended pickup point for next session
向用户汇报:
  • 已更新/创建的文件
  • 已记录的主要变更
  • 下一次会话建议的起始点

Directory Structure

目录结构

project-root/
├── README.md
├── CHANGELOG.md
└── AGENTS/
    └── claude-opus-4.5/
        ├── CONTEXT.md
        ├── TODO.md
        ├── DECISIONS.md
        ├── SESSION-LOG/
        │   └── YYYY-MM-DD_HH-MM_session.md
        └── PLANNING/
            └── <descriptive-name>.md
project-root/
├── README.md
├── CHANGELOG.md
└── AGENTS/
    └── claude-opus-4.5/
        ├── CONTEXT.md
        ├── TODO.md
        ├── DECISIONS.md
        ├── SESSION-LOG/
        │   └── YYYY-MM-DD_HH-MM_session.md
        └── PLANNING/
            └── <descriptive-name>.md

When NOT to Run

无需执行此工作流的场景

  • No meaningful work was done
  • User explicitly declines documentation
  • Project is temporary/throwaway
  • 未完成任何有意义的工作
  • 用户明确拒绝记录文档
  • 项目为临时/一次性项目