Mục tiêu

Bộ prompt này giúp đội ngũ kỹ thuật tạo tài liệu onboarding rõ ràng, có cấu trúc và dễ áp dụng cho lập trình viên mới khi tham gia dự án. Tài liệu được thiết kế để giảm thời gian hỏi đáp lặp lại, giúp thành viên mới hiểu nhanh bối cảnh hệ thống, quy trình phát triển và các tiêu chuẩn kỹ thuật quan trọng.

Khi nào nên dùng

• Khi dự án có lập trình viên mới cần được hướng dẫn setup và làm quen codebase.
• Khi team muốn chuẩn hóa tài liệu nội bộ thay vì truyền đạt rời rạc qua chat hoặc meeting.
• Khi cần cập nhật lại tài liệu kỹ thuật cũ, thiếu cấu trúc hoặc khó theo dõi.
• Khi chuẩn bị bàn giao dự án cho team mới hoặc mở rộng đội ngũ phát triển.

Nội dung tài liệu có thể tạo

• Tổng quan sản phẩm, mục tiêu dự án và bối cảnh nghiệp vụ.
• Kiến trúc hệ thống, stack công nghệ, luồng dữ liệu và các service chính.
• Hướng dẫn cài đặt môi trường local, biến môi trường, database và dependency.
• Cấu trúc thư mục, quy ước đặt tên, tiêu chuẩn code và quy trình review.
• Checklist nhiệm vụ trong ngày đầu, tuần đầu và sprint đầu tiên.

Hướng dẫn tùy biến

1. Thay các thông tin trong ngoặc vuông bằng dữ liệu thực tế của dự án như ngôn ngữ lập trình, framework, repository, database, CI/CD và công cụ quản lý task.
2. Nếu dự án phức tạp, hãy yêu cầu AI chia tài liệu thành nhiều phần: backend, frontend, DevOps, QA và security.
3. Nếu đã có tài liệu cũ, hãy dán vào prompt và yêu cầu AI tái cấu trúc, bổ sung phần còn thiếu, loại bỏ nội dung lỗi thời.
4. Với dự án enterprise, nên bổ sung phần quyền truy cập, chính sách bảo mật, quy trình release và quy trình xử lý incident.

Lưu ý

• Không đưa secret key, password, token hoặc thông tin nhạy cảm vào prompt.
• Yêu cầu AI đánh dấu rõ các phần cần xác minh bởi tech lead hoặc maintainer.
• Nên dùng tài liệu đầu ra như bản nháp, sau đó review lại bằng người phụ trách kỹ thuật.
• Ưu tiên viết ngắn gọn, có checklist và ví dụ lệnh cụ thể để lập trình viên mới dễ làm theo.