Tổng quan AI Workflow

Chào mừng bạn đến với AI Skill Framework Docs!

Đây là website tài liệu tương tác và giả lập quy trình kỹ thuật phần mềm dành cho AI Coding Agent. Hệ thống quản lý toàn bộ chu trình phát triển (SDLC) một cách tự động, bảo mật và an toàn bằng cách gác các chốt duyệt (Approval Gates) và kiểm soát chất lượng qua từng Checkpoint từ 1 đến 10.

🗺️ Sơ đồ Quy trình SDLC Tiêu chuẩn (Standard Flow Diagram)

AI Workflow Infographic

🔑 Nguyên tắc Vàng của Framework

  • Không Thiết kế, Không Lập trình (No Blueprint, No Code): CLI sẽ khóa cứng tính năng viết code nếu không tìm thấy Blueprint đã duyệt.
  • Bảo mật Phân quyền: Hỗ trợ 3 mức phân quyền giúp lập trình viên kiểm soát tuyệt đối hành vi của Agent.
  • Tự động Đồng bộ: Hệ thống tự động sửa đổi metadata và RAG sau mỗi tác vụ hoàn thành để tránh trôi lệch ngữ cảnh.

⚙️ GitHub Pages Deploy

Bộ tài liệu này được cấu hình tự động đóng gói và phát hành từ thư mục interactive-docs/ thông qua GitHub Actions trên repository kyleit/AI-Agent-Workflow.

Địa chỉ website: https://kyleit.github.io/AI-Agent-Workflow/

Dành cho các tính năng có độ phức tạp cao, ảnh hưởng lớn đến cấu trúc và kiến trúc mã nguồn. Quy trình đi qua đầy đủ 10 bước nghiêm ngặt.

1

Khởi tạo phiên làm việc /init

Thiết lập trạng thái dự án, tạo file .session.json và chọn mức độ phân quyền.

CLI command
python skills/workflow-runtime/scripts/workflow_runtime.py init --permission 1
2

Đồng bộ bộ nhớ RAG /memory-sync

Quét git diff và đồng bộ cơ sở dữ liệu vector để đảm bảo Agent nắm được toàn bộ thay đổi gần nhất.

CLI command
python skills/workflow-runtime/scripts/workflow_runtime.py usage sync
3

Brainstorm giải pháp /brainstorm

Agent phân tích yêu cầu của người dùng và phác thảo ý tưởng thiết kế sơ bộ vào thư mục docs/brainstorming/.

CLI command
python skills/workflow-runtime/scripts/workflow_runtime.py start --skill "brainstorming" --command "brainstorm" --checkpoint 3 --step "Brainstorming FEAT-015"
4

Lập kế hoạch thực thi /plan

Xây dựng Kế hoạch thực thi (Implementation Plan) và danh sách công việc task.md.

5

Thiết kế kỹ thuật và Đăng ký Blueprint /blueprint

Tạo bản thiết kế Blueprint tại thư mục docs/designs/ chi tiết từng class, hàm, API sẽ thay đổi và đăng ký lên CLI để khóa cứng phạm vi sửa đổi.

6

Triển khai viết code /implement

Thực hiện viết code dựa theo đúng mô tả của Blueprint. CLI sẽ chặn đứng mọi hành vi sửa code nằm ngoài Blueprint.

7

Chạy thử & Debug /debug

Biên dịch dự án, chạy unit tests, sửa đổi các lỗi phát sinh cho đến khi đạt trạng thái PASS.

8

Visual Debug giao diện /visual-debug

Chạy kiểm thử giao diện trực quan cho các thành phần UI (nếu dự án có thành phần UI).

9

Ký duyệt nghiệm thu /verify

Đối chiếu toàn diện sản phẩm với Đặc tả ban đầu để phê duyệt chất lượng release.

10

Đóng gói & Release /release

Bump version, kết xuất changelog và đẩy code lên kho GitLab/GitHub.

1. Khởi tạo & Đồng bộ Phiên làm việc

Khởi tạo (/init)

Khai báo và thiết lập phiên làm việc mới, chọn mức độ phân quyền.

CLI command
python skills/workflow-runtime/scripts/workflow_runtime.py init --permission 1

Phục hồi (/resume)

Khôi phục nhanh checkpoint làm dở khi đổi hội thoại.

CLI command
python skills/workflow-runtime/scripts/workflow_runtime.py init

2. Bảo trì & Dọn dẹp bộ nhớ

Nén ngữ cảnh (Compact/Snapshot)

Tạo điểm khôi phục nhanh (snapshot) và lưu các thay đổi code tạm thời trước khi rollover.

CLI command
python skills/workflow-runtime/scripts/workflow_runtime.py compact

Đồng bộ Usage (sync)

Tính toán lại lượng token thực tế tiêu thụ dựa trên tệp log transcript mới nhất.

CLI command
python skills/workflow-runtime/scripts/workflow_runtime.py usage sync

3. Giám sát hệ thống

Nhịp tim hệ thống (Heartbeat)

Xem thông tin chi tiết về phiên làm việc hiện tại, checkpoint và dung lượng token context usage.

CLI command
python skills/workflow-runtime/scripts/workflow_runtime.py heartbeat

Kiểm tra phân quyền (Permission)

Hiển thị bảng liệt kê trạng thái của từng hành động nhạy cảm (Được phép / Cần phê duyệt).

CLI command
python skills/workflow-runtime/scripts/workflow_runtime.py permission

Bộ Điều Khiển Giả Lập

Bước 1: Khởi tạo

Hành động của Agent...

Lệnh CLI Agent sẽ chạy: Lệnh CLI...
Tiến độ: Bước 1 / 10
interactive_bash_session.sh

1 Bước 1: Tạo Vault trên ứng dụng Obsidian

Mở ứng dụng Obsidian trên máy tính của Ba để khởi tạo thư viện tri thức trống.

  • Chọn Create new vault (Tạo mới vault).
  • Nhập tên Vault (Ví dụ: AIWF-Knowledge).
  • Chọn đường dẫn thư mục cha để lưu trữ (Ví dụ thư mục Documents hoặc ổ đĩa gắn ngoài).
  • Hệ thống AIWF sẽ tự tạo thư mục con mang tên dự án bên trong thư mục cha này.
Obsidian - Create Vault

Create New Vault

2 Bước 2: Thiết lập Plugin Local REST API

Bật và cấu hình API Key của plugin Local REST API trên Obsidian (Nếu Ba dùng chế độ đồng bộ qua mạng REST).

  • Nhấn biểu tượng bánh răng Settings ở góc dưới bên trái Obsidian.
  • Vào Community Plugins ➔ Tìm kiếm và cài đặt Local REST API.
  • Bật plugin Enable.
  • Trong màn hình cài đặt plugin, sao chép chuỗi mã bảo mật API Key để điền cho CLI ở bước sau.
Obsidian - Settings
Core plugins
Community plugins
Local REST API

Local REST API Settings

3 Bước 3: Cấu hình CLI cho dự án mới

Sử dụng CLI wrapper aiwf để cấu hình nhanh Obsidian Provider trực tiếp trên terminal của dự án.

  • Chạy lệnh: aiwf provider add obsidian --project.
  • Hệ thống sẽ hỏi và tự điền các thông số mặc định (Ba chỉ cần ấn Enter).
  • Cấu hình tự động được lưu vào tệp .agents/memory.config.json.
Terminal - Configuration
$ aiwf provider add obsidian --project
Enter vault_root [/path/to/obsidian]: [Enter]
Enter mode [file-sync]: [Enter]
Create if missing? (y/n) [y]: [Enter]
[SUCCESS] Configured obsidian provider successfully.

4 Bước 4: Đồng bộ & Kiểm tra đồ thị Graph View

Kích hoạt đồng bộ hóa lần đầu để sinh cấu trúc tri thức và liên kết chéo trên Obsidian Graph View.

  • Gõ lệnh aiwf sync obsidian để đồng bộ thủ công.
  • Mở Obsidian lên, Ba sẽ thấy 11 thư mục tri thức mới được phân loại tự động.
  • Mở biểu đồ Graph View trong Obsidian để xem mạng lưới liên kết Wiki-links cực kỳ sinh động của các nốt tri thức.
Obsidian - Graph View
Project Memory
QUICK-028
FIX-024
Blueprints