00-文档索引.md

IntelliHub 文档索引

本文档提供了项目所有文档的索引和说明，方便快速查找相关文档。

文档分类说明

文档按照以下规则进行编号和分类：

• 01-09: 需求与规划
• 10-19: 架构设计
• 20-29: 技术流程
• 30-39: 事件中心
• 90-99: 其他

---

📋 需求与规划 (01-09)

01-需求与规划-需求文档.md

描述: 项目的核心需求文档，定义了系统的功能需求和非功能需求。
适用场景: 了解项目背景、核心功能、业务需求
关键内容:

• 项目背景和目标
• 核心功能模块
• 用户角色和权限
• 非功能需求

02-需求与规划-功能开发计划.md

描述: 详细的功能开发计划，包含各个模块的开发优先级和时间安排。
适用场景: 了解开发进度、规划开发任务
关键内容:

• 各模块开发计划
• 开发优先级
• 时间安排
• 里程碑节点

03-需求与规划-后续开发与优化计划.md

描述: 后续版本的开发计划和系统优化方向。
适用场景: 了解系统未来发展方向、优化重点
关键内容:

• 后续版本规划
• 性能优化方向
• 功能扩展计划
• 技术债务处理

---

🏗️ 架构设计 (10-19)

10-架构设计-项目架构文档.md

描述: 系统整体架构设计文档,包含技术栈选型、架构模式、模块划分等。
适用场景: 了解系统整体架构、技术选型、模块关系
关键内容:

• 系统架构图
• 技术栈说明
• 微服务模块划分
• 中间件选型
• 部署架构

11-架构设计-实体关系说明.md

描述: 数据库实体关系设计文档，说明各个实体之间的关系。
适用场景: 了解数据模型、表结构设计、实体关系
关键内容:

• ER 图
• 实体定义
• 关系说明
• 字段设计

---

⚙️ 技术实现 (20-29)

20-技术实现-网关服务实现文档 (IntelliHub API 网关技术实现文档.md)

描述: 网关服务的完整技术实现，包含双流量认证、动态路由、限流等核心能力。
适用场景: 了解网关核心能力、Filter链路、路由机制
关键内容:

• 双流量认证机制（JWT + AppKey签名）
• 动态路由引擎（HTTP/Dubbo/Mock）
• 多维度限流保护
• 异步日志上报
• Filter执行链路

21-技术实现-告警中心实现文档 (IntelliHub 告警中心实现文档.md)

描述: 告警中心的完整技术实现，包含规则配置、检测、通知等。
适用场景: 了解告警系统工作原理、规则配置、通知机制
关键内容:

• 告警规则配置
• 告警状态机
• 检测定时任务
• 通知渠道（邮件/钉钉/Kafka）
• 抑制策略

22-技术流程-API下发指南.md

描述: API 下发到网关的技术流程和操作指南。
适用场景: 了解 API 发布流程、网关配置更新
关键内容:

• API 发布流程
• 路由配置下发
• 网关配置刷新
• 事件驱动更新

23-技术实现-API平台服务实现文档 (IntelliHub API平台服务实现文档.md)

描述: API平台服务的完整技术实现，包含生命周期管理、版本管理等。
适用场景: 了解API平台核心功能、生命周期管理
关键内容:

• API完整生命周期管理
• 版本管理机制
• 后端配置（HTTP/Dubbo/Mock）
• 事件驱动下发
• 公告与系统配置管理

24-技术实现-应用中心服务实现文档 (IntelliHub 应用中心服务实现文档.md)

描述: 应用中心服务的完整技术实现，包含AppKey管理、订阅授权等。
适用场景: 了解应用接入、认证授权机制
关键内容:

• AppKey/AppSecret生成与管理
• 订阅授权机制
• 配额管理
• Dubbo服务接口
• 签名认证

25-技术实现-统计服务实现文档 (IntelliHub 统计服务实现文档.md)

描述: 统计服务的完整技术实现，包含调用日志采集、多维度统计等。
适用场景: 了解调用统计、数据分析能力
关键内容:

• Kafka日志消费
• 实时统计（Redis）
• 多维度统计分析
• 调用日志查询
• 趋势分析

26-技术实现-聚合搜索服务实现文档 (IntelliHub 聚合搜索服务实现文档.md)

描述: 聚合搜索服务的完整技术实现，基于Elasticsearch实现全文检索。
适用场景: 了解搜索能力、索引设计、查询优化
关键内容:

• 多索引聚合搜索
• 分词与高亮
• 租户隔离
• 相关性排序
• 数据同步机制

27-技术实现-事件中心实现文档 (IntelliHub 事件中心实现文档.md)

描述: 事件中心的完整技术实现，包含事件发布订阅、Webhook通知等。
适用场景: 了解事件驱动架构、Webhook机制
关键内容:

• 事件发布-订阅模型
• Kafka事件消费
• Webhook订阅管理
• 失败重试机制
• 事件溯源

28-技术实现-AIGC服务实现文档 (AIGC技术实现文档.md)

描述: AIGC服务的完整技术实现，包含智能分析、文档生成等AI能力。
适用场景: 了解AI集成、智能化能力
关键内容:

• AI服务接入封装
• 对话管理
• Prompt工程
• Token消耗统计
• 智能分析与生成

---

🎯 专题文档 (30-89)

70-多租户实现 (70-多租户-MyBatis-Plus多租户拦截器实施方案.md)

描述: MyBatis Plus多租户拦截器的完整实施方案。
适用场景: 了解多租户隔离机制、数据安全保障
关键内容:

• 多租户架构方案
• MyBatis Plus租户插件配置
• 全链路租户隔离
• 租户上下文管理
• 最佳实践

---

📝 其他文档 (90-99)

90-其他-开发中遇到的问题.md

描述: 开发过程中遇到的问题和解决方案记录。
适用场景: 查找问题解决方案、避免重复踩坑
关键内容:

• 问题描述
• 问题原因分析
• 解决方案
• 经验总结

面试题-IntelliHub-完整版.md

描述: 基于IntelliHub项目的面试题库，覆盖架构设计、技术实现等方面。
适用场景: 面试准备、技术总结
关键内容:

• 架构设计问题
• 技术实现细节
• 性能优化方案
• 问题排查思路

项目经历-IntelliHub.md

描述: IntelliHub项目经历总结，适用于简历与面试场景。
适用场景: 简历编写、面试准备
关键内容:

• 项目背景与目标
• 核心职责与贡献
• 技术亮点
• 项目成果

---

📚 快速导航

新手入门

1. 先阅读 01-需求与规划-需求文档.md 了解项目背景
2. 再阅读 10-架构设计-项目架构文档.md 了解系统架构
3. 查看 功能开发计划.md 了解开发进度和当前状态

核心服务开发指南

• 网关服务: IntelliHub API 网关技术实现文档.md
• API平台服务: IntelliHub API平台服务实现文档.md
• 应用中心服务: IntelliHub 应用中心服务实现文档.md
• 统计服务: IntelliHub 统计服务实现文档.md
• 告警中心: IntelliHub 告警中心实现文档.md

扩展服务开发指南

• 聚合搜索服务: IntelliHub 聚合搜索服务实现文档.md
• 事件中心: IntelliHub 事件中心实现文档.md
• AIGC服务: AIGC技术实现文档.md

技术专题

• 多租户实现: 70-多租户-MyBatis-Plus多租户拦截器实施方案.md
• API下发流程: 22-技术流程-API下发指南.md

面试与总结

• 面试准备: 面试题-IntelliHub-完整版.md
• 项目经历: 项目经历-IntelliHub.md

问题排查

• 开发问题: 90-其他-开发中遇到的问题.md

---

🔄 文档更新记录

日期	更新内容	更新人
2024-12-31	创建文档索引，整理文档编号和分类	Cascade
2024-12-31	完成事件中心第一阶段开发和测试文档	Cascade
2024-12-31	更新事件中心实施计划，标记第一阶段已完成	Cascade
2026-01-07	重新整理文档索引，规范化技术实现文档分类	Qoder
2026-01-07	补充面试题、项目经历等文档索引	Qoder

---

📌 文档维护规范

命名规范

• 格式：{编号}-{分类}-{文档名称}.md
• 编号：两位数字，按分类范围编号
• 分类：需求与规划、架构设计、技术流程、事件中心、其他
• 文档名称：简洁明了，使用中文

分类编号范围

• 01-09: 需求与规划
• 10-19: 架构设计
• 20-29: 技术实现文档（核心服务）
• 30-69: 技术专题文档
• 70-79: 多租户相关
• 80-89: 运维部署
• 90-99: 其他（面试题、项目经历、问题记录等）

文档存放说明

• 标准化命名: {编号}-{分类}-{文档名称}.md
• 技术实现文档: 可使用描述性文件名（如 IntelliHub XXX服务实现文档.md）
• 面试与总结: 可使用特定命名格式

新增文档流程

1. 确定文档分类
2. 在对应分类范围内选择编号
3. 按照命名规范创建文档
4. 更新本索引文档
5. 记录更新日志

---

📮 反馈与建议

如有文档相关的问题或建议，请联系项目负责人。