Context từ Tài liệu Dự án

Trong khi codebase cung cấp cho Agentic IDE bối cảnh về cách một hệ thống được xây dựng, thì tài liệu dự án lại cung cấp bối cảnh về tại sao nó được xây dựng như vậy. Đây là nguồn context chiến lược, giúp Agent hiểu được mục tiêu kinh doanh, yêu cầu chức năng, và các quyết định kiến trúc đằng sau mã nguồn.

Cung cấp tài liệu dự án giúp Agent không chỉ viết code, mà còn viết code đúng với tầm nhìn của sản phẩm.

Các loại tài liệu dự án hữu ích

Bạn có thể cung cấp cho Agent nhiều loại tài liệu khác nhau, tùy thuộc vào giai đoạn và nhu cầu của dự án:

1. Tài liệu Yêu cầu (Requirements Documents)

• Nội dung: Mô tả chi tiết các tính năng, luồng người dùng (user flows), và các quy tắc nghiệp vụ (business rules).
• Lợi ích: Giúp Agent hiểu được mục đích của một tính năng. Ví dụ, khi được yêu cầu tạo một form đăng ký, Agent sẽ biết cần những trường thông tin nào nếu được cung cấp tài liệu yêu cầu.

2. Tài liệu Thiết kế Kỹ thuật / Kiến trúc

• Nội dung: Mô tả về kiến trúc tổng thể của hệ thống, các quyết định công nghệ, các mẫu thiết kế (design patterns) được sử dụng, và cách các thành phần tương tác với nhau.
• Lợi ích: Đảm bảo code do Agent tạo ra tuân thủ đúng kiến trúc đã được phê duyệt. Ví dụ, nếu tài liệu kiến trúc quy định sử dụng Microservices, Agent sẽ không đề xuất tạo một monolith.

3. Sơ đồ Cơ sở dữ liệu (Database Schema)

• Nội dung: Sơ đồ mô tả các bảng, các trường, và mối quan hệ giữa chúng trong cơ sở dữ liệu.
• Lợi ích: Giúp Agent viết các câu truy vấn chính xác, hiểu được cách join các bảng, và đảm bảo tính toàn vẹn dữ liệu khi thực hiện các thao tác CRUD (Create, Read, Update, Delete).

4. Thiết kế Giao diện (UI/UX Design)

• Nội dung: Các file thiết kế từ Figma, Sketch, hoặc Adobe XD, cùng với các style guide về màu sắc, font chữ, và component.
• Lợi ích: Giúp Agent tạo ra các giao diện người dùng pixel-perfect, nhất quán với thiết kế đã được duyệt.

Cách cung cấp tài liệu cho Agent

• Thông qua Prompt: Bạn có thể sao chép và dán các phần quan trọng của tài liệu trực tiếp vào prompt.
• Tạo file Markdown trong dự án: Tạo một thư mục docs/ trong dự án và lưu các tài liệu quan trọng dưới dạng file Markdown. Sau đó, bạn có thể yêu cầu Agent đọc các file này.
• Sử dụng các tính năng chuyên dụng: Một số IDE có các tính năng cho phép bạn "nhúng" (embed) các tài liệu từ các nguồn bên ngoài như Confluence, Notion, hoặc Google Docs.

Việc đầu tư vào việc cung cấp tài liệu dự án cho Agent sẽ giúp nâng cao chất lượng công việc của nó từ mức "chạy được" lên mức "đáp ứng đúng yêu cầu kinh doanh".