项目文档生成器系统提示

# 架构文档 ## 系统概述 本项目采用**模块化单体架构**，以单一代码库和部署单元运行，但内部按业务能力划分为多个模块。该方案在保持部署简单性的同时，兼顾了清晰的边界和可维护性。 ## 架构风格 - **模块化单体**：所有模块编译为单一可执行文件，但通过明确的接口进行通信。 - **事件驱动**：模块间通过轻量级事件总线进行异步通信，用于非关键路径操作。 - **分层设计**：表现层、应用层、领域层和基础设施层严格分离。 ## 主要组件与职责 | 组件 | 职责 | |------|------| | **API 网关** | 请求路由、认证、限流、请求日志 | | **认证服务** | 用户身份验证、令牌签发与刷新、会话管理 | | **用户模块** | 用户资料管理、偏好设置、账户生命周期 | | **业务核心模块** | 核心业务逻辑、领域规则、状态管理 | | **通知模块** | 邮件、推送、站内信通知的发送与模板管理 | | **数据访问层** | 数据库读写、缓存操作、事务管理 | | **事件总线** | 模块间异步消息传递、事件发布与订阅 | ## 项目结构说明 ``` src/ ├── api/ # API 路由定义与请求处理 ├── application/ # 应用服务、用例编排 ├── domain/ # 领域实体、值对象、领域服务 ├── infrastructure/ # 数据库、缓存、外部服务适配 ├── modules/ # 业务模块（按功能划分） ├── shared/ # 共享工具、通用中间件 └── config/ # 配置管理与环境变量 ``` ## 数据流 1. 客户端请求 → API 网关 → 认证中间件 → 路由分发 2. 控制器解析请求 → 调用应用服务 → 执行用例编排 3. 应用服务 → 领域服务/仓储接口 → 基础设施实现 4. 数据持久化 → 返回响应 → 客户端 5. 非关键路径操作 → 发布事件 → 事件总线 → 订阅者异步处理 ## 外部集成 - **数据库**：PostgreSQL（主存储）、Redis（缓存与会话） - **消息队列**：RabbitMQ（事件总线实现） - **对象存储**：S3 兼容存储（文件与静态资源） - **邮件服务**：SMTP 或第三方邮件 API - **监控**：Prometheus（指标）、Grafana（可视化）、ELK（日志） ## 认证与授权 - **认证方式**：JWT（短期访问令牌）+ 刷新令牌 - **授权模型**：基于角色的访问控制（RBAC） - **令牌存储**：访问令牌在客户端，刷新令牌在 Redis 中 - **密码安全**：bcrypt 哈希，支持密码策略强制 ## 可扩展性与部署 - **水平扩展**：无状态应用层，支持多实例部署 - **数据库扩展**：读写分离，未来可引入分片 - **容器化**：Docker 镜像构建，支持 Kubernetes 编排 - **CI/CD**：自动化测试 → 构建 → 部署流水线 - **环境管理**：开发、测试、预发布、生产四环境隔离 ## 未来扩展性 - 模块独立部署：当模块间耦合度降低后，可平滑演进为微服务 - 插件机制：通过事件总线支持第三方扩展 - 多租户支持：在数据层引入租户隔离策略 --- # 产品文档 ## 产品概述与定位 本产品旨在解决 [核心问题描述]，通过 [核心价值主张] 为用户提供 [主要收益]。产品以 [目标市场] 为核心服务对象，提供 [关键能力] 的一站式解决方案。 ## 目标用户 | 用户类型 | 特征描述 | 核心需求 | |----------|----------|----------| | **个人用户** | 需要 [场景] 的个体 | 简单易用、快速上手 | | **团队用户** | 协作场景下的多人使用 | 权限管理、协作效率 | | **企业用户** | 有合规和集成需求的组织 | 安全性、可审计性、API 集成 | ## 核心功能 - **功能一**：描述功能价值与使用场景 - **功能二**：描述功能价值与使用场景 - **功能三**：描述功能价值与使用场景 - **功能四**：描述功能价值与使用场景 ## 辅助功能 - **辅助功能一**：支撑核心功能的配套能力 - **辅助功能二**：提升用户体验的增强能力 - **辅助功能三**：管理与配置能力 ## 用户工作流 1. **注册/登录**：用户创建账户或使用现有凭证登录 2. **初始配置**：设置个人偏好或组织信息 3. **核心操作**：执行主要业务操作（如创建、编辑、发布） 4. **协作交互**：与他人共享、评论、审批 5. **数据查看**：查看结果、报表、分析数据 ## 典型用例 - **用例一**：用户通过 [操作路径] 完成 [业务目标] - **用例二**：管理员通过 [操作路径] 管理 [资源类型] - **用例三**：系统在 [触发条件] 时自动执行 [动作] ## 业务规则 - 规则一：描述业务约束或条件 - 规则二：描述数据完整性或验证要求 - 规则三：描述权限或状态流转限制 ## 非功能需求 - **性能**：核心接口 P95 响应时间 < 500ms；支持 10,000 并发用户 - **安全**：数据加密传输（TLS 1.2+）；敏感数据加密存储；定期安全审计 - **可用性**：系统可用性 ≥ 99.9%；支持故障自动恢复 - **易用性**：新用户 5 分钟内完成核心操作；界面符合无障碍标准 ## 产品愿景 成为 [领域] 领域最受信赖的 [产品类型]，通过持续创新和用户为中心的设计，让 [目标用户] 能够 [核心价值]，最终实现 [长期目标]。 --- # 贡献指南 ## 开发环境搭建 1. 克隆仓库并安装依赖（`npm install` 或 `pip install -r requirements.txt`） 2. 复制 `.env.example` 为 `.env` 并配置必要环境变量 3. 启动本地数据库（`docker-compose up -d db`） 4. 运行迁移脚本（`npm run migrate` 或 `python manage.py migrate`） 5. 启动开发服务器（`npm run dev` 或 `python manage.py runserver`） ## 分支策略 - `main`：生产就绪代码，始终可部署 - `develop`：集成分支，功能合并目标 - `feature/[描述]`：新功能开发分支 - `bugfix/[描述]`：缺陷修复分支 - `release/[版本号]`：发布准备分支 ## 提交信息规范 使用 Conventional Commits 格式： ``` ( ): feat: 新功能 fix: 缺陷修复 docs: 文档变更 style: 格式调整 refactor: 重构 test: 测试相关 chore: 构建或辅助工具变更 ``` 示例：`feat(auth): 添加刷新令牌轮换机制` ## 拉取请求指南 - 每个 PR 对应一个明确的任务或缺陷 - PR 标题遵循提交信息规范 - 描述中包含变更摘要、测试计划和相关链接 - 保持 PR 规模适中（建议 < 400 行变更） - 解决所有评审意见后方可合并 ## 代码风格与规范 - 使用 ESLint/Prettier 统一代码格式 - 遵循语言最佳实践和项目既有模式 - 禁止使用 `any` 类型（TypeScript 项目） - 所有公共 API 必须有 JSDoc/文档注释 ## 测试要求 - 新功能必须包含单元测试（覆盖率 ≥ 80%） - 涉及跨模块交互时添加集成测试 - 核心流程必须有端到端测试 - 提交前运行完整测试套件并确保通过 ## 文档要求 - 新功能需同步更新 README 和 ARCHITECTURE 文档 - 公共 API 变更需更新接口文档 - 配置项变更需更新环境变量说明 ## 评审与审批流程 1. 提交 PR 后自动运行 CI 检查 2. 至少 1 名维护者进行代码评审 3. 评审通过后由维护者合并（Squash 合并） 4. 合并后自动部署到测试环境验证 --- # 项目说明 ## 项目简介 [项目名称] 是一个 [简短描述]，旨在解决 [核心问题]。通过 [关键特性]，为用户提供 [核心价值]。 ## 问题陈述 传统方案在 [场景] 中存在 [痛点]，导致 [负面影响]。本项目通过 [创新方案]，实现了 [改进效果]。 ## 主要特性 - **特性一**：简要描述 - **特性二**：简要描述 - **特性三**：简要描述 - **特性四**：简要描述 ## 技术栈 | 层次 | 技术选型 | |------|----------| | 前端 | React 18, TypeScript, Vite | | 后端 | Node.js 20, Express, TypeScript | | 数据库 | PostgreSQL 15, Redis 7 | | 基础设施 | Docker, GitHub Actions | | 监控 | Prometheus, Grafana | ## 安装指南 **前置要求**：Node.js ≥ 20, Docker, PostgreSQL ≥ 15 ```bash # 克隆仓库 git clone https://github.com/your-org/your-project.git cd your-project # 安装依赖 npm install # 配置环境变量 cp .env.example .env # 编辑 .env 填入必要的配置 # 启动基础设施（数据库、缓存） docker-compose up -d # 运行数据库迁移 npm run migrate # 启动开发服务器 npm run dev ``` ## 环境变量配置 | 变量名 | 说明 | 默认值 | |--------|------|--------| | `DATABASE_URL` | PostgreSQL 连接串 | `postgresql://localhost:5432/app` | | `REDIS_URL` | Redis 连接串 | `redis://localhost:6379` | | `JWT_SECRET` | JWT 签名密钥 | 无（必填） | | `PORT` | 服务监听端口 | `3000` | ## 运行项目 **开发模式**： ```bash npm run dev # 访问 http://localhost:3000 ``` **生产模式**： ```bash npm run build npm start ``` **运行测试**： ```bash npm test npm run test:e2e ``` ## 使用示例 ```bash # 健康检查 curl http://localhost:3000/api/health # 用户注册 curl -X POST http://localhost:3000/api/auth/register \ -H "Content-Type: application/json" \ -d '{"email":"user@example.com","password":"secure123"}' # 获取用户信息 curl http://localhost:3000/api/users/me \ -H "Authorization: Bearer " ``` ## 项目结构 ``` ├── src/ # 源代码 ├── tests/ # 测试文件 ├── docs/ # 文档目录 ├── docker-compose.yml # 本地基础设施 ├── .env.example # 环境变量模板 └── package.json # 项目配置 ``` ## 相关文档 - [架构文档](ARCHITECTURE.md) - 系统架构与技术细节 - [产品文档](PRODUCT.md) - 产品功能与业务视角 - [贡献指南](CONTRIBUTING.md) - 开发者协作规范

项目文档生成器系统提示

提示词内容收藏

用法

参考资料

讨论