Khởi tạo System Foundation
Role: Solution Architect | Technical Lead 🏗️
Foundation là tập hợp các tài liệu kỹ thuật nền tảng của System — chúng tạo thành Knowledge Base mà AI Agent đọc trước khi sinh BRD, FRD, hay Implementation Plan. Tài liệu Foundation càng đầy đủ và chính xác, output của AI càng phản ánh đúng tech stack và kiến trúc thực tế của dự án.
Hướng dẫn thao tác
- Trong System Management, chọn System từ danh sách bên trái.
- Chuyển sang tab "Foundation".
Giao diện tab Foundation
Tab chia thành hai vùng:
- Cột trái — danh sách các Foundation Document đã tạo, có ô tìm kiếm và nút "+ New Document" phía trên.
- Vùng phải — editor soạn thảo nội dung của document đang chọn.
Empty state khi chưa có tài liệu nào:
- Cột trái: "No documents yet" — "Create your first foundation document"
- Vùng phải: "Select a document — Choose a document from the list to start editing"
Tạo Foundation Document mới
-
Nhấn "+ New Document" ở đầu cột trái.
-
Modal "New Foundation Document" mở ra. Điền thông tin:
Trường Bắt buộc Ghi chú Document Name Có Tên tài liệu (tối đa 200 ký tự) Description Không Mô tả ngắn về mục đích tài liệu (tối đa 500 ký tự, có đếm ký tự) -
Nhấn "Create". Document mới xuất hiện trong danh sách và được tự động chọn.
Soạn thảo nội dung
Sau khi tạo, document được chọn và vùng editor phải hiển thị. Nội dung ban đầu trống.
- Nhấn icon Edit (bút chì) để vào chế độ chỉnh sửa.
- Soạn thảo nội dung trong rich text editor (Tiptap) — hỗ trợ Markdown, heading, bullet list, code block, bảng...
- Sau khi soạn xong, nhấn "Save" để lưu. Nhấn "Cancel" để huỷ thay đổi và quay về nội dung trước đó.
Quản lý Foundation Documents
Tìm kiếm: gõ vào ô "Search documents..." để lọc theo tên.
Chuyển giữa các documents: nhấn vào item trong danh sách cột trái — nội dung tải lên ở vùng editor phải.
Mỗi item trong danh sách hiển thị:
- Tên document (bold)
- Đoạn mô tả ngắn (120 ký tự đầu của nội dung)
- Thời gian cập nhật lần cuối
Xoá document: nhấn icon thùng rác 🗑️ xuất hiện khi hover vào item → xác nhận trong modal "Delete Document?":
"This will permanently delete "[tên document]" and all its content."
Nhấn "Delete" (đỏ) để xác nhận. Thao tác không thể hoàn tác.
Các tài liệu Foundation nên có
Dưới đây là danh sách tài liệu thường được tạo cho một System kỹ thuật. Không bắt buộc phải có đủ, nhưng càng đầy đủ AI Agent hoạt động càng hiệu quả:
| Tài liệu | Nội dung gợi ý |
|---|---|
| Tech Stack | Ngôn ngữ, framework, thư viện chính đang dùng |
| Architecture Overview | Sơ đồ tổng thể, kiểu kiến trúc (microservice, monolith...), các component chính |
| Coding Standards | Quy ước đặt tên, cấu trúc folder, code style guide |
| Database Design | Sơ đồ ERD, naming convention, indexing |
| API Design Principles | Chuẩn REST/GraphQL, versioning, format lỗi |
| Security Standards | Auth method (JWT/OAuth), RBAC, input validation |
| Deployment & DevOps | CI/CD pipeline, Docker, cloud provider, quy trình deploy |
| Performance Standards | SLA, caching strategy, rate limiting |
| Integration Points | Các external API, third-party service, message queue đang tích hợp |
Nếu không có đủ thời gian viết tất cả, ưu tiên theo thứ tự: Tech Stack → Architecture Overview → API Design Principles → Database Design. Bốn tài liệu này cho AI đủ ngữ cảnh để sinh tài liệu kỹ thuật có chất lượng ngay từ đầu.
Hoàn thành bước này đồng nghĩa với việc System đã được khởi tạo đầy đủ. Team có thể bắt đầu Phase 4: Sinh tài liệu với AI Agent — tạo BRD, FRD, Test Cases từ Jira ticket, với AI Agent sử dụng toàn bộ ngữ cảnh vừa thiết lập.