documentation

The narrative and traphical description of a system. Documentation for an information system includes:

Operating Procedures

1. Instructions for turning the system on and getting the programs initiated (loaded).

2. Instructions for obtaining source documents for data entry.

3. Instructions for entering data at the terminal, which includes a picture of each screen layout.

4. A description of error messages that can occur and the alternative methods for handling them.

5. A description of the defaults taken in the programs and the instructions for changing them.

6. Instructions for distributing the computer’s output and sample pages for each type of report.

System Documentation

1. Data dictionary Description of the files and databases.

2. System flow chart Description of the data as it flows from source document to report.

3. Application program documentation Description of the inputs, processing and outputs for each data entry, query, update and report program in the system.

Technical Documentation

1. File structures and access methods.

2. Program flow charts.

3. Program source code listings.

4. Machine procedures (JCL).

documentation
Phần mô tả đồ họa và tường thuật của một hệ thống. Tài liệu của hệ thống thông tin bao gồm:

Các thủ tục điều hành

1. Các lệnh chỉ dẫn mở hệ thống và yêu cầu các chương trình được khởi tạo (được tải).

2. Các lệnh chỉ dẫn để đạt các tài liệu nguồn sử dụng cho mục nhập dữ liệu.

3. Các lệnh chỉ dẫn nhập dữ liệu tại thiết bị đầu cuối vốn bao gồm một hình ảnh của mỗi cách trình bày màn hình.

4. Phần mô tả các thông báo lỗi vốn có thể xảy ra và các phương pháp thay thế để xử lý chúng.

5. Phần mô tả các cài đặt mặc định được áp dụng trong các chương trình và các lệnh chỉ dẫn để thay đổi chúng.

6. Các lệnh chỉ dan phân phối các lệnh xuất của máy tính và các trang mau cho mỗi kiểu report.

Tài liệu hệ thống

1. Từ điển dữ liệu Phần mô tả các file và các cơ sở dữ liệu.

2. Lưu đồ của hệ thống phần mô tả dữ liệu lúc nó di chuyển từ tài liệu nguồn sang report.

3. Tài liệu chương trình ứng dụng Phần mô tả dữ liệu nhập, tiến trình xử lý vá các kết quả xuất của moi mục nhập dữ liệu, query, chương trình báo cáo và cập nhật trong hệ thống.

Tài liệu kỹ thuật

1. Các phương pháp truy cập và các cấu trúc file.

2. Các lưu đồ của chương trình.

3. Các danh sách mã nguồn của chương trình.

4. Các thủ lục của máy (JCL).


Published:

PAGE TOP ↑