Tại sao README là điểm bắt đầu của một sản phẩm tốt

Hãy thử viết README trước khi viết dòng code đầu tiên. Bạn sẽ ngạc nhiên vì số câu hỏi thiết kế lộ ra chỉ sau mười phút.

Một README tối thiểu cần gì?

1. Một câu mô tả dự án giải quyết vấn đề gì.
2. Cách cài đặt và chạy trong dưới năm lệnh.
3. Cách chạy test.
4. Nơi hỏi khi gặp vấn đề.

git clone https://github.com/ten-ban/du-an.git
cd du-an
npm install
npm run dev

README là bài kiểm tra sự đơn giản

Nếu phần cài đặt cần hai trang giải thích, vấn đề không nằm ở tài liệu mà ở chính quy trình. README tốt thường kéo theo script tự động hóa tốt.

Kiểm tra bằng người mới

Cách kiểm tra rẻ nhất: nhờ một người chưa từng thấy dự án làm theo README. Mỗi lần họ phải hỏi bạn là một dòng cần sửa.