AdaFlow

I. Tổng quan

AdaFlow là nhóm tài liệu mô tả khả năng tự động hóa theo mô hình flow trực quan, gồm builder để cấu hình flow, catalog node để xây dựng logic, và nhóm tài liệu theo dõi việc chạy flow sau khi xuất bản.

1. Vấn đề

  • Nhiều rule tự động trong CRM, chat, marketing hoặc tích hợp ngoài thường được cấu hình rời rạc ở từng module, khiến người dùng khó nhìn tổng thể luồng xử lý.
  • Khi rule có nhiều bước nối tiếp như chờ thời gian, gửi email, cập nhật dữ liệu CRM hoặc phản ứng theo tin nhắn mới, cách cấu hình dạng form đơn lẻ không còn đủ trực quan.
  • Nếu thiếu tài liệu gốc cho AdaFlow, các file node dễ dùng thuật ngữ không thống nhất, khó biết node nào là trigger, node nào là action và tài liệu nào mô tả flow ở mức tổng thể.

2. Giải pháp

  • Chuẩn hóa tài liệu AdaFlow theo ba lớp:
    • Flow: mô tả khái niệm flow và màn hình builder.
    • Node: mô tả catalog node, nhóm node và từng node đại diện.
    • Run: mô tả báo cáo và chi tiết các lần chạy sau khi flow được xuất bản.
  • Tái sử dụng khung tài liệu chung của thư mục dev, nhưng điều chỉnh nội dung cho phù hợp với automation và flow builder.
  • Bám ý tưởng từ Figma page UCALL | AdaFlow: có canvas flow, card node, panel cấu hình bên phải và ví dụ các node như Scheduler, Email, Hẹn giờ.

3. Đối tượng

  • BA, PO, Dev, QA, Designer và các bên cần hiểu cách tổ chức AdaFlow trước khi đặc tả từng node hoặc từng flow cụ thể.
  • Nhóm vận hành CRM, CSKH, marketing automation hoặc người cấu hình tích hợp là nhóm người dùng cuối điển hình của module này.

4. Tầm nhìn/insight

  • Cho phép mở rộng thêm nhiều node mới mà không phá vỡ cấu trúc tài liệu đang có.
  • Hướng tới việc có flow template, node library, versioning flow và báo cáo vận hành chi tiết hơn trong tương lai.

II. Yêu cầu chức năng

1. Danh sách tính năng

  • Mô tả tổng quan module AdaFlow.
  • Điều hướng tài liệu từ flow sang node và run.
  • Chỉ ra file nào là tài liệu gốc, file nào là tài liệu ví dụ theo nhóm node.
  • Xác định thứ tự đọc khuyến nghị cho người mới.

2. Đặc tả chi tiết

3. Danh sách nghiệp vụ

  • README.md là file điều hướng gốc của folder adaflow, không thay thế cho flow.md hoặc node_overview.md.
  • Tài liệu gốc ở root folder phải ưu tiên định nghĩa khái niệm, phạm vi và điều hướng.
  • Tài liệu node đại diện chỉ là ví dụ cho pattern tài liệu; không mặc định đồng nghĩa toàn bộ node khác đã có cùng mức độ hoàn thiện.

4. Giao diện

  • Figma tham chiếu chính của module:
    • https://www.figma.com/design/tBBrdtHlG1LAYJUfJsvyS3/UCALL-2026–Ant-Design-5.10.1-?node-id=4-154796&m=dev
  • Page Figma hiện thể hiện rõ:
    • Builder canvas.
    • Panel cấu hình node.
    • Các biến thể trigger theo lịch.
    • Ví dụ action node như Email, Hẹn giờ.

III. Yêu cầu phi chức năng

  • Tính nhất quán tài liệu: Tất cả file trong adaflow phải dùng cùng thuật ngữ như flow, trigger node, action node, run, publish, input, output.
  • Khả năng mở rộng: Folder phải đủ rõ để có thể thêm node mới theo nhóm mà không phải thay đổi cấu trúc tài liệu gốc.
  • Khả năng truy vết: Người đọc có thể lần theo từ tài liệu khái niệm đến tài liệu node cụ thể và tài liệu run mà không cần đoán nơi đặt thông tin.

IV. Dependency (liên quan & phụ thuộc)

V. API Contract (dev viết)

  • File này không định nghĩa API contract.
  • API cụ thể của flow, run hoặc từng node cần được mô tả ở tài liệu chi tiết tương ứng khi đã có thiết kế kỹ thuật.

VI. Test case (BA hoặc tester viết)

  • TC1: Mở folder adaflow -> Có thể xác định ngay file nào mô tả flow, file nào mô tả node và file nào mô tả run.
  • TC2: Người đọc mới đi theo thứ tự đọc khuyến nghị -> Có thể hiểu cấu trúc module mà không cần hỏi thêm.
  • TC3: Khi thêm một node mới vào hệ thống -> Có thể xác định nơi đặt tài liệu và template cần dùng.