Nhiều vấn đề kỹ thuật cuối cùng lại trở thành vấn đề về mặt con người, và việc thiếu thốn documents tốt trong công ty cũng không phải là trường hợp ngoại lệ. Đặc biệt là thói quen viết document cần được duy trì và nuôi dưỡng trong môi trường làm việc của các kỹ sư phần mềm. Bài viết sau đây đưa ra các case study của 3 công ty là Google, Twitter và Spotify trong việc xử lí các technical documents của họ và xây dựng văn hóa documentation trong công ty vốn dĩ là một điều khó khi mà đa phần các kỹ sư phần mềm hay tập trung vào coding hơn là documentation.
Những bài học được đưa ra có thể tóm gọn thành 3 nguyên tắc chính:
- Giảm tối đa sự phiền toái và “ma sát” khi viết document. Một sự thật hiển nhiên là các kỹ sư luôn né tránh việc bảo trì document. Việc context-switching khi đang code mà chuyển sang một hệ thống riêng biệt mà không được sử dụng công cụ hiện tại khiến document sẽ ít được viết hơn. Ở ví dụ này, cả ba công ty đều áp dụng các phương pháp tiếp cận docs-as-code vì nó giúp cập nhật tài liệu cho các kĩ sư một cách dễ dàng và xuyên suốt hơn.
- Tiêu chuẩn hóa và đầu tư vào công cụ viết document. Cả 3 công ty đều đầu tư rất nhiều về công cụ, đảm bảo một nơi thống nhất và duy nhất cho document, để các kĩ sư không phải hỏi rằng “Document ở đâu?”. Google là g3docs, Twitter là DocBird, Spotify là TechDocs.
- Truyền bá văn hóa document thông qua đào tạo và dẫn dắt với ví dụ. Dạy các lập trình viên cách viết document, cung cấp các ví dụ và template để sử dụng, tổ chức các ngày hackathon dành riêng cho viết document và hợp tác với kỹ sư có tầm ảnh hưởng để khuyến khích và truyền bá.
Bài viết có đưa ra nhiều số liệu và ví dụ cụ thể, mời bạn tham khảo thêm.