Program documentation là gì?

Bất kỳ văn bản, hình ảnh minh họa hoặc video nào mô tả một phần mềm hoặc chương trình cho người dùng của nó được gọi là tài liệu chương trình (program documentation) hoặc tài liệu phần mềm (software documentation) Người dùng có thể là bất kỳ ai từ lập trình viên (programmer), nhà phân tích hệ thống (system analyst) và quản trị viên (administrator) đến người dùng cuối (end user). Ở các giai đoạn phát triển khác nhau nhiều tài liệu (document) có thể được tạo cho những người dùng khác nhau. Trên thực tế tài liệu phần mềm (software documentation) là một quy trình quan trọng trong quy trình phát triển phần mềm tổng thể (software development process).

Trong tài liệu lập trình mô-đun thậm chí còn trở nên quan trọng hơn vì các mô-đun khác nhau của phần mềm được phát triển bởi các nhóm khác nhau. Nếu bất kỳ ai khác ngoài nhóm phát triển muốn hoặc cần hiểu một mô-đun, tài liệu tốt và chi tiết sẽ làm cho nhiệm vụ dễ dàng hơn.

Một số ưu điểm của việc cung cấp tài liệu chương trình (program documentation) như: (1) theo dõi tất cả các phần của một phần mềm hoặc chương trình (2) bảo trì dễ dàng hơn (3) các lập trình viên không phải là nhà phát triển có thể hiểu tất cả các khía cạnh của phần mềm (4) cải thiện chất lượng tổng thể của phần mềm (5) hỗ trợ đào tạo người dùng.

Có nhiều loại tài liệu lập trình (program documentation) như: hướng dẫn sử dụng (user manual), tài liệu kỹ thuật (technical documentation), tài liệu kiểm thử (testing document), tài liệu thiết kế (design document),...