Skip to content
ysy0915 edited this page Aug 13, 2026 · 2 revisions

文档中心

博思AI智能体 3.0 — 文档索引(2026-08-13 整理归档)

按主题分为 7 类。目录结构:docs/0X-分类/文档.md

快速导航

分类 目录 核心文档
架构设计 01-架构设计/ 架构全盘说明(总纲)、ADR 架构决策记录
API 与数据库 02-API与数据库/ api-design数据库设计说明
运维部署 03-运维部署/ 部署运维手册故障排查指南
安全合规 04-安全合规/ 安全配置说明
测试与质量 05-测试与质量/ 测试规范压测报告
交付材料 06-交付材料/ 项目概述
变更与经验 07-变更与经验/ CHANGELOG-3.0

推荐阅读顺序:项目概述 → 架构全盘说明 → 数据库设计说明 → 部署运维手册 → 安全配置说明 → 测试规范。


01-架构设计

文档 说明
架构全盘说明.md 系统总纲:整体架构 → 模块细节 → 核心业务流程一册通览(阅读入口)
架构设计说明.md Architecture Design:架构决策与模块设计
架构评估报告.md 系统架构评估 + 风险清单
ADR-架构决策记录.md 架构决策记录(ADR):22 条关键决策的背景·决策·后果
系统架构说明.md 前后端架构、数据流、核心调用链
LLM策略与路由说明.md 多 LLM 调用策略、路由机制、已知问题与修复

02-API与数据库

文档 说明
api-design.md V1.0 系统 ER 与 API 设计(MySQL DDL / OpenAPI / Redis 键)
数据库设计说明.md 表结构、索引策略、数据字典
数据库ER图.md 18 张表 ER 图(Mermaid)
db-migrations/ 版本化 SQL 迁移脚本(V{版本}__{描述}.sql,见 scripts/db-migrate.sh
sql/ 功能模块 DDL/迁移脚本(llm_routing_schema / rag_schema / migrate_model_configs_to_llm 等)

03-运维部署

文档 说明
部署运维手册.md 本机开发 / 服务器部署 / Docker 三场景手册
故障排查指南.md 现象 → 根因 → 修复步骤排障手册
CI_CD.md GitHub Actions 三条流水线说明
nacos-configs/ Nacos 配置中心各服务 prod 配置(chat-*)-prod.yml + .env
grafana/ Grafana 监控面板与数据源配置

04-安全合规

文档 说明
安全配置说明.md JWT 鉴权、接口白名单、IP 限流、内容安全配置
安全合规说明.md 安全架构总览、扫描工具矩阵、合规检查清单

05-测试与质量

文档 说明
测试规范.md 测试分层策略、覆盖率现状、Mock 策略
压测与优化报告_20260811.txt 意图识别 / 思考链 / 全链路 500 并发压测报告
代码规范与质量说明.md 代码质量工具配置、检查维度

06-交付材料

文档 说明
项目概述.md 项目目标用户、核心诉求、功能全景
Demo视频或原型内容.md Demo 视频/原型脚本与样例输入输出
方案PPT内容.md 方案 PPT 内容脚本

07-变更与经验

文档 说明
CHANGELOG-3.0.md 3.0 版本更新公告与变更历史
MultiAgent升级实录_20260813.md Multi-Agent 并行工作流升级实录
博思AI智能体3.0最佳实践.md AI 应用产品最佳实践系统实战总结

部署配置资产(docs/ 根目录,非文档)

以下文件被 scripts/deploy.shdocker-compose.yml、README 硬编码引用,属于部署资产,不可移动

文件 用途
prometheus.yml / prometheus-prod.yml / prometheus-alert-rules.yml Prometheus 监控配置
alertmanager.yml / alert-webhook.py 告警配置与钉钉 webhook
nginx.conf Nginx 反代配置
nacos-shared-config.yaml Nacos 共享配置
start-milvus.sh Milvus 启动脚本
架构图.html / 架构图.png 系统架构图(源码 + 高清 PNG)

Clone this wiki locally