7 nguyên tắc viết README hiệu quả trên Github

7 nguyên tắc viết README hiệu quả trên Github

Trong bài viết này, mình sẽ giới thiệu đến bạn “7 nguyên tắc viết README hiệu quả trên Github”. Nào, bắt đầu thôi!

7 nguyên tắc viết README hiệu quả trên Github

Khoảng bốn năm, mình thấy mình là một tín đồ của sự đơn giản. Sự đơn giản giúp thúc đẩy giao tiếp hiệu quả và nó không bao giờ là một mục tiêu dễ dàng đạt được. 

Khi mình trở nên chuyên nghiệp hơn với mảng đã chọn, thật hấp dẫn để cung cấp cho khán giả của mình nhiều thông tin chi tiết; tuy nhiên, làm như vậy gần như đảm bảo rằng khán giả của tớ sẽ bị phân tâm khỏi thông điệp cốt lõi mà mình muốn đưa ra.

Viết README, dường như là chìa khóa cho sự nghiệp của lập trình viên web, thu hút sự chú ý của tớ khi chuẩn bị danh mục đầu tư làm việc của mình. Viết README có thể là điểm tiếp xúc đầu tiên của nhà tuyển dụng tương lai của mình. 

Nó đóng một vai trò quan trọng để thể hiện khả năng của tớ trong giao tiếp bằng văn bản. Nó cũng cho thấy cách bản thân giao tiếp, đó là một dấu hiệu của sự phù hợp với văn hóa.

Bài viết này được viết để làm kim chỉ nam cho bản thân mình về chiến lược bám sát để có thể hình thành một phong cách giao tiếp vững chắc. Tớ sẽ cố gắng làm cho nó đơn giản và ngắn gọn nhất có thể. Xin lưu ý rằng nội dung bên dưới có thể thay đổi theo thời gian, vì tôi có thể khám phá ra một cách mới phù hợp hơn với phong cách của mình.

README là gì ?

7 nguyên tắc viết README hiệu quả trên Github

Về cơ bản,  README  là một tệp văn bản (.txt hoặc .md) hoạt động như tài liệu cho một dự án hoặc thư mục. Nó thường là phần  documentation  và  landing page  dễ thấy nhất cho hầu hết các dự án nguồn mở. Ngay cả tên tệp  README  cũng được viết hoa toàn bộ để thu hút sự chú ý của người đọc và đảm bảo đó là điều đầu tiên họ đọc.

Có bằng chứng cho thấy  README  có từ những năm 1970. Ví dụ lâu đời nhất mà t có thể tìm thấy là README này cho máy tính PDP-10 của DEC, ngày 27 tháng 11 năm 1974. Mặc dù nguồn gốc của tên  README  bị tranh cãi, hai lý giả thuyết phổ biến nhất là:

  • Các lập trình viên của các máy tính mainframe lớn ban đầu đi kèm với thẻ đục lỗ, sẽ để lại một chồng các hướng dẫn bằng giấy với chữ READ READ ME! được viết ở phía trước.
  • Cái tên này lấy cảm hứng từ Alice ở xứ sở thần tiên của Lewis Carroll, trong đó nhân vật chính Alice tìm thấy một lọ thuốc có nhãn là DRINK ME! và chiếc bánh có nhãn “EAT ME” khiến cô ấy thay đổi kích thước.

7 nguyên tắc viết README hiệu quả

7 nguyên tắc viết README hiệu quả trên Github
  1. Giữ nó đơn giản
  2. Sử dụng tiếng Anh đơn giản, thay vì thuật ngữ
  3. Đặt tên mô tả cho dự án
  4. Viết một đoạn văn ngắn để mô tả dự án: tại sao chúng tôi làm những gì chúng tôi làm và chúng tôi làm như thế nào
  5. Liệt kê các công nghệ liên quan: ngôn ngữ lập trình, framework và nhà cung cấp dịch vụ liên quan
  6. Viết hướng dẫn sử dụng cuối cùng. Nếu một cuốn sách hướng dẫn quá dài hoặc quá khó đọc, sẽ không ai đọc nó
  7. Cho nhà phát triển khác biết cách đóng góp cho dự án (nếu đó là một tùy chọn)

Cảm ơn bạn đã theo dõi bài viết!

Các bạn có thể tham khảo các bài viết hay về JavaScript tại đây.


Hãy tham gia nhóm Học lập trình để thảo luận thêm về các vấn đề cùng quan tâm.

TỔNG HỢP TÀI LIỆU HỌC LẬP TRÌNH CƠ BẢN CHO NGƯỜI MỚI BẮT ĐẦU

KHOÁ HỌC BOOTCAMP JAVA/PHP/.NET TRỞ THÀNH LẬP TRÌNH VIÊN TRONG 5-6 THÁNG

Leave a Reply

Your email address will not be published.