Skip to Knowledge Base content

Quick Start Guide Example

A quick start guide article guides the user through a brief set of instructions about how to do something quickly. Quick start guides should have relatively few steps and take about 15 minutes or less. The title should have "Quick Start" in the title. Example: "Quick Start Guide to Underwater Basket Weaving". To ensure user trust, comfort and familiarity with our self help solutions, use this formatting and section order when writing a quick start article for the OIT knowledgebase.

Who is This Article Being Written For?

The very first thing that should be considered when writing articles for the OIT Knowledge Base is: Who is going to read this article? Knowing who this article is for will help you determine the "voice" that you write the article in. Knowing the article's target audience will also inform you about what information to include or exclude. Some articles we write for the knowledgebase are for internal information sharing within OIT, other articles will be for our customers. Knowing who you are writing for will help you make critical decisions about what you write, how you write it, what you can assume your readers know, and what they don't.

When to Use Which Headings and How (this is "heading 2")

"Heading 2" uses a horizontal line after the text to create a logical break between paragraphs - which is very good for visual organization. When you have topics that all relate to one another very directly, but all fall under the same heading - use "Heading 3" as the sub-heading title. Examples appear below in this article. When typing headings, use camel case (ex. "This Title is Written in Camel Case, also Known as Title Case"). The only exception to this rule is when writing a FAQ. When using Heading 3 for FAQ questions, use proper, or sentence case (ex. "This is proper case, also known as sentence case").

Introduction (use "Heading 2")

This section should be one to three paragraphs describing the product and what this article is designed to help the user do. Remember that we always want to write articles in a customer friendly voice, using vocabulary that the user will readily understand.

Estimated Time to Complete (use "Heading 3")

How long should a user expect to spend following this guide? Consider that if it takes you 3 minutes to do something, a user will likely take longer. A quick start guide is just that: A QUICK start guide. Any series of steps that takes a user longer than 15 minutes is probably not appropriate for a quick start guide and a doing a longer “how-to” article would be more appropriate.

Vocabulary (use "Heading 3")

If there is any special vocabulary that users absolutely must learn to be successful, list those words here. This should be very rarely used. If you aren’t going to use this special vocabulary, don’t add the section to your article.

Steps (use "Heading 2")

Numbered lists should be used for anything that has steps that are dependent on the previous steps for completion or to show prioritization of or levels of importance. Bulleted lists are used for information that is non-prioritized, but still falls under the same logic.

  1. Steps should be numbered and written in order to help the user understand what is happening and what is happening next. And what is expected of them
    1. Sub-steps should also be in order and either numbered or lettered
    2. So the users can understand what they are doing
    3. If you need to use sub steps in a quick start guide, you may need to consider a how to instead. The subject may be too complex for a quickstart.
  2. Steps should be numbered and written in order to help the user understand what is happening and what is happening next. And what is expected of them
  3. Steps should be numbered and written in order to help the user understand what is happening and what is happening next. And what is expected of them
  4. Steps should be numbered and written in order to help the user understand what is happening and what is happening next. And what is expected of them
  • This is an example of related thoughts that have no priority
  • Bullet lists should be used sparingly in a quick start guide because other more robust article on the topic can be referred to.
  • Sub-bullets can help organize further
    • If you need another level of bullets beyond sub-bullets, reconsider your article's organization
  • Bullets are inappropriate for a series of steps that a user needs to follow in order.

Conclusion (use "Heading 2")

Remind the user what they just did, and how the results of this process should have helped them.

Additional Resources (use "Heading 2")

If appropriate, add this section to the article to explain how to get additional help or where other resources may be found for this topic if needed. If other articles cover this elsewhere in the knowledgebase, consider adding article links at the top of this page to allow users quick access to them. You can also attach related helpful documents if necessary. These can be printable PDF's of the article you have written here for those types of articles that require a user to be offline while working.

Was this helpful?
0 reviews

Details

Article ID: 32405
Created
Thu 6/22/17 11:34 AM
Modified
Wed 11/1/17 2:09 PM

Files (1)

docx

Quick Start.docx

6/22/2017 3:44:47 PM