Làm thế nào để viết được một file README tốt?

Làm thế nào để viết được một file README tốt?

Threads
  • Hôm trước mình thấy repository này dùng TauriSvelte để viết lại ứng dụng kiểu như là Task Manager trên Window hay Monitor trên Mac á. Tò mò tải về xem thử thì bất ngờ thứ nhất là dung lượng rất nhỏ, chỉ vài MB. Tiếp theo là tốc độ khởi động cũng rất nhanh mà ứng dụng cũng rất mượt nữa chứ 🫣

    Abdenasser/neohtop

    » Xem thêm
  • Tuôi" để ý là cứ đợt nào ham đọc cái là lại lười viết, tuần nay tuôi đang đọc một lúc 3 cuốn, à phải là đọc 2 và nghe 1.

    Cuốn sách ám ảnh nhất đến thời điểm hiện tại: Đại dương đen - thuật lại 12 câu chuyện của 12 người mắc bệnh trầm cảm. Thần kinh vững, nhưng mới đọc 2 câu truyện đầu thôi mà cảm giác ngộp thở, bứt rứt thật khó tả 😰

    Câu chuyện tiếp theo đó thì mang lại cảm giác dễ thở hơn vì họ kiểm soát được bản thân. Nhưng sang tiếp câu chuyện thứ 4, thứ 5 thì lại như một có một bàn tay siết họng mình lại. Không thể nhắm mắt mà nghe được á, có gì đó rất đáng sợ.

    Một câu mà mình cảm thấy ám ảnh nhất là khi ba mẹ của người mắc trầm cảm luôn miệng hỏi tại sao con lại như thế mỗi khi sắp lên cơn và gào thét. Họ chỉ đành bất lực trả lời là "Làm sao mà con biết! Cũng giống như hỏi một người bị ốm là tại sao lại ốm? Làm sao mà biết được chứ! Có ai muốn đâu!".

    » Xem thêm
  • Mistral.ai là một công ty AI có trụ sở tại Pháp, được biết đến với nhiều mô hình ngôn ngữ lớn Mistral. Mới đây họ vừa ra mắt thêm một số mô hình có kích thước siêu lớn, siêu mạnh... Nhưng tạm khoan nói đến vì Mistral Chat cũng vừa được ra mắt với nhiều tính năng hay ho tương tự như Chat GPT mà lại miễn phí 😇

    » Xem thêm

Vấn đề

README là một trong những tệp quan trọng nhất của bất kỳ dự án lập trình nào. Đó là một tệp văn bản thường được viết bằng Markdown giới thiệu về dự án và giải thích nội dung của dự án. Nó giúp mọi người hiểu cách cài đặt và sử dụng mã bạn đã viết, cũng như cách mọi người có thể phát triển dự án cùng với bạn.

Tại sao nên viết README?

Trở lại năm 2010, Tom Preston-Werner đã ủng hộ phát triển dự án theo hướng viết README của bạn trước, trước khi bạn làm bất cứ điều gì khác. Anh ấy nói rằng, mặc dù đã có các phương pháp lập trình và các cách vận hành dự án như TDD và SCRUM, nhưng sẽ tốt hơn nếu như những người khác hiểu được ngay dự án của bạn thông qua mô tả có ở trong README.

Viết README là điều cần thiết để có thể tạo ra một ứng dụng tốt. Nó sẽ định hình giúp bạn những việc cần làm sau này trong dự án.

Như Preston-Werner nói sẽ dễ dàng hơn nhiều để bắt tay vào viết README khi bắt đầu dự án của bạn, đó là thời điểm bạn có động lực nhất. Khi bạn kết thúc dự án của mình, viết README sẽ giống như một nhiệm vụ khác, một công việc nhỏ khác. Điều đó sẽ làm giảm sự hứng thú của bạn khi viết nó.

Nhưng bằng cách nào đi chăng nữa, bạn vẫn cần một tệp README truyền tải đầy đủ nội dung, bởi vì rất ít người sẽ rà soát mã của bạn để hiểu nó hoạt động như thế nào. Nó tốn thời gian và họ có thể không có chuyên môn kỹ thuật để hiểu nó.

Ngoài ra, không chỉ có các developer mới quan tâm đến README của bạn. Các nhà tuyển dụng cũng vậy, họ sẽ xem README tìm hiểu khả năng của bạn. README một lần nữa thể hiện sự chuyên nghiệp của bạn.

Ngay cả khi bạn đang làm dự án cá nhân thì README vẫn quan trọng. Hãy tưởng tượng sau một thời gian bạn quay lại để tiếp tục dự án. Với một README tốt bạn sẽ biết ngay dự án đó đang làm gì và giúp bạn có thể bắt tay vào làm ngay lập tức.

Viết README như thế nào?

Viết một tệp README cần có bố cục rõ ràng và mạch lạc, điều đó đôi khi còn phụ thuộc vào khả năng và tính thẩm mỹ của mỗi người.

Dưới đây là một số điều cần thiết khi bạn viết README của mình:

  • Title (Tiêu đề)
  • Introduction (Giới thiệu - nó nói về cái gì và tại sao bạn viết nó)
  • Install (Cài đặt thế nào?)
  • Use (Cách sử dụng)
  • Technologies Used (Công nghệ được sử dụng - thư viện, phiên bản...)
  • Acknowledgments (Sự nhìn nhận - là nơi bạn viết ra những lời cảm ơn, những bài viết hay bất kì điều gì ở một nơi khác truyền cảm hứng hoặc giúp bạn hoàn thành dự án này)

Đó là những điều cần thiết tối thiểu để giúp ích cho bạn và những người khác. Ngoài những mục trên bạn có thể thêm những mục mà bạn cảm thấy là cần thiết cho dự án. Ví dụ như:

  • Table of contents - ToC (Mục lục - hữu ích nếu README của bạn dài)
  • List of features - LoF (Danh sách các tính năng)
  • Examples (Ví dụ về việc sử dụng - Mã hoặc hình ảnh)

Ví dụ về README hữu ích

Dưới dây là một số dự án trên github mà có tệp README được trình bày rất tốt:

Ngoài ra, còn có một số công cụ giúp bạn trình bày được README một cách có hệ thống. Một trong số đó là readme.so. Đây là một công cụ hỗ trợ tạo một tệp README với đầy đủ các đầu mục, bạn có thể trải nghiệm trực tiếp trên trang web, hoặc tham khảo những đầu mục mà công cụ cung cấp để tự tạo tệp thủ công.

readme.so

README là một tệp cần thiết cho các dự án lập trình của bạn, ngay cả khi nó chỉ dành cho dự án của chính bạn. Bạn nghĩ sao về những điều ở bên trên hay có điều gì khác mà bạn nghĩ là cần thiết cho một README không? Hãy để lại bình luận nhé!

Bài viết được dịch ở x-team và được chỉnh sửa lại để phù hợp cho bạn đọc.

hoặc
* Bản tin tổng hợp được gửi mỗi 1-2 tuần, huỷ bất cứ lúc nào.
Author

Xin chào, tôi tên là Hoài - một anh Dev kể chuyện bằng cách viết ✍️ và làm sản phẩm 🚀. Với nhiều năm kinh nghiệm lập trình, tôi đã đóng góp một phần công sức cho nhiều sản phẩm mang lại giá trị cho người dùng tại nơi đang làm việc, cũng như cho chính bản thân. Sở thích của tôi là đọc, viết, nghiên cứu... Tôi tạo ra trang Blog này với sứ mệnh mang đến những bài viết chất lượng cho độc giả của 2coffee.dev.Hãy theo dõi tôi qua các kênh LinkedIn, Facebook, Instagram, Telegram.

Bạn thấy bài viết này có ích?
Không

Bình luận (2)

Nội dung bình luận...
Avatar
Trịnh Cường2 năm trước
cảm ơn bạn, bài viết như lồng đèn sáng chói vậy
Trả lời
Avatar
Xuân Hoài Tống2 năm trước
Cảm ơn bạn Cường
Avatar
Đức Tống2 năm trước
Bài viết rất hữu ích ạ
Trả lời