Skip to content

📝 笔记更新指南

给 AI 助手的快速参考


🎯 核心原则

每一轮对话只要有新内容就需要更新笔记!


✅ 更新清单

场景 1: 教授新概念

  • [ ] 在 knowledge_base.md 中添加知识点(带编号章节)
  • [ ] 在 learning_log.md 中添加学习记录(带日期)
  • [ ] 如果创建了代码示例,更新 learning_materials/README.md

场景 2: 回答用户问题 ⭐️

  • [ ] 在 knowledge_base.md 的"问答记录"部分添加 Q&A
    • 使用顺序编号(Q1, Q2, Q3...)
    • 重要问题标记 ⭐️
  • [ ] 在 learning_log.md 中添加"疑问解答"条目
  • [ ] 如果写了演示代码,添加文件引用

场景 3: 解决问题/Bug

  • [ ] 在 learning_log.md 中添加"🐛 问题与解决方案"
  • [ ] 记录错误信息、根本原因、解决步骤
  • [ ] 总结经验教训

场景 4: 创建学习材料

  • [ ] 在 learning_materials/ 中创建 Python 文件
  • [ ] 更新 learning_materials/README.md
  • [ ] 在 learning_log.md 中添加文件引用
  • [ ] 在 knowledge_base.md 相关Q&A中添加"参考代码"

📂 文件结构速查

notes.md                      ← 总索引(很少更新)
learning_log.md               ← 按日期记录(每次对话都可能更新)
knowledge_base.md             ← 按主题整理(有新知识/问答就更新)
learning_materials/           ← 代码示例
    ├── README.md             ← 文件列表(新增代码时更新)
    └── *.py                  ← 可执行示例

📋 更新模板

learning_log.md 新增条目

markdown
### 2025-MM-DD:主题描述

#### ✅ 完成事项
- [x] 具体任务1
- [x] 具体任务2

#### 💡 重要知识点
- **知识点1**:解释...

#### 💭 个人思考
- **收获**:...
- **疑问解答**:...

knowledge_base.md 新增 Q&A

markdown
**QN: 用户的问题?**

A: 答案解释

**详细说明**
- 要点1
- 要点2

**类比**:生活化的比喻

**代码示例** (如果有):
```python
示例代码

参考代码:learning_materials/xxx.py



### learning_materials/README.md 新增文件

```markdown
- **`filename.py`** - 简短描述
  - 要点1
  - 要点2
  - 要点3

🔄 更新流程

  1. 对话中

    • 回答问题
    • 创建代码示例
    • 解决问题
  2. 对话后(关键!):

    • 检查清单
    • 更新相关文件
    • 验证编号连续性
    • 确保无信息丢失
  3. 结束前

    • 告知用户已更新笔记
    • 可以简单总结更新内容

💡 注意事项

  1. 问题编号:必须连续(Q1, Q2, Q3...),如果中间插入,后续全部要重新编号

  2. 日期格式:统一使用 2025-MM-DD 格式

  3. 重要标记

    • ⭐️ - 特别重要的问题/发现
    • ✅ - 已完成
    • ❌ - 问题/错误
    • 💡 - 知识点
    • 🐛 - Bug
    • 💭 - 思考
  4. 代码引用

    markdown
    参考代码:`learning_materials/xxx.py`
    相关实现:`model/model_minimind.py:95-105`
  5. 无信息丢失:用户的所有有价值的提问和讨论都应该被记录


🎯 质量标准

好的笔记更新应该:

  • ✅ 完整记录对话内容
  • ✅ 问题编号连续
  • ✅ 日期标记清晰
  • ✅ 代码引用准确
  • ✅ 分类合理(日志 vs 知识库)
  • ✅ 格式统一美观

最后更新:2025-11-07

基于 MiniMind 项目的学习笔记