91 lines
6.0 KiB
Markdown
91 lines
6.0 KiB
Markdown
---
|
||
name: g3fo-docs
|
||
description: g3fo 系统相关文档。管理业务流程说明、服务职责定义、中间件标准部署、系统初始化规范，以及跨环境（Dev/UAT）和多客户的资产清单。支持差异化配置查询与业务逻辑问答。
|
||
---
|
||
|
||
# g3fo 系统相关文档 (g3fo-docs)
|
||
|
||
本 Skill 采用“标准模板 + 客户清单”的架构，并整合了**业务流程**与**服务职责**，旨在帮助 AI 快速理解并回答复杂的系统业务问题。
|
||
|
||
## 1. 查找指南
|
||
- **查业务流程**：查阅 `references/business_flows/` (如订单生命周期、用户入金等跨服务流程)。
|
||
- **查服务职责**：查阅 `references/services/` (如 `g3fo-trade-service.md` 定义的具体功能)。
|
||
- **查架构概览**：查阅 `references/architecture/domain_overview.md`。
|
||
- **分析测试流程**：参考 `references/business_flows/_TEST_FLOW_TEMPLATE.md`。
|
||
- **查标准运维流程**：去 `references/middleware/` 或 `references/system-init/`。
|
||
- **查中间件总览/高可用架构**：查阅 `references/middleware/middleware-comprehensive-guide.md`。
|
||
- **查具体环境/客户资产**：
|
||
- 内部环境（Dev/UAT）：查阅 `references/inventory/internal.md`。
|
||
- 外部客户（客户A、B等）：查阅 `references/inventory/clients/[客户名].md`。
|
||
|
||
## 2. 问答逻辑 (AI 引导)
|
||
|
||
### A. 业务逻辑问答
|
||
1. **识别范围**：判断用户问题涉及哪些业务流程 or 服务。
|
||
2. **加载文档**：
|
||
- 优先查找 `business_flows/` 下的相关流程文档。
|
||
- 结合 `services/` 下涉及的服务文档，深入了解具体职责。
|
||
3. **关联分析**：
|
||
- 使用流程文档中的 Mermaid 时序图理解服务间的交互。
|
||
- 如果用户问及“某个功能由谁负责”，查阅 `architecture/domain_overview.md` 确认所属域。
|
||
4. **回答准则**：
|
||
- **基于事实**：仅根据已有的 Markdown 文档回答。
|
||
- **明确边界**：如果文档中没有相关说明，必须回答：“根据现有文档，我无法确定 [具体业务点] 的实现细节，建议查阅代码或询问开发人员。”
|
||
|
||
### B. 运维配置生成
|
||
1. **识别主体**：确定用户问的是哪个环境或哪个客户。
|
||
2. **组合信息**：
|
||
- **读取资产变量**：优先读取客户专属文件（如 `clients/client_a.md`）或内部清单（`internal.md`）中的“变量定义”表格。
|
||
- **读取部署模版**：读取 `middleware/` 下的标准部署文档（如 `keepalived/deploy.md`）。
|
||
- **变量替换**：将部署文档中的 `${VARIABLE_NAME}` 占位符替换为资产清单中对应的值。
|
||
3. **输出要求**：
|
||
- **环境标注**：在提供客户配置时，必须明确标注该配置适用于哪个特定环境，防止误操作。
|
||
- **完整配置**：如果用户要求生成特定节点的配置文件，请直接输出替换后的完整配置内容。
|
||
- **MySQL 命令规范**：
|
||
- **强制包含 Host**：所有 `docker exec` 执行的 `mysql` 命令必须显式包含 `-h127.0.0.1` 参数，以确保在容器内连接成功。
|
||
- **双格式输出**：当提供 SQL 修复或查询脚本时，必须同时提供以下两种格式：
|
||
- **格式 A (Docker 模式)**：完整的 `docker exec -it mysql mysql -uroot -pafe123456 -h127.0.0.1 -e "SQL_CONTENT"`。
|
||
- **格式 B (纯 SQL 模式)**：仅包含 SQL 语句本身，方便在 GUI 工具中执行。
|
||
|
||
### C. 测试流程分析 (New)
|
||
1. **需求解析**：识别用户提出的业务关键词（如“下单”、“撤单”、“充值”）。
|
||
2. **文档检索**：
|
||
- 查找 `business_flows/` 下的业务流程文档。
|
||
- 查找 `services/` 下涉及的服务定义。
|
||
3. **代码溯源**：
|
||
- 根据文档中提到的服务，在项目中搜索对应的 Controller、Service 或核心逻辑代码。
|
||
- **重点搜索路径**：
|
||
- REST 接口：`com.afe.g3fo.*.controller` 或 `com.afe.g3fo.*.api`。
|
||
- Dubbo 接口：`com.afe.g3fo.*.facade`（定义）及 `com.afe.g3fo.*.facade.impl`（实现）。
|
||
- **重点搜索注解**：`@RequestMapping`, `@PostMapping`, `@GetMapping`, `@Service`, `@DubboService` 等。
|
||
4. **表格生成**：汇总信息，输出包含“步骤”、“涉及服务”、“关键接口/代码逻辑”、“测试内容/预期结果”的表格。
|
||
- **格式参考**：`references/business_flows/_TEST_FLOW_TEMPLATE.md`。
|
||
|
||
## 3. 示例 Prompt (用户可参考)
|
||
- **业务咨询**：
|
||
- “我想测试下单业务流程，请分析代码并列出详细的测试步骤表格。”
|
||
- “g3fo 系统中，一个订单从下单到成交会经过哪些服务？请结合 `references/business_flows/` 下的相关文档回答。”
|
||
- “`g3fo-margin-service` 负责哪些核心逻辑？它的上下游依赖是谁？”
|
||
- **部署配置**：
|
||
- “请结合 `references/inventory/internal.md` 中的 `UAT` 环境变量，参考 `references/middleware/keepalived/deploy.md` 部署文档，为我生成 Node A 的 `keepalived.conf` 配置文件。”
|
||
- “请根据 `references/middleware/middleware-comprehensive-guide.md` 和 `references/middleware/nacos/deploy.md`，结合客户资产清单生成 Nacos 部署配置。”
|
||
- **故障排查**：
|
||
- “我的 MySQL 出现了复制冲突，报错 `Duplicate entry`，请根据 `references/middleware/mysql/fault-analysis.md` 提供排查脚本 and 修复建议。”
|
||
|
||
## 4. 资源地图
|
||
- **业务与服务**:
|
||
- **服务职责**: `services/` (g3fo-trade-service, g3fo-margin-service 等)
|
||
- **跨服务流程**: `business_flows/` (订单生命周期等)
|
||
- **架构概览**: `architecture/domain_overview.md`
|
||
- **中间件标准**（部署/故障分析等详见各子目录）:
|
||
- **总览**：`middleware/middleware-comprehensive-guide.md`
|
||
- **Keepalived**: `middleware/keepalived/`
|
||
- **MySQL**: `middleware/mysql/`
|
||
- **Nacos**: `middleware/nacos/`
|
||
- **PowerJob**: `middleware/powerjob/`
|
||
- **Redis**: `middleware/redis/`
|
||
- **RocketMQ**: `middleware/rocketmq/`
|
||
- **Stunnel4**: `middleware/stunnel4/`
|
||
- **系统规范**: 内核优化, 安全加固...
|
||
- **资产清单**: 内部测试机, 客户生产环境...
|