Back to Details

session-documenter

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Session Documenter Skill

Session Documenter Skill

Document work, decisions, and context with explicit commands.
使用明确的命令记录工作、决策和上下文。

Commands

命令

CommandAction
/start
Begin new session - creates/appends to today's file, loads context
/end
Finalize session - writes entry with all tracked work, updates related files
命令操作
/start
开始新会话 - 创建或追加到今日的文件，加载上下文
/end
完成会话 - 写入包含所有追踪工作的条目，更新相关文件

How It Works

工作原理

  1. /start
     - Creates 
    .agents/SESSIONS/YYYY-MM-DD.md
    if missing, or loads existing context
  2. During session - You tell me what to track: decisions, files changed, mistakes
  3. /end
     - I write the full session entry with flowcharts, decisions, next steps
  1. /start
     - 如果不存在则创建
    .agents/SESSIONS/YYYY-MM-DD.md
    ，或加载现有上下文
  2. 会话期间 - 告知我需要追踪的内容：决策、修改的文件、错误
  3. /end
     - 我会写入包含流程图、决策和后续步骤的完整会话条目

Critical Rules

重要规则

Session File Naming (ONE FILE PER DAY)

会话文件命名（每日一个文件）

✅ CORRECT: .agents/SESSIONS/2025-11-15.md
❌ WRONG:   .agents/SESSIONS/2025-11-15-feature-name.md
Multiple sessions same day → Same file, Session 1, Session 2, etc.
✅ 正确：.agents/SESSIONS/2025-11-15.md
❌ 错误：.agents/SESSIONS/2025-11-15-feature-name.md
同一日的多个会话 → 同一文件，标记为会话1、会话2等。

Flowcharts (MANDATORY for features)

流程图（功能相关为必填项）

Include flowchart for:
  • New features
  • Feature modifications
  • Multi-component bug fixes
需包含流程图的场景：
  • 新功能
  • 功能修改
  • 多组件漏洞修复

Session Entry Structure

会话条目结构

  1. Session number and title
  2. System flow diagram (mermaid or text)
  3. Affected components (frontend, backend, data, external)
  4. What was done (task checklist)
  5. Key decisions (with rationale)
  6. Files changed
  7. Mistakes and fixes
  8. Next steps
  1. 会话编号和标题
  2. 系统流程图（mermaid或文本格式）
  3. 受影响的组件（前端、后端、数据、外部服务）
  4. 已完成工作（任务清单）
  5. 关键决策（含理由）
  6. 修改的文件
  7. 错误与修复方案
  8. 后续步骤

Related Files to Update

需更新的相关文件

  • .agents/SESSIONS/README.md
  • .agents/SYSTEM/SUMMARY.md
  • .agents/TASKS/*/TODO.md
  • .agents/SYSTEM/ARCHITECTURE.md
    (if architectural decisions)
  • .agents/SESSIONS/README.md
  • .agents/SYSTEM/SUMMARY.md
  • .agents/TASKS/*/TODO.md
  • .agents/SYSTEM/ARCHITECTURE.md
    （若涉及架构决策）

References

参考资料

  • Full guide: Phases, automation, validation, examples
  • 完整指南：阶段、自动化、验证、示例