Ruby

Hướng dẫn đăng bài cho Hộp thư chung Ruby-Talk

Bạn nên tuân theo các hướng dẫn này khi đăng bài lên hộp thư chung ruby-talk.

  1. Luôn luôn thân thiện, chu đáo, khéo léo và lịch sự. Chúng ta muốn giữ danh sách này thân thiện với số lượng ngày càng tăng của những người mới, người rất trẻ, và giáo viên của họ, cũng như phục vụ các bậc cao thủ. :-)

  2. Giữ nội dung của bạn liên quan và dễ theo dõi. Cố gắng giữ nội dung ngắn gọn và đi thẳng vào vấn đề, nhưng cũng cố gắng bao gồm tất cả thông tin liên quan.

    1. Các hướng dẫn định dạng chung (hay còn gọi là Netiquette) là những quy tắc thông thường và phép lịch sự giúp người khác dễ theo dõi (trong thời gian thực hoặc khi xem lưu trữ):

      • Xin lưu ý: Đặt văn bản trích dẫn từ bài viết trước trước phần trả lời của bạn và trích dẫn có chọn lọc những phần liên quan.
      • Sử dụng văn bản thuần; không sử dụng HTML, RTF, hoặc Word. Hầu hết các chương trình email đều có tùy chọn này; nếu chương trình của bạn không có, hãy tải một chương trình (miễn phí) hoặc sử dụng dịch vụ trực tuyến có tính năng này.
      • Đưa ví dụ từ tệp dưới dạng văn bản trực tiếp trong email; không sử dụng tệp đính kèm.

    2. Nếu báo cáo một vấn đề, hãy cung cấp tất cả thông tin liên quan ngay từ lần đầu; đây không phải nhóm tin bói toán. :-)

      Khi phù hợp, hãy bao gồm:

      • một ví dụ (tốt nhất là đơn giản) tái hiện vấn đề
      • các thông báo lỗi thực tế
      • phiên bản Ruby (ruby -v)
      • loại và phiên bản hệ điều hành (uname -a)
      • tên và phiên bản trình biên dịch được sử dụng để biên dịch Ruby

  3. Viết tiêu đề có tính thông tin tối đa, để những người quan tâm sẽ đọc bài viết của bạn và để những người không quan tâm có thể dễ dàng bỏ qua.

    Hữu ích mô tả nội dung bài viết của bạn.

    Ví dụ tốt:

    • “Làm sao tôi có thể làm x với y trên z?”
    • “Vấn đề: đã làm x, mong đợi y, nhận được z.”
    • “BUG: làm x với module y bị crash z.”

    Ví dụ không tốt:

    • “Xin giúp đỡ!!!”
    • “Câu hỏi của người mới”
    • “Cần cao thủ Ruby cho tôi biết sai ở đâu”

    Các tiền tố sau đã trở nên phổ biến cho tiêu đề:

    • [ANN] (cho các thông báo)
    • [BUG] (cho báo cáo lỗi)
    • [OT] (cho chủ đề ngoài lề, nếu bạn buộc phải đăng ngoài lề)

  4. Cuối cùng, hãy chu đáo: Đừng quá lười biếng. Nếu bạn đang tìm kiếm thông tin, trước tiên hãy nỗ lực hợp lý để tự tìm. Khi phù hợp, hãy kiểm tra trang chủ Ruby, kiểm tra FAQ Ruby và tài liệu khác, sử dụng công cụ tìm kiếm để tìm trong các bài đăng cũ, v.v.

Các hướng dẫn này được lấy từ FAQ comp.lang.ruby.