Technical Documentation Sample One

Chapter 1: General InformationThe ABC Solution

Definition The ABC Solution is an integrated mainframe-based application which:

• satisfies all business processing requirements on-line and in real-time.• enables insurance personnel to update and retrieve information quickly

and efficiently.

Benefits The ABC Solution provides users with the following advantages:

• supports all forms of billing, e.g., accounts, payroll deductions, etc.• maintains a complete record of all clients associated with the company.• enables users to tailor the system to meet their specific business

needs.• uses the most current industry standard technology.• insures maximum flexibility, reliability, and expandability.• contains extensive help functions to assist the user in navigating

through the system.• supplies a secure infrastructure to prevent unauthorized access and

data entry.

ABC Homeowners/Mobile Homeowners ManualThe ABC Solution - Definition 1 - 1Copyright 2001 5/13/08 Prepared by ACG Documentation

ABC Homeowners/Mobile Homeowners Manual

Description of Keys

Navigational Tools The ABC Solution uses various standard functions and features for efficient movement throughout the system. It must be noted, however, that not all functions are available for use on every screen. Available functions are displayed on the command line at the bottom of each screen.

Function Keys The following table lists and defines the function keys used in the ABC system:

Continued on next page

FUNCTION KEY ACTION

SCREEN HELPProvides on-line help for the program displayed.

CONFIRM Displays the abbreviated description of any data field codes entered on the screen including any calculations.

LISTTakes the user back to a list or menu, dependent upon where they were prior to the current function.

DISPLAY ALL MESSAGES

Displays all error messages at once rather than individually.

SUSPEND/UNSUSPEND

Allows the user to interrupt the transaction in progress, work on another transaction, and then return to the original transaction without losing captured data.

SYSTEM MAILSupplies system messages regarding batch programming tasks.

PAGE BACKReturns the user to the previous page in a list file.

PAGE FORWARDTakes the user to the next page in a list file.

DELETE ITEMRemoves an entered item from a transaction.

LOCK TERMINALEnables a user to password lock a terminal as a security measure.

MENUMoves the user back one menu, usually to the sub-menu for the program.

Description of Keys - Navigational Tools 1 - 2Copyright 2001 5/13/08 Prepared by ACG Documentation


Description of Keys, cont.

Function Keys, (cont.)

User Hot Keys The ABC Solution also allows users to create personalized hot keys which allow the user to navigate directly to the screens they most commonly use. The following chart displays the function keys that can be programmed by the user:


FUNCTION KEY ACTION

MAINMoves the user back two menus, usually to the main menu for the program.

QUIT (SHIFT + F1)

Ends the transaction, but marks it as incomplete.

ABORT (SHIFT + F12)

Abandons a transaction and deletes all records from the system.

PROGRAMMABLE FUNCTION KEYS

SHIFT + F2 SHIFT + F7





Description of Keys - User Hot Keys 1 - 3Copyright 2001 5/13/08 Prepared by ACG Documentation


Setting Up User Hot Keys

How to Set Up User Hot Keys

Follow the steps below to set up user hot keys within the ABC system:

Figure 1-1 Main Selection Menu


Step Field Description Action1 Determine the screens to be

linked to the hot keys.2 Write down the alphanumeric

code found in brackets beside each screen name, e.g., Y000 for the Client Menu (the first and third characters of the screen name are not used).

3 Go to the MAIN SELECTION MENU. (Figure 1-1)

4 SELECTION Type in the number 6.5

Press the key.

Result: The System Manager Menu appears. (Figure 1-2)

Setting Up User Hot Keys - How to Set Up User Hot Keys 1 - 4Copyright 2001 5/13/08 Prepared by ACG Documentation

ABC Homeowners/Mobile Homeowners ManualSetting Up User Hot Keys - How to Set Up User Hot Keys 1 - 5

Setting Up User Hot Keys, cont.

How to Set Up User Hot Keys, (cont.)

Figure 1-2 System Manager Menu

Figure 1-3 - User File Menu


6 SELECTION Type in the number 14.7

Press the key.

Result: The User File Menu appears. (Figure 1-3)

Copyright 2001 5/13/08 Prepared by ACG Documentation


Setting Up User Hot Keys, cont.

How to Set Up User Hot Keys, (cont.)

Figure 1-4 - Amend User PF Keys Screen

8 SELECTION Type in the number 5.9 USER ID Type in the five digit employee

ID number preceded by a P, e.g., p00007.

10Press the key.

Result: The Amend User PF Keys screen appears. (Figure 1-4)

11 USER OPTION Type an alphanumeric screen code in each of the 10 USER OPTION fields.

12Press the key.

Result: The user is returned to the User File Menu (Figure 1-3) and the hot keys are now functional.

Setting Up User Hot Keys - How to Set Up User Hot Keys 1 - 6Copyright 2001 5/13/08 Prepared by ACG Documentation


Description of System Help

Help Functions The ABC Solution has numerous help features available for users. The table below lists and describes these features:

TYPE OF HELP FUNCTION DESCRIPTION

SCREEN SCREEN HELPProvides general help regarding the screen the user is currently on.

Press to exit.FIELD Type ? and then press

the key.Displays a standard help screen showing the information relevant to that field.

FIELD SELECT LINE NUMBER

Allows quick transfer of requested information to the appropriate screen field by entry of:• line code and

• key.FIELD SELECT

DESCRIPTIONGives the opportunity to enter key words to narrow the search.

FIELD KEY in pg ___ of 05 pgs

Allows quick navigation through help screens by entering the page number.

Description of System Help - Help Functions 1 - 7Copyright 2001 5/13/08 Prepared by ACG Documentation

Documents

Technical Documentation Sample One