NestBase 项目文档中心
📚 文档版本: v2.0.0 📅 最后更新: 2025-11-11 🏗️ 项目: NestBase - 现代化全栈 Monorepo 框架
📂 文档结构总览
docs/
├── README.md # 本文件 - 文档中心导航
├── backend/ # 后端服务文档
│ ├── README.md # Backend 文档索引
│ ├── architecture/ # 架构设计
│ ├── features/ # 功能发布
│ ├── guides/ # 使用指南
│ ├── migrations/ # 数据库迁移
│ └── api/ # API 参考
├── frontend/ # 前端服务文档（预留）
│ └── README.md # Frontend 文档索引（待添加）
└── project/ # 项目级文档
├── README.md # 项目文档索引
├── setup/ # 项目设置和配置
├── development/ # 开发和维护
├── features/ # 功能实现和迁移
├── api-tools/ # API 工具和集成
└── project-management/ # 项目管理和交付🎯 快速导航
按服务查看
| 服务 | 说明 | 文档入口 | 文档数量 |
|---|---|---|---|
| 🔧 Backend | NestJS 后端服务技术文档 | docs/backend/README.md | 29 个 |
| 🎨 Frontend | Frontend 前端服务文档 | docs/frontend/README.md | 1 个 |
| 📦 Project | 项目级配置和管理文档 | docs/project/README.md | 19 个 |
按角色查看
🏗️ 新开发人员入门
推荐阅读顺序:
- 快速开始 - 4步快速启动项目
- 前后端联调指南 - (New) 了解核心交互
- Supabase 配置 - 数据库环境配置
- Monorepo 架构 - 了解项目结构
- 开发规范 - 代码规范和提交规范
- RBAC 权限系统 - 权限系统使用
💻 后端开发人员
推荐阅读顺序:
🎨 前端开发人员
推荐阅读顺序:
- 前后端联调指南 - (必读) 启动与认证流程
- Apifox 导入指南 - API 文档导入
- CMS API 使用指南 - CMS 接口使用
- 菜单管理指南 - 菜单系统
- 用户角色 API - 用户权限
- 业务状态码 - 错误处理
🧪 测试人员
推荐阅读顺序:
- Apifox 导入指南
- 前后端联调指南 - 理解启动逻辑
- API 使用指南 - 所有 API 文档
- 功能发布文档 - 功能测试用例
🔧 DevOps / 运维人员
推荐阅读顺序:
- Supabase 配置 - 数据库配置
- 数据库迁移 - Schema 变更
- 项目交付报告
🏛️ 架构师 / 技术负责人
推荐阅读顺序:
📚 文档分类
🔧 Backend 后端服务文档 (29 个文档)
后端 NestJS 应用的完整技术文档。
| 分类 | 数量 | 说明 | 入口 |
|---|---|---|---|
| 架构设计 | 6 | API 规范、业务状态码、验证配置 | architecture/ |
| 功能发布 | 10 | 日志系统、CMS、Token、权限等 | features/ |
| 使用指南 | 6 | CMS API、菜单、用户角色等 | guides/ |
| 数据库迁移 | 4 | Schema 变更记录和迁移指南 | migrations/ |
| API 参考 | 2 | 接口修复和实现记录 | api/ |
📖 详细索引: docs/backend/README.md
📦 Project 项目级文档 (19 个文档)
项目配置、开发流程和管理文档。
| 分类 | 数量 | 说明 | 入口 |
|---|---|---|---|
| 项目设置 | 5 | 快速开始、环境配置、架构说明 | setup/ |
| 开发维护 | 4 | 变更日志、代码检查、文档更新 | development/ |
| 功能实现 | 3 | RBAC 权限系统设计和迁移 | features/ |
| API 工具 | 3 | Apifox、OpenAPI 导出和集成 | api-tools/ |
| 项目管理 | 4 | 交付报告、项目总结和清单 | project-management/ |
📖 详细索引: docs/project/README.md
🎨 Frontend 前端服务文档
前端应用的开发与集成指南。
| 文档 | 说明 | 入口 |
|---|---|---|
| README | 前端技术栈与目录概览 | README.md |
| 联调指南 | 前后端认证与启动流程交互 | INTEGRATION.zh-CN.md |
📖 详细索引: docs/frontend/README.md
🔍 按主题搜索
核心主题
📅 最新更新
最近更新的文档
| 文档 | 类型 | 更新日期 | 说明 |
|---|---|---|---|
| INTEGRATION.zh-CN.md | 指南 | 2025-12-29 | 前后端联调指南 (登录/启动) |
| frontend/README.md | 索引 | 2025-12-29 | 前端文档索引 |
| LOGGING_SYSTEM_RELEASE.md | 功能 | 2025-11-11 | 日志管理系统 v1.1.0 |
| CONTENT_MANAGEMENT_MODULE.md | 功能 | 2025-11-07 | CMS 模块 v1.0.0 |
| MARKDOWN_PARSER_INTEGRATION.md | 功能 | 2025-11-06 | Markdown 解析器 |
📈 文档统计
总文档数: 51 个
- Backend 文档: 29 个
- Project 文档: 19 个
- Frontend 文档: 2 个 (含联调指南)
- 索引文档: 1 个
按类型统计:
- 架构设计: 6 个
- 功能发布: 13 个
- 使用指南: 6 个
- 数据库迁移: 4 个
- API 参考: 2 个
- 项目设置: 5 个
- 开发维护: 4 个
- API 工具: 3 个
- 项目管理: 4 个
🤝 贡献指南
添加新文档
确定文档类型和位置:
- Backend 技术文档 →
docs/backend/ - Frontend 技术文档 →
docs/frontend/ - 项目级文档 →
docs/project/
- Backend 技术文档 →
选择合适的子目录:
- 架构设计 →
architecture/ - 功能发布 →
features/ - 使用指南 →
guides/ - 等等...
- 架构设计 →
使用规范的命名:
- 技术文档: 大写字母+下划线（如
API_NAMING_CONVENTION.md） - 指南文档: 大写字母+下划线或小写+连字符
- 技术文档: 大写字母+下划线（如
更新索引:
- 在对应的 README.md 中添加索引
- 在本文件中更新统计信息
提交变更:
bashgit add docs/ git commit -m "docs: 📝 添加 XXX 文档"
更新现有文档
- 更新文档内容
- 更新文档顶部的"最后更新"日期
- 如有重大变更，更新版本号
- 在 CHANGELOG.md 中记录变更
- 提交时使用
docs:前缀的 commit message
📖 文档模板
功能发布文档模板
markdown
# [功能名称] 功能发布文档
**更新时间**: YYYY-MM-DD
**版本**: vX.Y.Z
**状态**: ✅ 已完成 / ⏳ 进行中 / 🔜 计划中
## 📋 更新概览
[简要说明]
## 🗄️ 数据库变更
[Schema 变更说明]
## 🔧 核心功能实现
[功能实现详情]
## 🌐 API 接口
[接口列表和说明]
## 🚀 部署步骤
[部署指南]
## 📊 使用场景
[实际使用示例]使用指南文档模板
markdown
# [模块名称] 使用指南
## 概述
[模块简介]
## 快速开始
[快速使用示例]
## API 接口
[接口详细说明]
## 使用场景
[常见场景示例]
## 常见问题
[FAQ]🔗 相关资源
- 主 README: ../../README.md
- API 文档: http://localhost:3000/api-docs
- OpenAPI JSON: http://localhost:3000/api/swagger/json
- GitHub Issues: 提交问题
💡 使用建议
- 从索引开始: 每个目录都有 README.md 索引，先查看索引了解全局
- 按角色阅读: 根据你的角色选择对应的推荐阅读路径
- 主题搜索: 使用主题索引快速找到相关文档
- 保持更新: 文档会持续更新，关注"最新更新"章节
文档维护: NestBase Team 最后更新: 2025-11-11 文档版本: 2.0.0