mcpField
W
wrap-session

wrap-session

github.com/product-on-purposeAgent 工作流76960 次安装4 天前更新
代码仓库

关于 wrap-session

wrap-session 是用于在工作会话结束时记录项目状态和进展的工作流技能。它更新项目文档与 Agent 上下文文件,按需保存规划材料,并创建含后续建议的会话日志。

主要功能

  1. 01更新 README 和变更日志
  2. 02维护 Agent 上下文与任务文件
  3. 03按需保存规划材料
  4. 04创建结构化会话日志
  5. 05建议后续工作的起点

适用场景

  1. 01在会话结束时记录已完成的工作
  2. 02为下一次工作会话整理项目记录

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/product-on-purpose/pm-skills --skill wrap-session

安装后在 Claude Code 中输入/wrap-session确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

assets/
CHANGELOG.template.md
references/
changelog-format.md
context-files.md
session-log-format.md

详细介绍

会话收尾工作流

结束工作会话时执行此工作流,以保持项目的连续性。

执行步骤

1. 确定项目根目录

找到包含 README.md 和 CHANGELOG.md 的项目根目录。如果无法确定,请询问用户。

2. 更新 README.md

更新项目描述和状态,以反映当前情况。尽量减少改动——只更新发生了实质性变化的内容。

3. 更新 CHANGELOG.md

使用 Keep a Changelog 格式,将变更追加到 [Unreleased] 部分。格式详情请参阅 references/changelog-format.md。

变更类别:

  • Added — 新功能/文件
  • Changed — 功能变更
  • Fixed — Bug 修复
  • Deprecated — 即将移除
  • Removed — 已删除的功能
  • Security — 漏洞修复

如果 CHANGELOG.md 不存在,请使用 assets/CHANGELOG.template.md 创建。

4. 更新 Agent 上下文文件

在 AGENTS/<model>/ 中创建/更新文件(例如 AGENTS/claude/):

文件用途更新时机
CONTEXT.md当前项目状态始终
TODO.md任务跟踪任务发生变化时
DECISIONS.md技术决策做出决策时

如果 AGENTS 文件夹不存在: 创建完整的目录结构:

AGENTS/
└── claude/
    ├── CONTEXT.md
    ├── TODO.md
    ├── DECISIONS.md
    ├── SESSION-LOG/
    └── PLANNING/

文件格式请参阅 references/context-files.md。

4b. 保存规划材料(适用时)

如果会话涉及规划、审查或分析工作,并产生了需要审阅的材料,请将其保存到 AGENTS/<model>/PLANNING/:

需要创建 PLANNING 文档的情形:

  • 架构提案或设计文档
  • 代码审查摘要和建议
  • 调查报告和研究发现
  • 实施计划和路线图

文件命名:

  • 使用描述性 kebab-case 名称:auth-system-design.md、api-migration-plan.md
  • 对有时效性的文档,在文件名前添加日期:2025-01-14_performance-analysis.md

必需的 front matter:

---
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. 创建会话日志

创建 AGENTS/<model>/SESSION-LOG/YYYY-MM-DD_HH-MM_session-<4-6 word summary separated by hypens>.md,包含:

  1. 摘要(2-3 句话)
  2. 主要成果
  3. 已做出的决策
  4. 遇到的问题
  5. 下一次会话的建议
  6. 下一次会话提示词(可直接复制粘贴以继续工作的提示词)
  7. 会话要点(关键提示词/回复,而非完整记录)

模板请参阅 references/session-log-format.md。

6. 确认完成

向用户报告:

  • 已更新/创建的文件
  • 已记录的关键变更
  • 建议的下一次会话接续点

目录结构

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

不应运行的情形

  • 未完成有意义的工作
  • 用户明确拒绝编写文档
  • 项目是临时的/用完即弃的

评论

支持 Markdown