[Câu chuyện của nhà phát triển SI] 10. Tài liệu hóa trong dự án SI là gì?

Câu chuyện của nhà phát triển SI
#10. Tài liệu hóa trong dự án SI là gì?

Trong các dự án si, bạn cần phải nộp tài liệu cho khách hàng như một bằng chứng cho thấy dự án đã được thực hiện tốt.

Bắt đầu từ bản đề xuất, sau đó là tài liệu định nghĩa màn hình, tài liệu thiết kế, hướng dẫn sử dụng, v.v., tùy thuộc vào giai đoạn của dự án. Từ giai đoạn đề xuất dự án, thiết kế, phát triển, kiểm thử cho đến vận hành sau khi mở, có rất nhiều tài liệu cần phải được soạn thảo. Thông thường, các lập trình viên mới sẽ là người chịu trách nhiệm về việc này.

Khi viết tài liệu, đôi khi bạn sẽ tự hỏi liệu mình có phải đang làm lập trình viên hay nhân viên văn phòng không. Ngoài ra, ở Hàn Quốc, việc thực hiện tài liệu hóa cho từng giai đoạn thường bị dồn vào thời điểm ngay trước khi dự án kết thúc. Lý do là như sau:

• Thời gian dự án ngắn nên cần phải hoàn thành sản phẩm càng nhanh càng tốt, và tài liệu sẽ được tạo ra sao cho thật hợp lý để có thể hoàn thành dự án trong thời hạn quy định.
• Dù có tạo tài liệu cho từng giai đoạn thì yêu cầu cũng sẽ thay đổi và được bổ sung thêm. Vì vậy, thay vì tạo ra rồi lại sửa, thì việc tạo ra tất cả rồi mới điều chỉnh cho phù hợp sẽ nhanh hơn.

Thật trớ trêu, mặc dù thứ tự không đúng, nhưng đó là cách thức đã phát triển một cách tự nhiên trong văn hóa si của Hàn Quốc.

Có rất nhiều công cụ để tạo tài liệu định nghĩa màn hình, nhưng bạn cũng có thể bắt gặp cảnh tượng kỳ diệu khi mọi người chụp ảnh màn hình đang hoạt động và tạo tài liệu định nghĩa màn hình từ đó.

Thông thường, các lập trình viên sẽ rất ghét việc viết tài liệu, nhưng bạn là người mới thì biết làm sao được.

Những nhân viên mới sẽ là người được giao nhiệm vụ viết tài liệu. Dù sao thì cũng không thể giao ngay công việc phát triển cho họ, nên việc giao viết tài liệu là điều tất yếu.

Dù sao thì việc mình làm cũng sẽ được người kế nhiệm thực hiện sau này, vì vậy hãy cố gắng tạo ra những tài liệu thật tốt khi có cơ hội.