Tản mạn Documentation

"Chời má ơi, chúa tể document là Thiện rồi đó!", một anh đồng nghiệp thốt lên khi thấy mình liên tục gửi cho anh các tài liệu cho các chủ đề mỗi khi anh hỏi tới.

"Chời má ơi, chúa tể document là Thiện rồi đó!". Một anh đồng nghiệp thốt lên như vậy khi thấy mình liên tục gửi các tài liệu chi tiết cho từng chủ đề mỗi khi anh hỏi đến. Mình cười xỉu khi đọc câu đó, không dám nhận cũng không dám phủ nhận..

Personal thought

Documentation = Di sản để lại cho người đến sau

Documentation là cách để mình “làm Product một cách có trách nhiệm”. Có giai đoạn điểm “chạy” feature nhiều và nhanh chóng mặt, mình gần như là người giữ kiến thức chính. Nếu không viết lại ngay những gì đang biết, thì team Ops, team Dev, cả chính mình đều dễ bị "tẩu hỏa nhập ma".

Trong khả năng, mình cố gắng ghi tất cả đầy đủ lại cho team (ví dụ: API, rule xử lý lỗi, process flow, luồng giao tiếp, thông số giữa các hệ thống..). Không phải vì mình rảnh, mà vì mình biết 2 tuần sau mình có thể sẽ… quên. Trí nhớ là thứ dễ phản bội → Bớt tin nó, vì mình đã gặp rồi:

• Một quyết định quan trọng đã được chốt từ lâu, nhưng không được note lý do kỹ. Sau đó team debate lại y như chưa từng thảo luận.

• Không tìm được latest logic trong doc tính năng.→ Dev đã nghỉ, dev mới phải lôi code ra mò lại.

• Một câu hỏi bị hỏi lại… lần thứ 7, vì không ai nhớ là đã có câu trả lời rồi (nhưng ở đâu thì không rõ).

• Phụ thuộc quá nhiều vào trí nhớ của một cá nhân nào đó đặc biệt trong các môi trường nhịp độ cao, nhiều dự án và thông tin thay đổi liên tục. Nếu người đó mà off thì coi như thông tin bị gián đoạn. Công việc bị kẹt.

Càng đi làm, càng thấy rõ:

Dù bạn làm ngành gì Tài chính, marketing, vận hành, thiết kế, giáo dục, logistics... thì "documentation" cũng là một phần không thể thiếu. Bởi vì rồi sẽ đến lúc các tài liệu chi tiết và đầy đủ sẽ giúp bạn:

• Muốn dễ bàn giao lại công việc cho người mới join vào team. Tăng tốc độ onboarding & scale team.

• Muốn đồng đội hiểu đúng và đủ một quy trình bạn đang làm. Giúp các team của bên bạn lẫn đối tác hoạt động một cách hiệu quả, bớt “anh/chị/em tưởng”, “anh/chị/em nhầm”

• Khi kiến thức được ghi lại rõ ràng và dễ tìm, team và sếp của bạn vẫn có thể vận hành ổn định, không cần nhắn tin hỏi liên tục khi bạn đang vắng mặt.

• Tự cứu chính mình, ghi lại những gì bạn từng mày mò ra

• Muốn chia sẻ một kiến thức với người khác mà không cần phải nhắc đi nhắc lại 1 thứ 10 lần (Bạn sẽ chán). Nhưng bạn có thể viết 1 lần, để 10 người khác hiểu.

Lời kết

Dù bạn làm trong ngành nào, viết một cái SOP, một hướng dẫn ngắn, một bản checklist, hay thậm chí chỉ là note lại 3 dòng sau một cuộc họp tất cả đều đáng giá. Project chạy dồn dập, người này nghỉ, người kia chuyển team, thì thứ duy nhất ở lại là… tài liệu → trao lại ngọn đuốc cho team ra quyết định, làm việc hiệu quả, và… không cãi nhau lung tung vì không nhớ ai nói gì, khi nào.

P/s: Viết blog cũng là một cách mình document lại dành riêng cho bản thân khi trí nhớ không còn là “đồng minh” trong tương lai.

Thông tin thêm

Khi viết tài liệu, mình tự hỏi:

• Người đọc là ai? Họ cần biết điều gì từ đây.

• Mục đích của tài liệu là gì? Đọc để hiểu? Đọc để làm? Đọc để ra quyết định? Nếu họ gặp vấn đề, biết liên hệ ai?

• Nếu mình vắng mặt, người khác có thể dựa vào tài liệu này để tiếp tục công việc không?

• Tài liệu có dễ đọc không

  • Có tiêu đề cụ thể, rõ ràng, đúng trọng tâm?

  • Có link tới tài liệu liên quan không?

  • Có ghi rõ thời điểm cập nhật, người cập nhật?

• Tài liệu có dễ tìm không? Đặt ở đâu, Folder, cấu trúc file thế nào.

• Tài liệu này có thể tái sử dụng / cập nhật được không? Hay phải làm lại từ đầu mỗi lần?

---

Nếu những chia sẻ này mang đến cho bạn giá trị và bạn muốn đồng hành để mình có thể phát triển bền vững hơn, bạn có thể cân nhắc ủng hộ mình theo một trong những cách dưới đây 👇

🎁 Chuyển khoản ngân hàng:

• Vietcombank - 1041611760 - NGUYEN DUC THIEN

• Techcombank - 19036068036017 - NGUYEN DUC THIEN.

📖 Buy me a book: https://buymeacoffee.com/imthiennguyen

🙏 Mỗi sự ủng hộ, dù nhỏ, đều là động lực để mình tiếp tục viết, đọc, và chia sẻ nhiều điều hữu ích hơn đến cộng đồng. Cảm ơn bạn đã đồng hành cùng mình!