Creating lab manuals in ScreenSteps
This document covers the following topics:
Lab manuals have a simple hierarchy: A lab manual contains labs, and labs contain tasks that support the lab objective.
Tasks describe how to complete a procedure to accomplish a specific user goal. Tasks have a well-defined structure:
- A title and a short description, which describes the goal of the task
- A procedure, which is a set of direct user instructions in a numbered list
- Procedure steps (at least one step)
- Substeps (only one level of substeps)
See the Lab manual style guide for detailed style and formatting for steps, task headings, UI elements, user actions, and so on. Use the style guide as a reference as you write the lab manual.
Using ScreenSteps components to create a lab manual
| ScreenSteps component | Omnissa component |
|---|---|
| Category/Manual | Course |
| Chapter | Lab manual |
| Article | Individual lab with tasks |
You create the lab manual structure in the following way:
- On the End User Computing TOC page, select Create New > Manual.
- Enter the course title, for example, Omnissa Horizon: Administration and Operations
- Open the course (manual) page.
- Change the default chapter title to Lab manual - <Lab manual title>
- Open the lab manual (chapter).
- On the lab manual page, create articles for each lab in the manual.
Lab manual templates
When you create articles in a lab manual, use the following templates:
- Getting started with Omnissa labs: Standard introduction to the labs, including customizable sections
- Lab procedure template (<Lab #: Lab title>): Lab structure with brief instructions and examples
Lab introduction template
To create a lab introduction:
- On the lab manual (chapter) page, select Create New Article.
- In the Article template drop-down menu, select Getting started with Omnissa labs.
- In the Article title text box, enter
Getting started with Omnissa labsand select Create article. - Add information to the template, including, for example, start and end architectures, lab resources and credentials, scenario details if using, and other relevant information about the lab environment.
Lab procedure template
To create an individual lab within a lab manual:
- On the lab manual (chapter) page, select Create New Article.
- In the Article template drop-down menu, select <Lab #: Lab title>.
- In the Article title text box, enter the lab title and select Create article.
- Enter the lab details:
- Objective
- Task headings
- Task information: Heading, description, steps, and substeps.
Follow the guidelines in the Lab manual style guide when writing the steps and substeps.
Follow the recommended typographical conventions when writing labs:
- Boldface indicates selectable GUI control, including buttons, checkboxes, icons, list items, menus, sliders, and tabs.
Example: Select File > Save As.
Example: Select the Configuration tab.
- A code block with text in a monospace font indicates command names, command options, parameters, and so on that you enter in a command line.
Example:
1. Extract the files from the agent bundle.
tar -zxvf Omnissa-horizonagent-linux-x86_64-2503-8.15.0-14301895253.tar.gz Monospacefont indicates user entry text.
Example: In the Name text box, enter Employee Owned.
Using Info, Tip, Warning, and Alert settings
Info, Tip, Warning, and Alert text settings identify information that should be emphasized outside the main procedure or text. The type of setting that you use is determined by the purpose of the information and how critical the information is.
These guidelines apply when you use any of the text settings:
- Do not use these settings immediately after a heading.
- Do not overuse the settings.
- Avoid formatting step results and other step-related information, including to indicate the end of a lab, as Alert, Tip, Info, and Warning settings.
Info setting
Use the Info setting for additional information that you want to highlight but that doesn't fit into any of the other settings. You might use this setting for information that is not essential to all students, for example, when users of a particular operating system have special requirements.
Do not use the Info setting if the information is important to performing the step.
The service console must be installed on a VMFS datastore that is resident on a host’s local disk or on a SAN disk that is masked and zoned to that particular host only. The datastore cannot be shared between hosts.
Tip setting
Provide short cuts or other tips to help student complete the step.
When testing client policies, change only one setting at a time and retest the connection. This makes it easier to identify which policy caused a behavior change (for example, USB redirection, clipboard, or graphics settings).
Warning setting
Use the Warning setting to call out information that is important but not critical.
PuTTy must be closed when performing the next steps.
Alert setting
Use the alert setting to explain to the student that failure to perform or to avoid a certain action might cause unexpected results or result in the loss of data.
When you run this option, you lose all data that previously existed on the SCSI device that you specified in extension_device.
0 Comments
Add your comment