Bạn nên giữ một nhật ký dev

Bạn nên giữ một cuốn nhật ký dev

Nhật ký dev là nơi để xác định vấn đề bạn đang giải quyết và ghi lại những gì bạn đã cố gắng và những gì bạn đã thành công.

Viết lách là một công cụ tuyệt vời để xử lý và truyền đạt những ý tưởng trừu tượng. Và các dev luôn đắm mình trong những ý tưởng trừu tượng! Từ thiết kế hệ thống đến những chi tiết triển khai tinh vi nhất, chúng ta giữ một lượng thông tin khổng lồ trong đầu.

Ở cấp độ dự án, một đội ngũ nhỏ gồm các nhà quản lý dự án, quản lý sản phẩm, quản lý kỹ thuật và scrum master (đôi khi là cùng một người làm việc quá sức) giúp chúng ta xác định cái gì sẽ được xây dựng tiếp theo. Chúng ta quay lại các công cụ quản lý dự án như Jira để theo dõi tiến trình của mình. Nhưng ở cấp độ mã, rất dễ bị lạc lối.

May mắn thay, có một cách để giữ cho suy nghĩ của bạn được tổ chức xung quanh những chi tiết nhỏ nhặt: nhật ký dev. Một nhật ký dev là một công cụ để theo dõi những gì bạn đang làm và tại sao. Mặc dù điều này có thể cảm thấy như một công việc vặt ban đầu, việc giữ một nhật ký sẽ tiết kiệm cho bạn rất nhiều thời gian và ngăn chặn nhiều đau đầu khi bạn làm việc. Nó cũng có thể giúp bạn được thăng tiến.

Tại sao lại phải bận tâm?

Điều tôi cảm thấy khó chịu về sách tự giúp đỡ là khi chúng dành nhiều chương để bán cho bạn ý tưởng trước khi nói cho bạn biết phải làm gì. Vì vậy, đây là bản tóm tắt ngắn gọn về nhật ký dev: bạn sẽ code tốt hơn nếu bạn có thể tập trung 100% sự chú ý của mình vào việc giải quyết một vấn đề được xác định rõ ràng vào một thời điểm, và bạn sẽ phát triển như một dev bằng cách phản ánh về những gì đang hoạt động và những gì bạn đang gặp khó khăn.

Nhật ký dev là nơi để xác định vấn đề bạn đang giải quyết và ghi lại những gì bạn đã cố gắng và những gì đã hoạt động. Đó là tất cả. Phần còn lại của bài viết này sẽ cung cấp các kỹ thuật và chiến lược để đạt được điều đó.

Đây là những gì nhật ký của bạn sẽ giúp bạn làm:

Xác định những gì bạn đang làm
Trong khi tính năng sản phẩm mà bạn đang làm có thể được xác định rõ ràng, nhiệm vụ của bạn là tìm ra cách triển khai, và rất dễ bị lạc trong sự mơ hồ. Một số lập trình viên bắt đầu làm việc bằng cách viết một danh sách việc cần làm ngay trong trình soạn thảo văn bản của họ. Sử dụng nhật ký dev của bạn để phác thảo mọi thứ bạn cần hoàn thành nhiệm vụ của mình. Xác định một hành động cụ thể để thực hiện tiếp theo. Điều này sẽ rất hữu ích để tham khảo nếu bạn bị lạc sau này.
Giảm sự mơ hồ
Không sao cả nếu bạn cảm thấy không chắc chắn về những gì bạn nên làm tiếp theo hoặc làm thế nào để giải quyết vấn đề bạn đang làm. Đừng làm việc qua sự nhầm lẫn bằng cách viết một loạt mã, điều này có thể mất hàng giờ. Thay vào đó, dành năm phút để ghi lại những điều không chắc chắn của bạn và giả thuyết mà bạn có. Bạn chính xác không biết điều gì? Bạn sẽ tìm hiểu ra sao? Bạn nghĩ điều gì sẽ xảy ra? Như một người khôn ngoan đã từng nói, “Một vấn đề được xác định rõ ràng là một vấn đề đã giải quyết được một nửa.”
Học hỏi từ kinh nghiệm của bạn
Khi bạn hoàn thành một phần công việc - một vé, tính năng hoặc dự án - bạn có thể xem xét nó và học hỏi từ những gì khó khăn và những gì bạn đã làm tốt. Bạn cũng có thể chia sẻ những điều học được với đồng đội và quản lý của mình. Thay vì “nâng cấp” một cách mơ hồ, bạn có thể đọc chính xác những gì bạn đã làm và cách bạn tiếp cận nó.
Không bị phân tâm
Khi bạn bắt đầu làm việc trên nhiệm vụ kỹ thuật được xác định rõ ràng của mình, rất tự nhiên để bị phân tâm. Điều này còn trầm trọng hơn đối với các dev bị ADHD (chờ đã, đừng đọc bài báo đó ngay bây giờ). Bạn có thể bắt gặp một đoạn mã tồi và muốn tái cấu trúc nó, thấy mình đang làm việc trong một phần của mã mà bạn không dự đoán được, hoặc cần nghiên cứu một khái niệm kỹ thuật cơ bản. Chẳng mấy chốc, bạn sẽ rơi vào tình trạng chán nản buổi chiều và không chắc chắn bạn đã làm gì cả ngày.
Mặc dù đôi khi bạn có thể thực hiện một thay đổi nhỏ hoặc tra cứu thông tin khi bạn đi mà không làm gián đoạn trạng thái dòng chảy của mình, việc chuyển đổi ngữ cảnh liên tục khiến việc hoàn thành công việc sâu trở nên khó khăn. Đưa những suy nghĩ hoặc câu hỏi bạn đang có ra khỏi đầu bằng cách viết chúng vào nhật ký của bạn, sau đó giải quyết chúng vào một ngày sau.
Loại bỏ lo lắng khỏi đầu bạn
Bạn có thể sử dụng nhật ký dev để theo dõi cảm xúc của mình. Morning Pages là một kỹ thuật phổ biến để làm sạch "sự lộn xộn" trong đầu bạn vào đầu mỗi ngày. Bạn có thể thử phương pháp này với nhật ký dev của mình. Bạn đang lo lắng, hồi hộp, phấn khích? Ghi lại những cảm xúc này để bạn có thể làm sạch đầu óc và dành sự chú ý không chia rẽ của mình cho các vấn đề kỹ thuật.

Cách giữ một cuốn nhật ký dev

Tôi rất vui vì bạn vẫn ở đây. Bây giờ hy vọng bạn đang hứng thú để giữ một cuốn nhật ký dev, đây là cách tổ chức và sử dụng công cụ mới của bạn.

Thiết lập nhật ký của bạn
Chọn một nơi để viết
Bất kỳ trình soạn thảo văn bản phổ biến nào cũng đều ổn. Bạn thậm chí có thể sử dụng trình soạn thảo mã của mình và chỉ cần tạo một tệp văn bản hoặc markdown mới (chỉ cần nhớ .gitignore tệp này). Điều gì nhanh hơn là thay đổi tab?
Đừng rơi vào bẫy thiết lập một hệ thống trong nhiều giờ chỉ để bỏ nó khi bạn bắt đầu đi, như mua nhật ký đẹp nhất chỉ để nhận ra rằng bạn không muốn viết thường xuyên. Bạn có nơi nào có thể gõ nhanh không? Tốt. Bạn đã sẵn sàng!
Mặc dù bạn cũng có thể sử dụng một cuốn sổ tay vật lý, nhưng đó có lẽ không phải là ý tưởng tốt nhất. Bạn sẽ mất khả năng liên kết các thứ và dán các đoạn mã, điều này có thể hữu ích. Nó cũng có thể làm gián đoạn dòng chảy của bạn khi chuyển đổi giữa màn hình và sổ tay.
Hãy có tâm lý đúng đắn
Nhật ký dev của bạn là tài liệu riêng tư để bạn tổ chức và xử lý suy nghĩ của mình. Viết lách nên rõ ràng và dễ đọc đối với bạn, nhưng không cần phải là "viết tốt" theo tiêu chuẩn của người khác. Hướng đến "danh sách việc cần làm trên tủ lạnh" hơn là "bài luận tiếng Anh cấp ba."
Miễn là các ghi chú có ý nghĩa với bạn, bạn nên cảm thấy thoải mái khi viết nhanh. Đừng quá lo lắng về định dạng, tổ chức, hoặc cách diễn đạt. Bạn có thể thấy mình đính kèm các đoạn mã hoặc liên kết trong nhật ký của mình; có thể có lỗi chính tả, các ý tưởng khác nhau được định nghĩa lỏng lẻo. Miễn là bạn vẫn có thể điều hướng nó, điều đó là tốt! Những thứ này đang xảy ra trong đầu bạn, hãy đưa chúng lên giấy để bạn có thể suy nghĩ.
Tùy chỉnh khi bạn đi!
Để bắt đầu, hãy cân nhắc việc chia nhỏ việc viết của bạn theo ngày. Mỗi ngày, ghi lại mục tiêu của bạn (có thể chia nhỏ thành danh sách việc cần làm), và một bản tóm tắt ngắn. Chúng ta sẽ thảo luận cách giải quyết những điều này ngay sau đây.
Ngoài ra, không có quy tắc cứng nhắc nào cho việc tổ chức nhật ký. Bạn có thể có các phần cho ghi chú cho 1:1, những điều cần tra cứu sau này, tên hay cho doanh nghiệp gỗ tương lai của bạn, v.v.
Điểm chính ở đây là nhật ký của bạn là tùy chỉnh. Hãy chắc chắn kiểm tra lại xem nó có hoạt động cho bạn khi bạn đi!
Trước khi bạn bắt đầu code
Vào đầu mỗi phiên làm việc (điều này có thể là một ngày, một vé, hoặc một phiên pomodoro), xác định mục tiêu của bạn cho phiên làm việc, ngay cả khi bạn cảm thấy không chắc chắn về cách đạt được nó. Đừng lo lắng về việc nó trông như thế nào. Đây có thể là “tìm ra cách hoạt động của X” hoặc “hoàn thành refactor cho Y.” Giữ nó ngắn gọn. Bạn sẽ dành vài phút lập kế hoạch này, nhưng có một mục tiêu cụ thể sẽ cho bạn sự rõ ràng trong những giờ làm việc tiếp theo.
Hãy bắt đầu bằng cách viết ra những gì bạn đang làm và bất kỳ giả thuyết nào bạn có. Giống như “Tôi sẽ thêm một tính năng cho phép người dùng thêm danh sách phát Spotify từ bất kỳ trang web nào. Tôi nghĩ rằng tôi có thể sử dụng API chia sẻ trên web để thực hiện điều này.”
Ghi lại quá trình của bạn
Theo dõi những gì bạn đang làm, ý tưởng và những hiểu biết của bạn khi bạn đi. Đây không cần phải là mỗi vài phút. Điều này có thể trông giống như việc ghi lại các quyết định thiết kế, lý do bạn chọn một số công cụ nhất định hoặc các bước mà bạn thực hiện. Điều này đặc biệt hữu ích nếu bạn phải dừng lại hoặc nếu bạn gặp khó khăn, vì bạn có thể dễ dàng quay lại và xem những gì bạn đã thử và tại sao.
Kết thúc phiên làm việc của bạn
Cuối mỗi phiên làm việc, dành vài phút để viết lại những gì bạn đã làm và học được. Điều này có thể giúp bạn củng cố những hiểu biết của mình và tạo ra một dấu ấn để bạn có thể dễ dàng tiếp tục công việc sau này. Bạn có thể trả lời các câu hỏi như: Bạn đã hoàn thành những gì? Những thách thức chính là gì? Bạn đã học được điều gì? Điều này cũng giúp bạn phản ánh về những gì bạn cần làm tiếp theo.

Tóm tắt

Viết nhật ký dev có vẻ như là một thói quen không cần thiết và tốn thời gian, nhưng nếu bạn kiên trì, nó sẽ trở thành bản năng và sẽ tiết kiệm cho bạn rất nhiều thời gian. Tốt hơn nhiều để bối rối trong một tệp vào đầu dự án hơn là khi bạn đã viết nhiều mã trong nhiều tệp ở giữa dự án. Dành năm phút để lên kế hoạch cho ngày của bạn ngay bây giờ thay vì chạy vòng tròn sau này.

Một cuốn nhật ký dev tốt nên làm ba điều:

Thúc đẩy bạn suy nghĩ về ý tưởng của mình và lên kế hoạch mỗi ngày trước khi bắt đầu code.
Giúp bạn trở nên ý thức hơn về thành công và khó khăn của mình để bạn có thể nâng cao.
Giải tỏa tâm trí của bạn khỏi mọi thứ cản trở việc code.

Hãy thử giữ một cuốn nhật ký dev trong dự án hoặc sprint tiếp theo của bạn. Bạn có thể ngạc nhiên về việc bạn hiệu quả hơn bao nhiêu!