AgileBuilder logoAgileBuilder
返回文档

AI 工作流

配置 AI 按照团队规范工作的流程

概述

AI 工作流是 AgileBuilder 的核心特性之一。它允许你定义 AI 在特定任务下的工作步骤，确保 AI 按照团队规范执行，而不是自由发挥。

例如：你可以配置 AI 在创建项目时，先查看模板列表，再获取模板详情，最后生成项目。

为什么需要 AI 工作流

问题

  • AI 可能不按预期顺序执行任务
  • AI 可能跳过关键步骤
  • AI 生成的结果不符合团队规范
  • 难以保证任务执行的一致性

解决方案

通过定义明确的工作流：

  • 指定 AI 必须遵循的步骤
  • 强制 AI 在特定步骤后查询团队文档
  • 确保关键检查点被执行

工作流定义

基本结构

workflows:
  - name: 创建项目
    trigger: "创建项目" / "生成项目"
    steps:
      - action: listTemplates
        description: "查看可用模板"
      - action: getTemplateInfo
        description: "获取模板详情"
        args:
          template: "${previous.template}"
      - action: queryDocs
        resource: "docs/coding-standards"
        description: "查询代码规范"
      - action: generateProject
        description: "生成项目"

内置工作流

AgileBuilder 提供开箱即用的内置工作流：

创建项目工作流

- name: 创建项目
  trigger:
    - "创建项目"
    - "生成项目"
    - "new project"
  steps:
    - action: listTemplates
      description: "先查看可用的项目模板"
    - action: queryDocs
      when: "docs/*"
      description: "查询相关的团队规范文档"
    - action: generateProject
      description: "使用选定的模板生成项目"
    - action: runHooks
      description: "执行项目初始化"

代码检查工作流

- name: 代码检查
  trigger:
    - "检查代码"
    - "review code"
  steps:
    - action: queryDocs
      resource: "docs/coding-standards"
      description: "获取代码规范"
    - action: queryDocs
      resource: "docs/best-practices"
      description: "获取最佳实践"
    - action: lint
      description: "运行代码检查"

自定义工作流

创建工作流文件

在工作目录创建 .agilebuilder/workflows/ 目录：

mkdir -p .agilebuilder/workflows

定义工作流

创建 project-workflow.yaml：

workflows:
  - name: 企业内部项目创建
    trigger:
      - "创建企业内部项目"
      - "new internal project"
    steps:
      - action: listTemplates
        filter:
          tags: ["internal", "enterprise"]
        description: "查看企业内部模板"
      - action: queryDocs
        resource: "docs/internal-standards"
        description: "获取内部规范"
      - action: queryDocs
        resource: "docs/naming-conventions"
        description: "获取命名规范"
      - action: generateProject
        description: "生成项目"
      - action: verify
        checks:
          - "项目结构符合规范"
          - "已包含必要配置文件"

触发条件

关键词触发

trigger:
  - "创建项目"
  - "new project"
  - "generate project"

正则匹配

trigger:
  pattern: "(创建|生成|new|generate)\\s*(项目|project)"

AI 自动判断

AI 工具可以根据对话上下文自动判断是否触发工作流。

工作流调试

预览工作流

agilebuilder workflow preview project-workflow.yaml

模拟执行

agilebuilder workflow run project-workflow.yaml --dry-run

查看执行日志

agilebuilder workflow logs

团队共享

导出工作流

agilebuilder workflow export my-workflow -o ./workflows/

导入工作流

agilebuilder workflow import ./workflows/team-workflow.yaml

在线版同步

在工作流配置页面，可以将工作流同步到团队。

最佳实践

  1. 简洁明了：每个步骤描述清晰
  2. 必要检查：包含必要的验证步骤
  3. 文档关联：让 AI 始终能查到最新规范
  4. 持续迭代：根据实际使用优化工作流

下一步