README.md

DeepSOC 技术文档

DeepSOC (Deep Security Operations Center) 是一个基于AI的安全运营中心系统，采用多代理架构自动化处理安全事件。

文档目录

系统架构

• Architecture.md - 系统整体架构文档
• State_Flow_Design.md - 状态流转设计文档
• Agents.md - 多代理系统设计文档

功能特性

• Engineer_Chat_Architecture.md - 工程师聊天系统架构文档
• Engineer_Chat_Feature.md - 工程师聊天功能说明
• User_Message_Display_Logic.md - 用户消息显示逻辑技术文档

配置指南

• Development_Guide.md - 开发团队必读：版本管理和开发流程指南
• soar-config-help.md - SOAR平台配置帮助文档
• Upgrade_Guide.md - 系统升级和数据库迁移指南
• Version_Management.md - 版本管理和发布流程指南

图片资源

• images/ - 文档相关图片资源

文档分类

📚 开发指南

• Development_Guide.md - 开发团队必读：版本管理和开发流程指南
• Architecture.md - 了解系统整体架构
• Agents.md - 理解多代理系统设计
• State_Flow_Design.md - 掌握状态流转机制

🔧 技术实现

• Engineer_Chat_Architecture.md - 工程师聊天系统的技术实现
• User_Message_Display_Logic.md - 用户消息显示的技术细节

🚀 功能说明

• Engineer_Chat_Feature.md - 工程师聊天功能的使用说明

⚙️ 配置说明

• soar-config-help.md - SOAR平台的配置和使用
• Upgrade_Guide.md - 系统升级和数据库迁移

快速导航

新手入门

1. 阅读 Architecture.md 了解系统架构
2. 查看 Agents.md 理解多代理系统
3. 参考 soar-config-help.md 进行配置

开发者指南

1. 首先阅读 Development_Guide.md 掌握开发流程和版本管理
2. 研究 State_Flow_Design.md 了解状态管理
3. 查看 Engineer_Chat_Architecture.md 理解聊天系统
4. 参考 User_Message_Display_Logic.md 了解消息显示逻辑

功能使用

1. 阅读 Engineer_Chat_Feature.md 了解聊天功能
2. 查看配置文档进行系统设置

文档维护

更新原则

• 所有技术文档应保持与代码同步
• 新功能开发完成后及时更新相关文档
• 重要修复和优化需要相应的技术文档

文档格式

• 使用 Markdown 格式编写
• 包含清晰的标题层次结构
• 添加必要的代码示例和图表
• 提供测试和验证方法

贡献指南

• 新增功能请同时提供技术文档
• 修复问题请更新相关文档
• 保持文档的准确性和完整性

相关链接

• 主项目: ../README.md - 项目主要说明文档
• 开发指南: ../CLAUDE.md - AI助手开发指南
• 更新日志: ../changelog.md - 项目更新记录

---

文档版本: 1.0
创建日期: 2025-07-06
维护团队: DeepSOC开发团队