mcpField
S
session-documenter

session-documenter

github.com/shipshitdevAgent 工作流38150 次安装2 天前更新
代码仓库

关于 session-documenter

session-documenter 是用于记录工作、决策和后续事项的 Agent 技能,会将内容写入每日会话文件并脱敏;重要决策也可更新项目记忆。

主要功能

  1. 01开始会话并加载每日上下文
  2. 02追加脱敏后的会话记录
  3. 03更新持久项目记忆
  4. 04重写历史记录前征求确认

适用场景

  1. 01在会话结束时记录工作与决策
  2. 02利用当日上下文继续工作
  3. 03记录影响项目的架构决策

安装

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

$npx skills add https://github.com/shipshitdev/skills --skill session-documenter

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

附带文件plugin.jsonreferences/full-guide.md

详细介绍

会话记录技能

记录工作、决策和上下文。

约定

输入:

  • 当前会话上下文,已对类似机密的值进行脱敏
  • 已更改的文件、已做出的决策、阻碍和后续步骤
  • 可选的任务或 PRD 参考

输出:

  • 在 .agents/sessions/YYYY-MM-DD.md 中追加会话条目,并移除其中的机密信息
  • 必要时更新相关摘要或任务

创建/修改:

  • .agents/sessions/ 每日会话文件
  • 当某项决策改变了持久项目上下文(架构、部署、迁移、注意事项)时,修改 .agents/memory/*.md

外部副作用:

  • 无

需要确认:

  • 重写现有会话历史之前
  • 将会话记录提升为永久规则或技能之前

委派给:

  • rules-capture:捕获会话中发现的可复用偏好
  • skill-capture:捕获会话中发现的可复用工作流
  • session-end:处理收尾流程

命令

命令操作
/start开始新会话——创建或追加到当天的文件,并加载上下文
/end结束会话——写入包含所有已跟踪工作的条目,并更新相关文件

工作原理

  1. /start —— 如果 .agents/sessions/YYYY-MM-DD.md 不存在,则创建该文件;否则加载已有上下文
  2. 会话期间 —— 跟踪决策、已更改的文件和错误
  3. /end —— 写入经过脱敏的会话条目,包含流程图、决策和后续步骤

关键规则

会话文件命名(每天一个文件)
✅ CORRECT: .agents/sessions/2025-11-15.md
❌ WRONG:   .agents/sessions/2025-11-15-feature-name.md

同一天有多个会话 → 使用同一个文件,依次标记为 Session 1、Session 2 等。

流程图(功能必需)

以下情况需包含流程图:

  • 新功能
  • 功能修改
  • 涉及多个组件的错误修复
脱敏(必需)

写入会话记录之前:

  • 将 API 密钥、令牌、密码、Cookie、私有凭据和机密值替换为 [REDACTED_SECRET]。
  • 概述敏感命令的输出,不要逐字复制。
  • 如果请求/响应负载包含个人数据、私有 URL 或凭据,不要保存完整内容;仅记录与决策相关的字段。

会话条目结构

  1. 会话编号和标题
  2. 系统流程图(mermaid 或文本)
  3. 受影响的组件(前端、后端、数据、外部)
  4. 完成的工作(任务清单)
  5. 关键决策(及其理由)
  6. 已更改的文件
  7. 错误及修复
  8. 后续步骤

需要更新的相关文件

  • .agents/memory/*.md —— 当某项决策改变了持久仓库上下文(架构、部署、迁移、注意事项)时更新。修改文件时,请更新其 last_verified 日期。

参考资料

评论

支持 Markdown