Template - Screen Reference Page

Overview

8/3/20 - under construction Overview text describing the functions and main features of this screen.

Actions

Document each action button available on the screen. Many action buttons can be be documented with generic language, such as Save, Select, Edit, Print, etc. so they can be copied from screen to screen. Special action functions that only show up when a record is selected, or when a certain process is happening should be documented to state when they are active.

Add - Add a record

Edit - Edit a record

Void - Void a record

Setup

Document each setup item

Select Date - Choose which date to display in Day view, or select the starting date in other views, such as Weekly or Monthly.

Field Definitions

Document each fields on the screen. If a screen has multiple sections, or layout categories, use the tiered header sections like below to structure the field topics.

Customer Info (for example)

Field 1 - Definition

Field 2 - Definition

Grid Area (for example)

Field 1 - Definition

Field 2 - Definition

Attributes (if valid)

Attributes for this screen come from the Screen Attributes (SCREENATTRIB) Rule Maintenance screen. Ideally, this should be a link to the rule wiki page.

Any additional, helpful information about attributes can be added here in sentence form. But we don't need to document the actual attributes and functions here.

Special Features

Document any features/options that do not fall into the category of field definitions, setup box, or other pre-defined category.

Other

???