[项目名称]

一句话描述项目：是什么，解决什么问题，面向谁。

目录结构

├── README.md                     # 项目概述与快速开始（本文件）
├── CHANGELOG.md                  # 对外发布变更记录（用户视角）
├── VERSION                       # 语义化版本号
├── LICENSE                       # 许可证
├── CONTRIBUTING.md               # 贡献规范
├── .gitignore                    # Git 忽略规则
├── AGENTS.md                     # AI 编码助手上下文
│
├── src/                          # 源代码（所有业务模块）
├── data/                         # 项目数据（知识库源、SQL dump 等非代码数据）
├── test/                         # 测试代码
│   ├── unit/                     #   单元测试
│   ├── integration/              #   集成测试
│   └── e2e/                      #   端到端测试
│
├── docs/                         # 开发文档
│   ├── design/                   #   设计方案（架构 + 技术方案）
│   │   ├── architecture/         #     架构设计 & ADR
│   │   └── technical/            #     技术方案 / 详细设计
│   ├── features/                 #   功能规格说明
│   ├── requirements/             #   需求与变更管理（可选）
│   ├── implementation/          #   实施计划与任务跟踪（可选）
│   └── verify/                   #   人工检查清单（可选）
│
├── skills/                       # AI 辅助技能（pi 专用，可选）
├── scripts/                      # 构建、部署、工具脚本
└── config/                       # 项目级配置文件（非代码）

• 可选目录：已有 Jira/TAPD 等工单系统的团队可删除 requirements/ 和 implementation/；不用 pi 编码助手的可删除 skills/
• src/ vs 根目录：业务代码放 src/，入口文件（app.py、main.go）和配置文件（pytest.ini、ruff.toml、.env.example）留根目录
• data/ vs test/fixtures/：data/ 放项目级数据（知识库源文件等），test/fixtures/ 放测试专用 fixture 数据

快速开始

# 克隆项目
git clone <repo-url>
cd <project-name>

# [安装 / 构建 / 运行步骤，根据项目补充]

文档导航

你想做的事	去哪看
了解项目背景和架构	docs/design/architecture/
查看需求与变更	docs/requirements/（可选）
查看功能设计	docs/features/
查看任务进度	docs/implementation/tasks/（可选）
参与开发	CONTRIBUTING.md
查看版本历史	CHANGELOG.md

维护者

• @维护者

许可证

LICENSE