一套完整的项目记忆和开发规范体系，帮助团队高效协作
仓库地址：https://github.com/xiaolin26/memory
⭐ 如果这个模板对你有帮助，请 Star 支持一下！
- 📝 记录一切：技术决策、变更原因、废弃方案
- 🤖 AI 友好：让 AI 快速理解项目
- 👥 团队协作：统一开发规范
- 🔄 持续更新：项目发展，文档同步
| 文件 | 说明 | 必须性 |
|---|---|---|
| CONSTITUTION.md | 项目宪法（开发规范） | ⭐⭐⭐⭐⭐ |
| MEMORY.md | 项目记忆（历史记录） | ⭐⭐⭐⭐⭐ |
| 协作开发指南.md | 团队协作指南 | ⭐⭐⭐⭐ |
| 环境配置指南.md | 环境配置指南 | ⭐⭐⭐⭐ |
| docs/README.md | 技术文档导航 | ⭐⭐⭐ |
# 复制到项目
cp -r [模板目录]/* [项目目录]/[项目名称]→ 实际项目名[项目路径]→ 实际路径- 其他
[占位符]→ 实际内容
- 填写核心原则
- 填写技术栈
- 填写项目结构
只需要做 3 件事：
-
复制文件（5分钟）
cp CONSTITUTION.md [项目目录]/ cp MEMORY.md [项目目录]/
-
填写核心信息（10分钟）
- CONSTITUTION.md：核心原则 + 技术栈
- MEMORY.md：项目结构 + 技术栈
-
开始使用（持续）
- 开发前：读 MEMORY.md + CONSTITUTION.md
- 开发后：更新 MEMORY.md
作用：定义开发规范和约定
核心内容：
- 5 条核心原则
- 敏感信息管理
- 版本号管理
- 提交规范
- 禁止事项
何时更新：仅在调整规范时（需团队讨论）
作用：记录项目历史和技术决策
核心内容：
- 按时间顺序的变更记录
- 技术栈总结
- 核心设计原则
- 重要技术决策（当前 + 废弃）
- 待解决问题
何时更新：每次重大变更后
- 敏感信息通过环境变量管理
- 防止 SQL 注入和 XSS 攻击
- 遵循代码规范
- 编写测试
- 代码审查
- ❌ 新成员上手 1-2 周
- ❌ 重复踩坑
- ❌ 规范不统一
- ❌ AI 不理解项目
- ✅ 新成员上手 2-3 天
- ✅ 避免重复踩坑
- ✅ 统一开发规范
- ✅ AI 快速理解项目
- 评审：团队讨论模板（1小时）
- 试点：选择小项目试点（1-2周）
- 推广：应用到所有项目（持续）
- 模板是指导，不是束缚
- 根据项目实际情况调整
- 保持核心原则不变
- 定期回顾使用情况
- 收集团队反馈
- 迭代优化模板
Q: 必须使用所有文件吗？
A: 不必须。核心是 CONSTITUTION.md 和 MEMORY.md。
Q: 会增加工作量吗？
A: 初期 15-20 分钟填写，之后每次变更 3-5 分钟更新。长期节省大量时间。
Q: 适用于所有项目吗？
A: 适用于大多数软件项目（Web、移动端、小程序等）。
Q: 如何确保团队遵循？
A: 培训 + Code Review + 定期检查。
本模板已被应用于以下项目：
- Hyperion-Central - 统一后台管理系统
- Pull Request: #291
如果你的项目也使用了本模板，欢迎提交 PR 添加到列表中！
本模板可自由使用、修改和分发，无需署名。
- 📖 阅读模板文件了解详情
- 💬 团队内部讨论
- 🔄 根据反馈持续优化
- 🐛 提交 Issue 报告问题
模板版本：v1.0.0 创建日期：2026-01-19 最后更新：2026-01-19 维护者：晓力 & Claude Code