SlideShare a Scribd company logo
1 of 7
Download to read offline
ABC Homeowners/Mobile Homeowners Manual
The ABC Solution - Definition 1 - 1
Copyright 2001 5/13/08 Prepared by ACG Documentation
Chapter 1: General Information
The 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 Manual
Description of Keys - Navigational Tools 1 - 2
Copyright 2001 5/13/08 Prepared by ACG Documentation
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 HELP
Provides on-line help for the program
displayed.
CONFIRM
Displays the abbreviated description of any
data field codes entered on the screen
including any calculations.
LIST
Takes 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 MAIL
Supplies system messages regarding batch
programming tasks.
PAGE BACK
Returns the user to the previous page in a list
file.
PAGE FORWARD
Takes the user to the next page in a list file.
DELETE ITEM
Removes an entered item from a transaction.
LOCK TERMINAL
Enables a user to password lock a terminal as
a security measure.
MENU
Moves the user back one menu, usually to the
sub-menu for the program.
ABC Homeowners/Mobile Homeowners Manual
Description of Keys - User Hot Keys 1 - 3
Copyright 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:
Continued on next page
FUNCTION KEY ACTION
MAIN
Moves 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
SHIFT + F3 SHIFT + F8
SHIFT + F4 SHIFT + F9
SHIFT + F5 SHIFT + F10
SHIFT + F6 SHIFT + F11
ABC Homeowners/Mobile Homeowners Manual
Setting Up User Hot Keys - How to Set Up User Hot Keys 1 - 4
Copyright 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
Continued on next page
Step Field Description Action
1 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)
ABC Homeowners/Mobile Homeowners Manual
Setting Up User Hot Keys - How to Set Up User Hot Keys 1 - 5
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-2 System Manager Menu
Figure 1-3 - User File Menu
Continued on next page
6 SELECTION Type in the number 14.
7
Press the key.
Result: The User File Menu appears. (Figure 1-3)
ABC Homeowners/Mobile Homeowners Manual
Setting Up User Hot Keys - How to Set Up User Hot Keys 1 - 6
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.
10
Press 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.
12
Press the key.
Result: The user is returned to the User File Menu (Figure 1-3) and the hot keys
are now functional.
ABC Homeowners/Mobile Homeowners Manual
Description of System Help - Help Functions 1 - 7
Copyright 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 HELP
Provides 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
DESCRIPTION
Gives 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.

More Related Content

Similar to Technical Documentation Sample One

Ims200 surveillance system user manual
Ims200 surveillance system user manualIms200 surveillance system user manual
Ims200 surveillance system user manualdominik2003
 
AutoCount Accounting User Manual
AutoCount Accounting User ManualAutoCount Accounting User Manual
AutoCount Accounting User ManualAngela Shin
 
How to Import EML files into outloo.com.pdf
How to Import EML files into outloo.com.pdfHow to Import EML files into outloo.com.pdf
How to Import EML files into outloo.com.pdfNataliePortman5
 
X200 Pro User's Manual
X200 Pro User's ManualX200 Pro User's Manual
X200 Pro User's ManualTim Miller
 
Siemens s7 300-400-working with step 7 v5.1
Siemens s7 300-400-working with step 7 v5.1Siemens s7 300-400-working with step 7 v5.1
Siemens s7 300-400-working with step 7 v5.1Dien Ha The
 
Lsmw for master data upload simple explanation
Lsmw for master data upload simple explanationLsmw for master data upload simple explanation
Lsmw for master data upload simple explanationManoj Kumar
 
Table maintenance generator and its modifications
Table maintenance generator and its modificationsTable maintenance generator and its modifications
Table maintenance generator and its modificationsscribid.download
 
Ec tlistener
Ec tlistenerEc tlistener
Ec tlistenerferelrew
 
WECON Remote Access User Manual
WECON Remote Access User ManualWECON Remote Access User Manual
WECON Remote Access User ManualLily Zheng
 
Siemens s7 300-400-working with step 7 v5.0
Siemens s7 300-400-working with step 7 v5.0Siemens s7 300-400-working with step 7 v5.0
Siemens s7 300-400-working with step 7 v5.0Dien Ha The
 
ApplicationTestPlan[1]
ApplicationTestPlan[1]ApplicationTestPlan[1]
ApplicationTestPlan[1]Minu Mishra
 
Parts and functions of the LanTEK II certifier of the ideal brand
Parts and functions of the LanTEK II certifier of the ideal brandParts and functions of the LanTEK II certifier of the ideal brand
Parts and functions of the LanTEK II certifier of the ideal brandCandyChona
 
Tems investigation 16.0 user's manual
Tems investigation 16.0 user's manualTems investigation 16.0 user's manual
Tems investigation 16.0 user's manualPham Huu Thuan
 
Manual POPP-HUB-V2 (POP-011801)
Manual POPP-HUB-V2 (POP-011801)Manual POPP-HUB-V2 (POP-011801)
Manual POPP-HUB-V2 (POP-011801)Domotica daVinci
 
Change transport system in SAP
Change transport system in SAP Change transport system in SAP
Change transport system in SAP chinu141
 

Similar to Technical Documentation Sample One (20)

Ims200 surveillance system user manual
Ims200 surveillance system user manualIms200 surveillance system user manual
Ims200 surveillance system user manual
 
AutoCount Accounting User Manual
AutoCount Accounting User ManualAutoCount Accounting User Manual
AutoCount Accounting User Manual
 
How to Import EML files into outloo.com.pdf
How to Import EML files into outloo.com.pdfHow to Import EML files into outloo.com.pdf
How to Import EML files into outloo.com.pdf
 
Db2
Db2Db2
Db2
 
X200 Pro User's Manual
X200 Pro User's ManualX200 Pro User's Manual
X200 Pro User's Manual
 
Siemens s7 300-400-working with step 7 v5.1
Siemens s7 300-400-working with step 7 v5.1Siemens s7 300-400-working with step 7 v5.1
Siemens s7 300-400-working with step 7 v5.1
 
Lsmw for master data upload simple explanation
Lsmw for master data upload simple explanationLsmw for master data upload simple explanation
Lsmw for master data upload simple explanation
 
Table maintenance generator and its modifications
Table maintenance generator and its modificationsTable maintenance generator and its modifications
Table maintenance generator and its modifications
 
Ec tlistener
Ec tlistenerEc tlistener
Ec tlistener
 
Simens plc training. simatic working-with-step-7
Simens  plc  training. simatic working-with-step-7Simens  plc  training. simatic working-with-step-7
Simens plc training. simatic working-with-step-7
 
WECON Remote Access User Manual
WECON Remote Access User ManualWECON Remote Access User Manual
WECON Remote Access User Manual
 
P5
P5P5
P5
 
RF Framework_V2.pdf
RF Framework_V2.pdfRF Framework_V2.pdf
RF Framework_V2.pdf
 
Siemens s7 300-400-working with step 7 v5.0
Siemens s7 300-400-working with step 7 v5.0Siemens s7 300-400-working with step 7 v5.0
Siemens s7 300-400-working with step 7 v5.0
 
ApplicationTestPlan[1]
ApplicationTestPlan[1]ApplicationTestPlan[1]
ApplicationTestPlan[1]
 
Parts and functions of the LanTEK II certifier of the ideal brand
Parts and functions of the LanTEK II certifier of the ideal brandParts and functions of the LanTEK II certifier of the ideal brand
Parts and functions of the LanTEK II certifier of the ideal brand
 
Tems investigation 16.0 user's manual
Tems investigation 16.0 user's manualTems investigation 16.0 user's manual
Tems investigation 16.0 user's manual
 
Manual POPP-HUB-V2 (POP-011801)
Manual POPP-HUB-V2 (POP-011801)Manual POPP-HUB-V2 (POP-011801)
Manual POPP-HUB-V2 (POP-011801)
 
Change transport system in SAP
Change transport system in SAP Change transport system in SAP
Change transport system in SAP
 
DESIGN ACON
DESIGN ACONDESIGN ACON
DESIGN ACON
 

Technical Documentation Sample One

  • 1. ABC Homeowners/Mobile Homeowners Manual The ABC Solution - Definition 1 - 1 Copyright 2001 5/13/08 Prepared by ACG Documentation Chapter 1: General Information The 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.
  • 2. ABC Homeowners/Mobile Homeowners Manual Description of Keys - Navigational Tools 1 - 2 Copyright 2001 5/13/08 Prepared by ACG Documentation 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 HELP Provides on-line help for the program displayed. CONFIRM Displays the abbreviated description of any data field codes entered on the screen including any calculations. LIST Takes 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 MAIL Supplies system messages regarding batch programming tasks. PAGE BACK Returns the user to the previous page in a list file. PAGE FORWARD Takes the user to the next page in a list file. DELETE ITEM Removes an entered item from a transaction. LOCK TERMINAL Enables a user to password lock a terminal as a security measure. MENU Moves the user back one menu, usually to the sub-menu for the program.
  • 3. ABC Homeowners/Mobile Homeowners Manual Description of Keys - User Hot Keys 1 - 3 Copyright 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: Continued on next page FUNCTION KEY ACTION MAIN Moves 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 SHIFT + F3 SHIFT + F8 SHIFT + F4 SHIFT + F9 SHIFT + F5 SHIFT + F10 SHIFT + F6 SHIFT + F11
  • 4. ABC Homeowners/Mobile Homeowners Manual Setting Up User Hot Keys - How to Set Up User Hot Keys 1 - 4 Copyright 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 Continued on next page Step Field Description Action 1 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)
  • 5. ABC Homeowners/Mobile Homeowners Manual Setting Up User Hot Keys - How to Set Up User Hot Keys 1 - 5 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-2 System Manager Menu Figure 1-3 - User File Menu Continued on next page 6 SELECTION Type in the number 14. 7 Press the key. Result: The User File Menu appears. (Figure 1-3)
  • 6. ABC Homeowners/Mobile Homeowners Manual Setting Up User Hot Keys - How to Set Up User Hot Keys 1 - 6 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. 10 Press 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. 12 Press the key. Result: The user is returned to the User File Menu (Figure 1-3) and the hot keys are now functional.
  • 7. ABC Homeowners/Mobile Homeowners Manual Description of System Help - Help Functions 1 - 7 Copyright 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 HELP Provides 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 DESCRIPTION Gives 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.