Example

External Program Documentation (Object Approach)

Table of Contents

1. Manual Entry

NAME

WardApp - Ward Management System

SYNOPSIS

[java] /usr/local/pub/BITOOP/tutorials/WardEgMk3/WardApp

DESCRIPTION

WardApp is a program for the managment of a database of patient information for a Hospital Ward. When it runs the user is presented with a graphical interface which allow the user to choose options from three separate menus on the menu bar:

• File menu - contains options which allow the user to open a file, save a database or quit from the application. The Open and Save options if selected, cause a file dialog box to be displayed, allowing the user to select (Open option) or name (Save option) a file for action.
• Patient menu - menu options allow the user to add a new patient, remove a patient from the database and amend some details associated with the patient. Each of these items when chosen use a dialog box to obtain further information.
• Report Menu - menu options for displaying a complete text listing of the patients currently in the data base, in alphabetical order and bed number order.

FILES

patient.dat - text file (See Section 3.1, External Data Structures for line format)

LIMITATIONS (Special Hardware or Software Requirements)

Assumes the program is run interactively

Requires the Java Virtual Machine to be installed for execution

Assumes a bitmapped display monitor

WARNINGS

WardApp is a management system for an individual ward of a hospital or nursing home only, i.e. it does not provide for multiple wards.

DIAGNOSTICS

"No database file found - program starting with no data!" - when the program first starts it automatically looks for a default file called patient.dat. If the file is not present, the program continues after displaying the foregoing message. The user can then elect to open a file from the file menu or add patient data to create a new database.

"Save File?" - when the user attempts to exit the program without saving the current database, the program displays this message in an dialog box which gives the user the option of

...

...

BUGS

none apparent

2. Test Plan

Method

The program will be tested in terms of:

• its graphical interface,
  • user written window features (eg close box)
  • user written menu, menu option,
  • user written buttons and
  • user written dialog boxes, etc
• input data
  • normal cases (valid)
  • extremes (limits or range testing)
  • exceptions (unusual but valid)
  • invalid data; does program still produce a meaningful result (graceful degradation) ?
• output not covered in above
• internal Data Structure design
• any remaining major logic paths

Results

For actual result output, see:

http://ironbark.bendigo.latrobe.edu.au/~mary/WardApp/testPlan.html

3. Data & Data Type Abstractions

3.1 External Data Structures

Identifier     patient.dat
Description    stores the database of patient information
Line format:  comma separated details used for the creation of a object of the patient class
 (see class description in section 3.2)

3.2 Classes

see:
http://redgum.bendigo.latrobe.edu.au/~mary/WardApp/doc

Appendix A

(Java Source code for user written classes which comprise the application )

Appendix B

(Bulky data I/O files )