all-project/docs/项目总览/项目总览模板.md

项目总览模板

🎯 模板用途：本模板用于创建新项目的总览文档，为 Cursor AI 提供标准格式参考

📋 项目基本信息

项目名称：[项目名称]
项目类型：[Web 应用/移动应用/桌面应用/其他]
开发模式：[前后端分离/单体应用/微服务/其他]
架构模式：[架构设计模式]
当前版本：[版本号]
开发周期：[开始时间] - [结束时间]

🎯 项目愿景

[项目的整体愿景和目标，描述项目要解决的问题和期望达到的效果]

📊 核心业务领域

1. [业务领域 1]

• 目标：[业务目标]
• 价值：[业务价值]
• 覆盖范围：[具体范围]

2. [业务领域 2]

• 目标：[业务目标]
• 价值：[业务价值]
• 覆盖范围：[具体范围]

3. [业务领域 3]

• 目标：[业务目标]
• 价值：[业务价值]
• 覆盖范围：[具体范围]

🏗️ 技术架构概览

系统架构图

graph TB
    subgraph "前端层"
        A1[Web端<br/>[前端技术栈]]
        A2[移动端<br/>[移动端技术栈]]
    end

    subgraph "服务层"
        B1[业务服务<br/>[后端技术栈]]
    end

    subgraph "数据层"
        C1[数据库<br/>[数据库类型]]
        C2[缓存<br/>[缓存技术]]
    end

    A1 --> B1
    A2 --> B1
    B1 --> C1
    B1 --> C2

技术栈详情

后端技术栈

• 核心框架：[主要框架及版本]
• 开发语言：[编程语言]
• ORM 框架：[ORM 框架]
• 权限认证：[认证方案]
• 数据库：[数据库类型及版本]
• 缓存：[缓存技术]
• 消息队列：[消息队列技术]
• 任务调度：[任务调度框架]

前端技术栈

• Web 框架：[前端框架及版本]
• UI 组件库：[UI 组件库]
• 构建工具：[构建工具]
• 状态管理：[状态管理方案]
• HTTP 客户端：[HTTP 客户端]

移动端技术栈（如适用）

• 开发框架：[移动端框架]
• UI 组件库：[移动端 UI 库]
• 状态管理：[移动端状态管理]

部署运维

• 容器化：[容器技术]
• Web 服务器：[Web 服务器]
• CI/CD：[CI/CD 工具]
• 监控告警：[监控方案]
• 日志管理：[日志方案]

📈 项目规模指标

代码规模

• 后端代码：约 [X] 万行 [语言] 代码
• 前端代码：约 [X] 万行 [语言] 代码
• 移动端代码：约 [X] 万行 [语言] 代码（如适用）
• 数据库表：约 [X] 张业务表

功能模块

• 核心业务模块：[X] 个
• 基础支撑模块：[X] 个
• 管理配置模块：[X] 个
• API 接口数量：约 [X] 个

性能指标

• 并发用户数：支持 [X] 在线用户
• 响应时间：平均响应时间 < [X]ms
• 可用性：[X]% 系统可用性
• 数据处理：支持 [X] 级数据查询

👥 团队组织结构

项目团队

• 项目经理：[X] 人（职责说明）
• 架构师：[X] 人（职责说明）
• 后端开发：[X] 人（职责说明）
• 前端开发：[X] 人（职责说明）
• 测试工程师：[X] 人（职责说明）
• 运维工程师：[X] 人（职责说明）

开发分工

模块	负责人	开发重点
[模块 1]	[姓名]	[重点说明]
[模块 2]	[姓名]	[重点说明]
[模块 3]	[姓名]	[重点说明]

📅 项目时间线

第一阶段：[阶段名称]（[时间范围]）

• ✅/🟡/⭕ [任务 1]
• ✅/🟡/⭕ [任务 2]
• ✅/🟡/⭕ [任务 3]

第二阶段：[阶段名称]（[时间范围]）

• ✅/🟡/⭕ [任务 1]
• ✅/🟡/⭕ [任务 2]
• ✅/🟡/⭕ [任务 3]

第三阶段：[阶段名称]（[时间范围]）

• ✅/🟡/⭕ [任务 1]
• ✅/🟡/⭕ [任务 2]
• ✅/🟡/⭕ [任务 3]

🎯 项目目标与 KPI

业务目标

• [目标 1]：[具体指标]
• [目标 2]：[具体指标]
• [目标 3]：[具体指标]
• [目标 4]：[具体指标]

技术目标

• [目标 1]：[具体指标]
• [目标 2]：[具体指标]
• [目标 3]：[具体指标]
• [目标 4]：[具体指标]

质量目标

• [目标 1]：[具体指标]
• [目标 2]：[具体指标]
• [目标 3]：[具体指标]
• [目标 4]：[具体指标]

🔧 开发工具链

开发环境

• IDE：[开发工具]
• 版本控制：[版本控制工具]
• 数据库工具：[数据库管理工具]
• API 测试：[API 测试工具]
• 代码质量：[代码质量工具]

协作工具

• 项目管理：[项目管理工具]
• 文档协作：[文档工具]
• 设计工具：[设计工具]
• 沟通工具：[沟通工具]

📋 下一步行动计划

近期重点（未来 [X] 周）

1. [行动项 1]
2. [行动项 2]
3. [行动项 3]
4. [行动项 4]

中期规划（未来 [X] 个月）

1. [规划项 1]
2. [规划项 2]
3. [规划项 3]
4. [规划项 4]

长期愿景（未来 [X] 个月）

1. [愿景项 1]
2. [愿景项 2]
3. [愿景项 3]
4. [愿景项 4]

---

🎯 项目愿景：[简洁的项目愿景描述]

📖 相关文档

• 业务模块详情：业务模块文档
• 技术架构设计：设计文档
• 开发指南：开发文档
• 部署指南：部署文档

---

📝 模板使用说明

适用场景

• 新项目启动时创建项目总览
• 项目重大更新时更新项目信息
• 为新团队成员介绍项目概况
• 项目汇报和展示

填写指南

1. 基本信息：填写项目的基础信息，确保准确性
2. 技术架构：根据实际技术选型填写，可使用 Mermaid 图表
3. 团队信息：根据实际团队结构填写
4. 时间线：使用 ✅（已完成）、🟡（进行中）、⭕（未开始）标记
5. 目标 KPI：设置可量化的具体指标

维护要求

• 定期更新：项目重大变更时及时更新
• 版本管理：重要更新需要记录版本变更
• 团队同步：确保团队成员了解最新项目状态