Documentation là gì?

Documentation bao gồm các mô tả và quy trình bằng văn bản về một chương trình và cách sử dụng nó. Nó không phải được thực hiện chỉ ở cuối quá trình lập trình. Documentation của chương trình được thực hiện xuyên suốt tất cả các bước lập trình. Trong bước này, tất cả các documentation trước đó được xem xét, hoàn thiện và phân phối. Documentation rất quan trọng đối với những người có thể liên quan vào chương trình trong tương lai. Những người này có thể bao gồm:

• Người dùng (user): người dùng cần biết cách sử dụng phần mềm. Một số tổ chức có thể cung cấp các khóa đào tạo để hướng dẫn người dùng thông qua chương trình. Tuy nhiên, các tổ chức khác có thể mong đợi người dùng có thể tìm hiểu một package từ documentation đã viết. Hai ví dụ về loại documentation này là sách hướng dẫn (manual) được in và tùy chọn trợ giúp (help option) trong hầu hết các ứng dụng
• Operator: documentation phải được cung cấp cho người vận hành máy tính (computer operator). Ví dụ: nếu chương trình gửi cho họ thông báo lỗi, họ cần biết phải làm gì với chúng.
• Lập trình viên (programmer): khi thời gian trôi qua, ngay cả người tạo ra chương trình gốc cũng có thể không nhớ nhiều về nó. Các lập trình viên khác muốn cập nhật và sửa đổi nó - nghĩa là thực hiện bảo trì chương trình - có thể cảm thấy thất vọng khi không có documentation đầy đủ. Loại documentation này nên bao gồm văn bản và lưu đồ của chương trình (program flowchart), danh sách chương trình và đầu ra mẫu (sample output). Nó cũng có thể bao gồm các lưu đồ của hệ thống (system flowchart) để cho biết chương trình cụ thể liên quan như thế nào với các chương trình khác trong hệ thống thông tin (information system).

Ví dụ như documentation của framework Laravel cho biết cách sử dụng framework Laravel.