SSkilnexa
SkillKỹ thuật phần mềmHợp với: Lập trình viênMức: Kỹ thuật

Tạo bài dẫn đọc mã theo từng bước (CodeTour)

code-tour

Tạo tệp .tour hướng dẫn từng bước qua mã thật, gắn với tệp và dòng cụ thể, viết cho đúng đối tượng: người mới, người soát PR, người điều tra lỗi.

Tải miễn phí. Theo dõi Skilnexa một lần là mở khoá mọi lượt tải trên web.

Nút theo dõi đang được chuẩn bị.
Link tải đang được chuẩn bị.

Nó là gì

Tạo tệp .tour cho VS Code (CodeTour): một chuỗi bước đi qua mã nguồn, mỗi bước trỏ tới file và số dòng thật, viết theo người đọc như người mới vào dự án hoặc người review PR. Dành cho lập trình viên dùng VS Code.

Hoạt động ra sao

AI đọc cấu trúc repo, README và file cấu hình, rồi chọn đối tượng và độ sâu, ví dụ người mới thì mức trung bình, kiến trúc thì mức sâu. Sau đó nó viết file .tour trong thư mục .tours, và kiểm tra lại mọi đường dẫn và số dòng trước khi ghi.

Ví dụ ứng dụng

Tình huống
Một lập trình viên mới vào nhóm cần hiểu luồng đăng nhập của dự án.
Bạn đưa vào
Thư mục dự án và yêu cầu: tạo tour cho người mới, tập trung vào luồng đăng nhập.
Bạn nhận được
Một tệp .tour trong thư mục .tours, tên dạng persona-focus, mỗi bước trỏ đúng file và dòng đã kiểm, kèm lời giải thích.

Ví dụ minh họa theo quy trình trong tài liệu gốc, chưa phải kết quả thử chạy.

Dùng khi nào

Khi có thành viên mới vào dự án và bạn muốn dẫn họ đi qua kiến trúc.

Các phần chính trong hướng dẫn

  1. Khám phá kho mã
  2. Suy ra mục đích bài dẫn đọc
  3. Đọc các tệp thật
  4. Viết bài dẫn đọc
  5. Chọn loại bước và số bước
  6. Viết mô tả theo công thức SMIG
  7. Kiểm tra bài dẫn đọc
  8. Chọn đối tượng và mạch kể
Xem mô tả gốc của tác giả (tiếng Anh)

Use when the user asks to create a CodeTour .tour file — persona-targeted, step-by-step walkthroughs that link to real files and line numbers. Trigger for: create a tour, onboarding tour, architecture tour, PR review tour, explain how X works, vibe check, RCA tour, contributor guide, or any structured code walkthrough request.

Ví dụ yêu cầu

  • User asks to create a code tour, onboarding tour, or architecture walkthrough
  • User says "tour for this PR", "explain how X works", "vibe check", "RCA tour"
  • User wants a contributor guide, security review, or bug investigation walkthrough
  • Any request for a structured walkthrough with file/line anchors

Cùng nhóm Kỹ thuật phần mềm

Phần giải thích do Skilnexa viết sau khi đọc toàn bộ tài liệu gốc của tác giả và đã đối chiếu lại với nội dung gốc. Chưa phải kết quả thử chạy, nên hãy thử bằng dữ liệu giả trước khi dùng cho việc thật.