.codelf 项目文档目录
📚 这个目录包含了药店销售预测系统的完整文档，专为LLM大模型编程优化
📋 文档列表
🚀 quick-reference.md - 快速参考指南
用途: LLM编程的核心上下文文档 内容:
- 项目概述和技术栈
- 快速启动命令
- 核心目录结构
- API接口列表
- 支持的ML模型类型
- 开发规范和常见问题
- 重要注意事项和编程提示
何时使用:
- LLM需要快速了解项目结构
- 开发新功能前的参考
- 解决常见问题时的查询
🏗️ architecture.md - 系统架构详情
用途: 深度技术架构和实现细节 内容:
- 系统架构图
- 详细API规范和示例
- 前端组件架构
- 数据存储结构
- 数据流程详解
- 工具类说明
- 错误处理机制
- 性能优化策略
何时使用:
- 需要深入理解系统设计
- API接口开发和调试
- 架构优化和重构
- 新组件设计参考
📊 project.md - 项目完整信息
用途: 项目的详细记录和文件列表 内容:
- 完整的文件目录树
- 项目历史和版本信息
- 依赖关系详情
- 配置文件说明
何时使用:
- 查找特定文件位置
- 了解项目完整结构
- 依赖管理和版本控制
📝 _changelog.md - 变更日志
用途: 记录项目的所有变更历史 内容:
- 按时间排序的变更记录
- 详细的变更描述和影响范围
- API变更和配置变更
- 性能影响评估
何时使用:
- 了解项目演进历史
- 追踪特定功能的开发过程
- 版本发布和回滚决策
⚠️ attention.md - 重要注意事项
用途: 项目开发的关键提醒和规范 内容:
- 关键开发规范
- 重要限制和约束
- 安全注意事项
- 性能考虑
何时使用:
- 开始开发前必读
- 避免常见错误
- 代码审查参考
🎯 为LLM优化的使用指南
快速上手流程
- 首次接触项目 → 阅读
quick-reference.md - 深入开发 → 参考
architecture.md - 查找文件 → 搜索
project.md - 了解历史 → 查看
_changelog.md - 避免踩坑 → 检查
attention.md
LLM编程最佳实践
- 优先查阅
quick-reference.md获取项目上下文 - 使用
architecture.md中的API示例和组件结构 - 遵循文档中的开发规范和命名约定
- 参考错误处理和性能优化建议
文档维护
- 每次重大变更后更新
_changelog.md - 新增功能时同步更新
quick-reference.md - 架构变更时修订
architecture.md - 定期检查文档的准确性和完整性
🚀 快速命令参考
# 启动后端服务
uv run .\server\api.py
# 启动前端开发服务器
cd UI; npm run dev
# 查看项目结构
tree /F
# 检查Python依赖
uv pip list
📞 使用建议
💡 提示: 这些文档是为LLM大模型编程特别优化的，包含了项目的核心信息和开发模式，建议在每次编程任务开始前先查阅相关文档获取上下文。
🎯 目标: 通过结构化的文档系统，提高AI助手在药店销售预测系统开发中的效率和准确性。
📚 此目录通过 codelf 工具生成和维护，专为LLM编程提供项目知识库