Add a paragraph or two that introduces the concepts that will be covered in this guide.

This is the introductory paragraph. It should provide a brief description of the content of the guide.

This guide covers the following topics:

Terminology

The content that displays in this section is pulled from an Excerpt in a KS module Glossary of Terms. These terms pages live in the module's Design Documents and Specifications node in the wiki. Reset the Excerpt as necessary for your module.

How-To Steps

These sections are the heart of the guide. You should be detailing the processes that our functional end-users will need to understand to set up and use the software. These sections should be less about grabbing screens and detailing the screen features, and more about detailing a process or set of steps a user will need to perform and then using screens to highlight and further explain how it's done.

The following sections provide information and steps for  finish the sentence with the specific functions or processes that you are covering in this guide. These should loosely mirror the Heading 3's in this section.

Process (such as Create a Course From Catalog)

Add sentences that introduce and describe the process. If necessary, add any prerequisites or assumptions.

<Add introduction>

Screen Caption/Title (Using Subscript)

Screen Caption/Title (Using Subscript)

  

If the information is not procedural, use paragraphs and lists like the one below.

<add information about the screen or feature, which might introduce a list like the one below>
 

If the information is procedural, use a series of steps like the one below. Use bold font to emphasize buttons, fields, drop-downs, and other UI elements that the user will interact with.

  1. Add some
  2. Set of steps that walk
  3. The user through a
  4. Process illustrated in the
  5. Screens, such as
  6. Do this.
  7. Then do that.
    After that, something else will happen.
  8. Then do the other thing.

Return to top...

Another Process (such as Create a Course by Copy)

Add sentences that introduce and describe the process. If necessary, add any prerequisites or assumptions.

<Add introduction>

Screen Caption/Title (Using Subscript)

Screen Caption/Title (Using Subscript)

  

If the information is not procedural, use paragraphs and lists like the one below.

<add information about the screen or feature, which might introduce a list like the one below>
 

If the information is procedural, use a series of steps like the one below. Use bold font to emphasize buttons, fields, drop-downs, and other UI elements that the user will interact with.

  1. Add some
  2. Set of steps that walk
  3. The user through a
  4. Process illustrated in the
  5. Screens, such as
  6. Do this.
  7. Then do that.
    After that, something else will happen.
  8. Then do the other thing.

Return to top...

Reference Documentation

You will add two types of references here: references to other guides that will be published for public consumption at release time, and links to internal resources that people will find valuable during feature development. The links in the Internal Resources list will be removed when the guide is prepped for a public release.  Add links below as necessary.

Internal Resources