Tài liệu Chương trình
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à program or software document. Người dùng có thể là bất kỳ ai từ lập trình viên, nhà phân tích hệ thống và quản trị viên đến người dùng cuối. Ở các giai đoạn phát triển khác nhau, nhiều tài liệu có thể được tạo cho những người dùng khác nhau. Trong thực tế,software documentation là một quá trình quan trọng trong quá trình phát triển phần mềm tổng thể.
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.
Đây là một số hướng dẫn để tạo tài liệu -
Tài liệu phải từ quan điểm của người đọc
Tài liệu phải rõ ràng
Không nên lặp lại
Các tiêu chuẩn công nghiệp nên được sử dụng
Tài liệu phải luôn được cập nhật
Bất kỳ tài liệu lỗi thời nào nên được loại bỏ sau khi ghi lại quá trình loại bỏ
Ưu điểm của Tài liệu
Đây là một số lợi thế của việc cung cấp tài liệu chương trình -
Theo dõi tất cả các phần của một phần mềm hoặc chương trình
Bảo trì dễ dàng hơn
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
Cải thiện chất lượng tổng thể của phần mềm
Hỗ trợ đào tạo người dùng
Đảm bảo không tập trung hóa kiến thức, cắt giảm chi phí và nỗ lực nếu mọi người rời khỏi hệ thống đột ngột
Tài liệu Ví dụ
Một phần mềm có thể có nhiều loại tài liệu liên kết với nó. Một số điều quan trọng bao gồm:
User manual - Nó mô tả các hướng dẫn và thủ tục để người dùng cuối sử dụng các tính năng khác nhau của phần mềm.
Operational manual - Nó liệt kê và mô tả tất cả các hoạt động đang được thực hiện và sự phụ thuộc lẫn nhau của chúng.
Design Document- Nó giới thiệu tổng quan về phần mềm và mô tả chi tiết các yếu tố thiết kế. Nó ghi chi tiết nhưdata flow diagrams, entity relationship diagrams, Vân vân.
Requirements Document- Nó có một danh sách tất cả các yêu cầu của hệ thống cũng như phân tích khả năng tồn tại của các yêu cầu. Nó có thể có các trường hợp người dùng, các tình huống thực tế, v.v.
Technical Documentation - Nó là tài liệu về các thành phần lập trình thực tế như thuật toán, sơ đồ, mã chương trình, mô-đun chức năng, v.v.
Testing Document - Nó ghi lại kế hoạch kiểm thử, các trường hợp kiểm thử, kế hoạch xác nhận, kế hoạch xác minh, kết quả kiểm tra, v.v. Kiểm thử là một giai đoạn phát triển phần mềm cần tài liệu chuyên sâu.
List of Known Bugs- Mọi phần mềm đều có lỗi hoặc lỗi không thể loại bỏ được vì chúng được phát hiện rất muộn hoặc vô hại hoặc sẽ tốn nhiều công sức và thời gian hơn mức cần thiết để sửa chữa. Những lỗi này được liệt kê cùng với tài liệu chương trình để chúng có thể được gỡ bỏ vào một ngày sau đó. Ngoài ra, họ cũng giúp người dùng, người triển khai và người bảo trì nếu lỗi được kích hoạt.