TemplateProject/README.md

[项目名称]

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

目录结构

├── README.md                     # 项目概述与快速开始（本文件）
├── CHANGELOG.md                  # 对外发布变更记录（用户视角）
├── VERSION                       # 语义化版本号
├── LICENSE                       # 许可证
├── CONTRIBUTING.md               # 贡献规范
├── .gitignore                    # Git 忽略规则
├── CLAUDE.md                     # AI 编码助手上下文
│
├── src/                          # 源代码
├── test/                         # 测试代码
│   ├── unit/                     #   单元测试
│   ├── integration/              #   集成测试
│   └── e2e/                      #   端到端测试
│
├── docs/                         # 开发文档
│   ├── requirements/             #   需求与变更管理
│   ├── design/                   #   设计方案（架构 + 技术方案）
│   ├── features/                 #   功能规格说明
│   └── implementation/          #   实施计划与任务跟踪
│
├── skills/                       # AI 辅助技能
├── scripts/                      # 构建、部署、工具脚本
└── verify/                       # 验证、检查清单、上线验收

快速开始

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

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

文档导航

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

维护者

• @维护者

许可证

LICENSE