Chọn đoạn văn bạn cần hỗ trợ
Giả sử bạn đang kiểm tra một tuyên bố cài đặt trong README công khai của dự án mình trước khi đề cập đến nó trong một bài viết. Tìm đúng đoạn văn và các điều kiện gần đó. Tiêu đề kho lưu trữ hay tiểu sử hồ sơ không thay thế cho tệp chứa tuyên bố.
Giữ nhiệm vụ trong phạm vi tài liệu. Bạn không cần chạy dự án, kiểm tra thông tin liên hệ cá nhân hay coi tài khoản của người đóng góp là bằng chứng về danh tính riêng tư.
Thay chế độ xem nhánh đang thay đổi bằng liên kết phiên bản
GitHub giải thích rằng chế độ xem tệp thông thường thường hiển thị đầu hiện tại của một nhánh, nên nội dung có thể thay đổi khi các commit đến. Khi đang xem tệp, nhấn y sẽ đổi URL thành permalink dùng một commit cụ thể thay vì tên nhánh. Nguồn
Sao chép URL thực sự hiển thị sau thao tác đó. Mở lại và xác nhận rằng nó hiển thị cùng tệp và đoạn văn. Không tự tạo mã định danh commit hay dựng trích dẫn từ bản xem trước tìm kiếm mà bạn chưa mở.
Giữ một ghi chú riêng nếu bạn cũng muốn địa chỉ nhánh hiện tại. Liên kết phiên bản trả lời câu hỏi “tôi đã kiểm tra cách diễn đạt nào?” trong khi chế độ xem nhánh cho phép bạn kiểm tra dự án hiện trình bày gì.
Ghi đủ ngữ cảnh cho người đọc khác
| Trường | Ghi từ lần kiểm tra của bạn | Mục đích |
|---|---|---|
| Kho lưu trữ và tệp | Dự án thực tế và đường dẫn tệp | Xác định tài liệu đang được trích dẫn |
| Mã định danh commit | Phiên bản trong permalink đã sao chép | Phân biệt ảnh chụp này với các chỉnh sửa sau |
| Đoạn văn hỗ trợ | Một trích đoạn ngắn hoặc bản tóm tắt trung thực | Giới hạn tuyên bố trong cách diễn đạt đã kiểm tra |
| Điều kiện gần đó | Phiên bản, môi trường hoặc giới hạn tính năng | Tránh bỏ sót một điều kiện định tính |
| Ngày truy cập | Khi bạn mở nguồn | Tách thời điểm xem xét của bạn khỏi lịch sử xuất bản |
Với một README minh họa nói rằng tính năng xuất là thử nghiệm, tuyên bố được hỗ trợ vẫn giữ “thử nghiệm.” Một URL ổn định không biện minh cho việc viết lại nó thành bảo đảm đã được kiểm chứng. Ví dụ này minh họa thực hành trích dẫn; nó không phải báo cáo về một kho lưu trữ thực tế.
Quyết định xem một tuyên bố cũ còn phù hợp không
Nếu nhánh hiện tại khác đi, hãy giữ cả hai quan sát: phiên bản trước bạn đã trích dẫn và cách diễn đạt hiện tại bạn thực sự đã mở. Không âm thầm thay thế trích dẫn cũ trong khi vẫn mô tả nó là cùng một lần xem xét.
Một tệp có thể chứa kế hoạch, ví dụ hoặc hướng dẫn lỗi thời. Hãy gán các tuyên bố đó cho dự án thay vì tuyên bố bạn đã tự kiểm tra việc triển khai. Nếu sau này không truy cập được, hãy ghi lại hạn chế đó; mã định danh phiên bản không phải lời hứa về lưu trữ vĩnh viễn hay quyền truy cập.
Điều này cũng tách biệt với huy hiệu commit đã ký. Hướng dẫn về huy hiệu GitHub Verified đề cập tín hiệu khác đó. Để có bản tổng hợp rộng hơn về tài liệu công khai, hãy dùng danh sách kiểm tra nguồn AI và giữ lại phiên bản chính xác mà mỗi tuyên bố quan trọng dựa vào.