Tìm hiểu và làm quen với codebase mới

Tags: Onboarding | Code understanding | Architecture | Knowledge transfer

1. Mục đích

Sử dụng quy trình này khi bạn mới tham gia vào một dự án hoặc làm việc trong một kho mã nguồn (repository) chưa quen thuộc. CodeVista sẽ vẽ bản đồ cấu trúc dự án, xác định các module và điểm nhập (entry point) quan trọng, lần theo một luồng xử lý tiêu biểu và đề xuất các tài liệu/mã nguồn nên đọc trước tiên.

2. Trước khi bắt đầu

• Mở repository mục tiêu trong IDE và cho phép CodeVista truy cập các thư mục cần thiết.
• Lựa chọn phân tích toàn bộ repository hay tập trung vào một module/tính năng cụ thể.
• Đính kèm file README và Workspace Rules nếu có để tăng độ chính xác.

3. Lời nhắc khởi động (Starter Prompt)

Hãy giúp tôi tìm hiểu và làm quen với codebase này với tư cách là một lập trình viên mới. 
 
Phạm vi: [Toàn bộ repository, module, hoặc tính năng] 
Mục tiêu: [Kiến trúc tổng quan, luồng nghiệp vụ, hoặc tính năng cụ thể] 
 
Cung cấp: 
1. Mục đích dự án và stack công nghệ được phát hiện 
2. Các module chính cùng trách nhiệm của từng module 
3. Các điểm nhập (entry points) chính 
4. Cách các thành phần chính tương tác với nhau 
5. Một luồng thực thi hoặc luồng nghiệp vụ hoàn chỉnh từ đầu đến cuối (end-to-end) 
6. Các dịch vụ bên ngoài, cơ sở dữ liệu và các dependency quan trọng 
7. Thứ tự đọc code được đề xuất cho một thành viên mới 
 
Đối với mỗi nhận định kỹ thuật, hãy dẫn chứng đường dẫn file và symbol liên quan. 
Nêu rõ các giả định và thông tin còn thiếu. 
Không chỉnh sửa bất kỳ file nào.

4. Cách sử dụng

1. Mở repository và xác định phạm vi bạn muốn tìm hiểu.
2. Chạy Lời nhắc khởi động trên CodeVista.
3. Xem xét các file được trích dẫn, điểm nhập và trách nhiệm của từng module.
4. Mở các file được khuyến nghị theo thứ tự đọc đề xuất.
5. Đặt các câu hỏi tiếp theo tập trung vào một module, symbol hoặc luồng nghiệp vụ cụ thể.

5. Kết quả mong đợi

• Tổng quan về repository: Giải thích súc tích về mục đích của dự án, công nghệ sử dụng và cấu trúc tổng thể.
• Bản đồ kiến trúc: Xác định rõ ràng các module chính, điểm nhập, các dependency và tương tác giữa chúng.
• Dẫn chứng minh bạch: Mọi nhận định kỹ thuật đều đi kèm đường dẫn file và symbol cụ thể.
• Kế hoạch đọc code: Các file quan trọng được sắp xếp theo thứ tự ưu tiên kèm lý do cho thành viên mới.

6. Mẹo hữu ích

• Bắt đầu với các câu hỏi bao quát, sau đó thu hẹp phạm vi vào một tính năng hoặc luồng xử lý cụ thể.
• Luôn yêu cầu đường dẫn file và symbol để có thể đối chiếu trực tiếp trên repository.
• Lần theo một hành động của người dùng từ điểm nhập đến nơi lưu trữ dữ liệu để kiểm chứng bản tóm tắt kiến trúc.