documentation

Our users have a 'help' link in their system that takes them directly to the publicly available system documentation. Special codes are part of the link. When users access the documentation page from their system, they get way more documentation than users that don't have the codes.

UNI documentation is all set up in the same format. Every article has been made into a video which is playable right from the documentation page. Text from the video is available in closed captioning in the video as well as below the video on the documentation page. This delivery method allows our users to learn at their own pace and in whatever there personal learning style is. Some people learn from watching, videos are great for this. Some people learn by having someone walk them through the steps, again videos work well for this area too. Some people just want the text, no problem. Being able to work at your own pace and being able to pause and replay sections of videos as much as you want makes these formats great for our users.

We've even taken the time and effort to add a 'test your knowledge' quiz for each section of the documentation. Now while you may have just had flashbacks of that one test or quiz back in high school where you freaked out, let us assure you that you don't need to freak out here. The quizzes were created because some people learn better by testing their knowledge. We don't keep track of points so you can guess as many times as you like. Smartphones generally don't support automatically playing music (hey, that's not our fault) but we decided to go ahead anyway and include some soft original quiz game show type music and sound effects for people who take the quiz on a laptop or desktop computer. The sound is off by default. You can turn on the sound to enhance your experience. Go ahead and try it. It'll be fun. Well, maybe not 'fun', because it is still a quiz. Try it, you might like it.

Now back to the documentation.

Articles generally have a description, helpful hints, and often have step by step instructions like this:

1. first thing to do
   • notes about this thing
2. next thing to do
3. select [this label]
4. last thing to do

There are special things in UNI. Labels have special meaning so you'll generally find label examples shown [like this]. You will also find other options like [submit] buttons shown in a similar format. Web page names (like control, many, one, and help) are also shown in bold. Step by step instructions are all formatted similarly as well. Whenever there is a link or a button, the text will show select. Whenever there is a text field, you will see enter plus sample text to enter as the [form field name]. Radio button options are shown as change [first option from the list] to [this other option].

Here's a short sample of a step by step instruction on how to search for an ID that contains '101':

1. select the one page
2. enter
   101
   as the [search for an ID]
3. select [submit]
   • if only one ID is found, it will be displayed
   • if more than one ID is found, you will get a list of matching IDs with links to view each ID

test your knowledge