Documentation - Vừa viết code vừa tạo doc - Bạn sẽ biết ơn chính mình trong tương lai Trong quá trình phát triển phần mềm, làm các tính năng lớn nhỏ Việc các logic thay đổi cũng sẽ khá thường xuyên, mà đôi khi vài feature đi theo 1 hướng riêng(có thể khác với suy nghĩ thông thường vì nó phục vụ riêng cho 1 vài nghiệp vụ được yêu cầu) Việc viết lại doc hoặc đơn giản nhất là những cái notes sẽ giúp người sau hoặc chính bản thân bạn có thể hiểu lại những logic phức tạp hoặc có thể trả lời tại sao ở dòng này owner lại chọn giải pháp này so với những giải pháp khác Tránh việc người đọc code phải suy nghĩ, tưởng tượng và đặt ra các giải thiết cho dòng code của chúng ta Một vài bước mà mình thấy nó hiệu quả trong quá trình làm việc 1. Note lại insight về feature hoặc method đang coding. Ví dụ tính năng thanh toán đơn hàng cho những users thuộc hạng VIP, ... 2. Đối với những dòng code hoặc method mà pattern/giải thuật lạ thì nên gửi link tài liệu đính kèm và thêm thông tin để giải thích tại sao chọn pattern/giải thuật này. Ví dụ cần apply 1 pattern để optimize vùng nhớ thì nên gửi kèm thêm tài liệu và insight của pattern đó 3. Với những giải thuật mà phức tạp thì nên kèm luôn sample data và result, chi tiết hơn là kèm luôn các steps từ data sang result như thế nào Đọc thêm: https://www.freecodecamp.org/news/how-to-write-good-documentation/

How to Write Good Documentation

freeCodeCamp.org

How to Write Good Documentation

18 tháng 6 năm 2022 pm 1:50

 • 

9 lượt lưu36 lượt xem

Bình luận 0