2. QUY TRèNH XÂY DỰNG MỘT PHẦN MỀM
2.4.1 Tài liệu chương trỡnh
Tài liệu bờn trong của chương trỡnh gốc bắt đầu với việc chọn lựa cỏc tờn gọi định danh (biến và nhón), tiếp tục với vị trớ và thành phần của việc chỳ thớch, và kết luận với cỏch tổ chức trực quan của chương trỡnh. Việc lựa chọn cỏc tờn gọi định danh cú nghĩa là điều chủ chốt cho việc hiểu chương trỡnh. Những ngụn ngữ giới hạn độ dài tờn biến hay nhón làm cỏc tờn mang nghĩa mơ hồ. Cho dự một chương trỡnh nhỏ thỡ một tờn cú ý nghĩa làm “ đơn giản hoỏ việc chuyển đổi từ cỳ phỏp chương trỡnh sang cấu trỳc ngữ nghĩa bờn trong”. Một điều rừ ràng là: phần mềm phải chứa tài liệu bờn trong. Lời chỳ thớch cung cấp cho người phỏt triển một ý nghĩa truyền thụng với cỏc độc giả khỏc về chương trỡnh gốc. Lời chỳ thớch cú thể cung cấp một hướng dẫn rừ rệt để hiểu trong bước cuối cựng của kỹ nghệ phần mềm - bảo trỡ, nhất là những phần mềm quản lý như quản lý cổ đụng, cổ tức cần được nõng cấp bảo trỡ thường xuyờn để đỏp ứng sự thay đổi của thực tế. Cú nhiều hướng dẫn đó được đề nghị cho việc viết lời chỳ thớch. Cỏc chỳ thớch mở đầu và chỳ thớch chức năng là hai phạm trự đũi hỏi cỏch tiếp cận cú hơi khỏc.
Lời chỳ thớch mở đầu nờn xuất hiện ở ngay đầu của mọi module. Định dạng cho lời chỳ thớch như thế là:
1. Một phỏt biểu về mục đớch chỉ rừ chức năng module. 2. Mụ tả giao diện bao gồm:
Một mẫu cỏch gọi Mụ tả về dữ liệu
Danh sỏch tất cả cỏc module thuộc cấp.
3. Thảo luận về dữ liệu thớch hợp (như cỏc biến quan trọng và những hạn chế, giới hạn về cỏch dựng chỳng) và cỏc thụng tin quan trọng khỏc.
4. Lịch sử phỏt triển module bao gồm: - Tờn người thiết kế module (tỏc giả)
- Tờn người xột duyệt và ngày thỏng. - Ngày thỏng sửa đổi và mụ tả sửa đổi.
Cỏc chỳ thớch chức năng được nhỳng vào bờn trong thõn của chương trỡnh gốc và được dựng để mụ tả cho cỏc khối chương trỡnh.