文档概览 (Documentation Overview)
欢迎查阅 witty-diagnosis-agent 的文档库。为了帮助您快速找到所需信息,我们按照功能与受众将文档整理如下:
📚 使用与配置 (Guide & Configuration)
面向最终用户与运维人员的操作指南。
- 安装指南 (INSTALLATION): 详细的安装步骤,涵盖在线、离线及源码安装。
- 使用说明 (USAGE): 快速上手指南,包括模式选择、核心功能(诊断/问答/修复)及常见问题。
- 贡献指南 (CONTRIBUTING): 扩展开发指导,讲解 Skill 的定义、开发流程及最佳实践。
- 配置参考 (Configuration): 完整的配置项说明。
📏 标准与规范 (Standards)
面向开发者与贡献者的设计规范与接口定义。
- Skill 接口规范: 如何开发与集成自定义 Skill。
- 运维 Skills 定义规范: 专为运维场景定制的 Skills 开发与安全标准。
- Skill 文档格式: Skill 文档的编写标准。
- 数据格式: 系统交互的数据结构定义。
- Xuanyuan 测试输入标准: 统一手动和自动化端到端验证的用户反馈式输入要求。
- 命令规范: CLI 命令的设计准则。
🗺️ 路标与演进 (Roadmap)
项目的未来规划与迭代计划。
- Roadmap v0.1.0: 当前迭代规划,包含核心架构、双模运行及基础诊断能力的构建。
📖 参考手册 (Reference)
详细的技术参考文档与架构设计。
- 开发框架架构 (Architecture): 系统的核心架构设计、Agent 角色定义及分阶段执行流程。
- Agent 使用手册 (Agent Usage): 详细介绍了 Fuxi、Dayu、Baize、Nuwa 等核心 Agent 的功能与使用技巧。
- 功能列表 (Features): 系统功能清单。
- CLI 手册 (CLI): 命令行工具的详细用法。
🔧 故障排查 (Troubleshooting)
遇到问题时的排查指引。
- OpenCode 排查: 常见问题与解决方案。