Chuyển tới nội dung chính

Workflows

Workflows là tập hợp các quy trình làm việc được chuẩn hóa, giúp tự động hóa và định hướng các bước phát triển phần mềm khi làm việc với AI agents. Các workflows trong AIDK được lưu trữ tại thư mục .agent/workflows/ (hoặc tương ứng với IDE của bạn). Bạn có thể gọi workflows qua các lệnh slash command (ví dụ: /new-requirement, /execute-plan).

Luồng công việc chính: /new-requirement

/new-requirement là quy trình cốt lõi để khởi tạo và quản lý tài liệu phát triển cho một tính năng mới. Quy trình này đảm bảo tính năng được phân tích, thiết kế và lên kế hoạch một cách bài bản trước khi bước vào giai đoạn code.

Mục tiêu

  • Chuẩn hóa tài liệu: Đảm bảo tất cả các tính năng đều có đầy đủ tài liệu từ yêu cầu, thiết kế đến kế hoạch.
  • Giảm thiểu sai sót: AI sẽ phân tích kỹ lưỡng yêu cầu trước khi đề xuất kiến trúc và các bước thực hiện.
  • Dễ dàng theo dõi: Mỗi tính năng sẽ có một luồng tài liệu riêng biệt, dễ dàng kiểm tra chéo (cross-check).

Các bước trong /new-requirement

  1. Thu thập yêu cầu (Capture Requirement) AI sẽ yêu cầu bạn cung cấp các thông tin cơ bản: Tên tính năng (kebab-case, ví dụ: user-authentication), vấn đề mà tính năng giải quyết, đối tượng người dùng, và các user stories chính.

  2. Khởi tạo cấu trúc tài liệu (Create Feature Documentation Structure) AIDK sẽ copy nội dung từ các templates và tạo các file riêng biệt cho tính năng mới:

    • docs/ai/requirements/feature-{name}.md
    • docs/ai/design/feature-{name}.md
    • docs/ai/planning/feature-{name}.md
    • docs/ai/implementation/feature-{name}.md
    • docs/ai/testing/feature-{name}.md
  3. Giai đoạn Yêu cầu (Requirements Phase) AI sẽ điền vào file docs/ai/requirements/feature-{name}.md các thông tin: phát biểu bài toán (problem statement), mục tiêu (goals/non-goals), user stories, tiêu chí thành công (success criteria), các ràng buộc và các câu hỏi còn mở.

  4. Giai đoạn Thiết kế (Design Phase) Sau khi chốt yêu cầu, AI điền vào docs/ai/design/feature-{name}.md: thay đổi kiến trúc, mô hình dữ liệu, APIs, các components, các quyết định thiết kế, cân nhắc về bảo mật và hiệu năng.

  5. Giai đoạn Kế hoạch (Planning Phase) AI phân rã công việc trong docs/ai/planning/feature-{name}.md: chia nhỏ task/subtasks, xác định sự phụ thuộc (dependencies), ước tính nỗ lực, thứ tự thực hiện và nhận diện rủi ro.

  6. Đánh giá Tài liệu (Documentation Review) AI tự động chạy các bước review (/review-requirements, /review-design, /review-implementation) để xác thực chất lượng tài liệu.

  7. Các bước tiếp theo (Next Steps) Workflow này tập trung vào khâu lập kế hoạch và tài liệu. Khi đã sẵn sàng code, bạn sẽ dùng lệnh /execute-plan để AI bắt tay vào thực thi các task đã được vạch ra.

Tổng quan các Workflows khác

Bên cạnh /new-requirement, AIDK còn cung cấp hệ sinh thái workflows mạnh mẽ:

Slash CommandMục đích
/execute-planThực thi kế hoạch đã lập từng bước một.
/debugPhân tích sâu nguyên nhân gốc rễ (root-cause) trước khi sửa code.
/code-reviewThực hiện review code trước khi tạo Pull Request.
/write-testsBổ sung unit/integration tests cho tính năng vừa làm.
/update-docsĐồng bộ nội dung README và Docusaurus với thay đổi mới nhất.
/check-implementationSo sánh code đã viết với thiết kế và yêu cầu ban đầu.