Files
team/docs/CLAUDE.md
T
2026-04-19 21:47:08 +08:00

1.5 KiB
Raw Blame History

docs/ CLAUDE.md

本文件为 Claude Code 提供上下文优化指引,避免每次加载完整文档。

文档加载指引

场景 加载文档
了解项目是做什么的 01-用户需求.md
添加/修改功能 03-功能列表.md + 02-产品需求.md
编写用户故事 04-用户故事.md
架构设计 07-系统架构.md + 08-数据库设计.md + 09-API契约.md
安全相关变更 02-产品需求.md(安全性 NFR
查阅 Mermaid 图 13-Mermaid图集.md
UI/前端开发 05-设计-UI.md + 06-设计-UX.md + 对应模块文件
术语不理解 11-工程规范.md(术语表)
部署相关 运维-部署实施.md
测试相关 10-测试-方案.md + 测试-用例.md
发布追踪 运维-发布日志.md

关键约束速查

架构

  • 模块独立性:各模块完全独立,禁止跨模块引用
  • 通信方式:仅通过 REST API
  • 数据库:SQLite 3.45+

编码规范

  • 语言:Python 3.12+ / TypeScript(前端)
  • 格式化:ruff format / ruff check
  • 类型:mypy strict,禁止 Any
  • 详见 .claude/CLAUDE.md

文件命名规范

docs/ 下所有 .md 文件使用分类前缀命名:

  • 核心文档: 01- ~ 12- 编号前缀
  • 设计文档: 设计- 前缀
  • 管理文档: 管理- 前缀
  • 运维文档: 运维- 前缀
  • 测试文档: 测试- 前缀

描述部分使用中文,避免与前缀重复。仅 UI/UX 等通用缩写可保留英文。