Sản xuất và bảo trì tài liệu hệ thống là một sự hỗ trợ đáng kể cho kỹ nghệ bảo trì. Tài liệu hệ thống bao gồm tất cả các tài liệu mô tả sự thực hiện của hệ thống, từ những đặc tả yêu cầu rồi
Thay đổi yêu
Sửa chữa mã nguồn
Phân phối sửa chữa hệ thống
Cập nhật yêu cầu Phân tích
thay đổi phần mềm Phát triển Phân tích
mã nguồn
Thay đổi yêu cầu
cuối cùng là chấp nhận kế hoạch kiểm tra. Tài liệu có thể đ−ợc sinh ra để hỗ trợ tiến trình bảo trì bao gồm:
• Tài liệu yêu cầu và một lý do kết hợp.
• Một tài liệu mô tả các cấu trúc hệ thống.
• Đối với mỗi ch−ơng trình trong hệ thống, một bản mô tả kiến trúc là một ch−ơng trình.
• Mỗi thành phần có một đặc tả và một mô tả thiết kế riêng.
• Danh sách các ch−ơng trình mã nguồn cần đ−ợc chú thích. Nếu các tên có ý nghĩa đ−ợc sử dụng sẽ tránh đ−ợc những vấn đề còn mơ hồ. Nhiều mã ch−ơng ttrình có thể lập tài liệu mà không cần có những bình luận mang tính chú thích. Các ch−ơng trình chú giải chỉ cần giải thích những phần mã phức tạp và cung cấp các mối quan hệ giữa các ph−ơng thức mã hoá đ−ợc sử dụng.
• Tài liệu kiểm chứng mô tả mỗi ch−ơng trình đ−ợc kiểm chứng nh− thế nào, thông tin có quan hệ với yêu cầu đ−ợc kiểm chứng.
• Một h−ớng dẫn bảo trì hệ thống mô tả các vấn đề hiểu biết về hệ thống và mô tả những thành phần của hệ thống phụ thuộc vào phần cứng và phần mềm. Bản h−ớng dẫn cũng giải thích sự tiến triển của hệ thống nh− thế nào để thích hợp cho việc tính toán. Trong thiết kế tài liệu hệ thống cũng cần có tính cấu trúc và việc h−ớng dẫn tổng quát ng−ời đọc một cách quy củ và mô tả chi tiết hơn các khía cạnh của hệ thống. Một điều rất quan trọng là tài liệu phải rõ ràng và dễ đọc. Trong đó các chuẩn trình bày cần không mâu thuẫn với manul ng−ời sử dụng.