QRG: EDITING A UPK TOPIC

AUDIENCE: UPK Developers

PURPOSE: To provide guidance for editing a UPK topic.

Note: Yellow highlighting indicates additional lines to be inserted or text requiring changes.

UPK TEMPLATE TEXT WITH REQUIRED REPLACEMENT TEXT

UPK enters default bubble text for each action in a topic. The text does not always fully relate for the
end user and must be modified for better readability and execution. Below is a list of UPK template text
as well as the corresponding text to replace it with.

UPK TEMPLATE TEXT REPLACEMENT TEXT

Enter the desired information Enter the desired information into the Supplier field.
into the Supplier field. Enter a
Insert a blank line here.
valid value e.g. "American".
For example, enter "American".
[String Input/EditField]

Partial String input Enter a full or partial city name into the Search By field. Use ‘%’ as a wild
card.

Insert a blank line here.

For example, enter "Saint Petersb%".

String input Date (with a callout Enter the bonus plan's effective date into the Date field using the format,
note) MM/DD/YY.
Insert a blank line here.
For example, enter "10/24/16".

Note: Optionally, use the Calendar tool located to the right of the Date
field to enter a date.

Click the OK button. To confirm the updated information, click the OK button.

Click the Close button. To return to the People window, click the Close button.

Click the xxx field. To enter the employee's last name, click the Last Name field.

Click the Quick Select button. The system returns a list of values based on the search criteria entered.
To select a city, click the corresponding Quick Select button next to the
Saint Petersburg zip code, 33703.

Click the Quick Select button. The system returns a list of values based on the search criteria entered.
To select a city, click the corresponding Quick Select button next to the
Saint Petersburg zip code, 33703.

Click the Submit button. After confirming that the information is correct, click the Submit button.

1
QRG: EDITING A UPK TOPIC
UPK TEMPLATE TEXT REPLACEMENT TEXT
Click the Find button. To search for existing records matching the search criteria, click
the Find button.

Select the xxx list item. For example, select the AG230080 list item.
Note: Always use “select,” never use “highlight.”

Press DELETE. Press the DELETE key on the keyboard to delete the default location.

Press F11. To enter Query mode, press F11.

Press CTRL+F11. To execute the search, press CTRL+F11.

Click the scrollbar to see all of the Click the vertical scrollbar to proceed to the Xxxx section of the form (or
Xxxx section. page).
Click the horizontal scrollbar to display additional information (or options,
etc.).

To see the remainder of the page, click the vertical (or

horizontal) scrollbar.

Confirmation message A Confirmation window displays indicating that the transaction has been
applied and saved.
Insert a blank line here.

Click the OK button.

Note message A Note window is displayed indicating that the updates have been saved.

Insert a blank line here.

Click the OK button.

GRAMMATICAL USAGE
Below is a set of grammatical standards to use while editing a UPK topic.

EDITING ITEM SUGGESTED FORMAT OR GRAMMATICAL USAGE

Hyphen usage Hyphens should be inserted between two or more words that modify a
following noun. For example, “… off-campus activities” as opposed to “…
activities occurring off campus.”

Access the Process Goods Access the Process Goods Receipts and Make Adjustments as Warehouse
Receipts and Make Adjustments Agent simulation in Knowledge Center and click the Try It! button.
as Warehouse Agent Simulation
-- cautious use of capitalization; usually only proper nouns or names of
in Knowledge Center and click the
fields
Try It! button.

2
QRG: EDITING A UPK TOPIC
EDITING ITEM
Grammatical Tense
New window or new page
Section name within a window or
page
Template text vs. custom text
Entering text into a bubble
You, your, or you’re
“in” versus “on”
Report or Process names
Note:
SUGGESTED FORMAT OR GRAMMATICAL USAGE
Text should be present tense at all times, not future tense, if possible. Use
past tense or future tense only when absolutely required for clarity.
WRONG: “The xxx window displayed.” (past tense)
versus
RIGHT: “The xxx window displays.” (present tense)
WRONG: “… defaulted in the Xxxx field.” (past tense)
versus
RIGHT: “… defaults in the Xxxx field.” (present tense)
Include verbiage to indicate that the user is seeing a new page. The name
of a window or page is italicized and either “window” or ”page” follows
and is lowercase without formatting. For example: The Invoice Lines
window displays.
The section name is italicized. For example: In the Headers section of the
window, click in the XXXX field.
Use the defaulted template text as a baseline before customizing text.
Generally, template text should come after custom text.
When a user follows a job aid to perform a transaction, not all screenshots
are visible. Enter the text as if the user does not have access to the
screenshot(s). Refer to the exact window, page or field. This type of
structure helps when the user prints the Job Aid format of the topic.
It is acceptable and encouraged to use “you,” “your,” and “you’re” in
simulations, as simulations are considered interactive.
Click “in” the field. Click “on” the folder, link, etc.
When referring to a report name or a process name, put the report name
or process name in quotes, for example: To view the details of the
“Suppliers Monthly Activity” report, click the XXXX button.
When adding a callout Note to identify specific information, both bold and
italicize Note:. The first letter of the following text should be capitalized.
For example, "Note: When entering the data, …."
3
QRG: EDITING A UPK TOPIC
EDITING ITEM SUGGESTED FORMAT OR GRAMMATICAL USAGE
IMPORTANT When adding “Important” to call out specific information, two uses are
acceptable. The first is IMPORTANT: in all caps and bolded. The second is
when it is critical and IMPORTANT! must be in all caps, bolded, red, and
use an exclamation point instead of a colon.

• For example, “IMPORTANT: When entering the data, ....” Use this
style when it is important, but not critical.

• For example, “IMPORTANT! When entering the data, ….” Use this
style when it is absolutely critical that the user follow the instructions
exactly.

Start frame text This topic covers creating and associating an Asset Meter Template.

Note: Only use a list when three or more bullet points are needed.
This topic covers the following:

• Creating an Asset Meter Template

• Associating an Asset Meter Template, and
• Deleting an Asset Meter Template
End frame text This topic covered creating and associating an Asset Meter Template.

Note: Only use a list when three or more bullet points are needed.

This topic covered the following:

• Creating an Asset Meter Template

• Associating an Asset Meter Template, and
• Deleting an Asset Meter Template

FORMATTING EDITS
Below is a set of formatting standards to use while editing a UPK topic.

EDITING ITEM FORMATTING DIRECTION

Scrollbars and action areas The action area for a scrollbar must be resized to fit exactly around the
entire scrollbar. Keep the lines tight to the body of the scrollbar.

Bubble placement By default, UPK places text bubbles close to the action areas. However,
the initial placement often covers up information in key fields, pop-up text
bubbles, buttons, or icons.

Use the Pointer position button to move the bubble to the most
advantageous position that provides as much viewing space of the
remaining items in the screen capture.

4
QRG: EDITING A UPK TOPIC
BEFORE SUBMITTING A TOPIC FOR QA REVIEW
The two steps below must be completed before sending a topic to the AST Training Team for a quality
assurance review.

REVIEW ITEM FINAL CHECK BEFORE QA

Spellcheck IMPORTANT: Use Spell Check after editing a topic.

• To activate Spell Check:

o Click the Module (purple book) level of the course.
o Navigate to Tools > Spell Check.

Preview in Try It! mode IMPORTANT! Use the Preview option to execute the Try It! mode to
ensure that clicking on each item in the topic works properly, as well as
text entry works properly. This review is critical to the success of training.