daily-record

每日收尾记录:同时完成开发日志(docs/)和开发者发言归档(developerWords/)两件事。当用户说"帮我做今天的记录"、"收尾"、"总结今天"、"daily record",或同时提到开发日志和发言整理时使用。先写开发日志,再整理发言,一次触发完成两步。

每日收尾记录

每次触发按顺序完成两件事:

  1. 写开发日志docs/YYYY-MM-DD.md
  2. 整理开发者发言developerWords/YYYY-MM-DD.md

第零步:确定今天的日期(必须执行)

AI 内置的日期知识不可靠,必须通过终端命令获取用户系统的真实时间:

date '+%Y-%m-%d'
  • 使用命令返回的日期作为今天日期
  • 用户明确指定了日期时,以用户指定为准
  • 在日志和发言文件的文件名及标题中使用该日期

第一步:开发日志(docs/)

存储

  • 目录:docs/,文件名:YYYY-MM-DD.md
  • 文件已存在则追加,不存在则新建

文件结构

# YYYY-MM-DD 开发日志

## 今日实现

### N. 功能名称

**背景/问题:** 为什么需要做这件事。

**涉及文件:**
- `路径/文件.ts` — 改了什么、为什么改

**技术选型:**

| 方案 | 优点 | 缺点 |
|------|------|------|
| 方案 A | ... | ... |
| **方案 B(选用)** | ... | ... |

选型理由:一句话说明为什么选这个方案。

**实现要点:** 关键实现细节、设计决策、踩坑记录。

---

## 关键收获

本次开发中提炼的经验、设计洞见或原则,编号列出。

撰写规则

  1. 技术选型必须写:有设计决策时列出备选方案和选择理由
  2. 涉及文件标注变更说明:每个文件后用破折号说明改了什么
  3. 关键收获放在文件最底部:提炼能跨功能复用的经验
  4. 用具体技术语言,避免"优化了性能"这类模糊表达

第二步:开发者发言(developerWords/)

存储

  • 目录:developerWords/,文件名:YYYY-MM-DD.md
  • 文件已存在则追加,不存在则新建

文件结构

# YYYY-MM-DD Developer Words

> 记录开发者与 AI 的对话原文(仅开发者侧发言),按话题顺序整理。

---

## 话题名称

> 开发者说的原话

> 同一话题下的另一条发言

---

整理规则

  1. 只记录开发者的话 — 不包含 AI 的任何回复
  2. 原文照录 — 不改写、不修正语法、不总结
  3. 按话题分组 — 功能需求、设计决策、问题反馈、操作指令、收尾动作等
  4. 组内按时间顺序排列
  5. 每条发言用 > 块引用格式
  6. 包含当前这条触发请求 — 本条消息也作为最后一条写入

参考示例

  • 开发日志:docs/2026-03-17.md
  • 发言记录:developerWords/2026-03-17.md

第三步:更新 README.md

两份文件写完后,必须更新项目根目录的 README.md,确保 README 与最新功能同步。

需要更新的内容:

  • 后续计划:新完成的功能勾选(- [ ] 改为 - [x]
  • 工具表格:有新增工具时,追加到对应 Agent 的工具表格中
  • 技术栈:有新引入的技术时,加入技术栈列表
  • 快速上手:有新配置项时追加配置步骤说明

第四步:提交并推送

内容确认无误后,执行以下命令提交并推送到远程仓库:

# 1. 暂存所有改动
git add -A

# 2. 提交(commit message 简洁说明今日主要内容)
git commit -m "docs: 日常收尾记录 YYYY-MM-DD"

# 3. 推送到当前分支
git push