Table of Contents s396

User Guide Template

Version X Table of Contents

1 Introduction...... 1 1.1 Style Conventions...... 1 2 Installation/Setup...... 2 2.1 Configuration...... 2 3 Key Topic #1...... 3 4 Key Topic #2...... 4 5 Key Topic #3...... 5 6 Troubleshooting...... 6 6.1 Common Issue #1...... 6 6.2 Common Issue #2...... 6 6.3 Common Issue #3...... 6 7 More Topics...... 7 [User Guide Title] [Missouri S&T/Project Name]

1 Introduction

The introductory section should briefly summarize what the reader can expect to learn from the document. Individual guides should have a well-defined purpose and audience. If the document becomes lengthy, consider splitting the document into multiple focused guides.

Use bulleted lists instead of lengthy blocks of text when appropriate, such as a list of things the reader will learn. Lists are much easier to scan than paragraphs:

 Point #1  Point #2  Point #3  Point #4

1.1 Style Conventions Here you should establish the conventions that will be used throughout the guide. For example, you may wish to give sample notes and warnings (as shown below).

Note: To make a cautionary note, type the note and apply the “Note” style from the styles menu.

Warning: To make a warning, type the note and apply the “Warning” style from the styles menu.

[User Guide Title] [Missouri S&T/Project Name]

2 Installation/Setup

If your product is a piece of software that users can install on their machines, be sure to include thorough instructions for each particular operating system you support. The idea is get the user up and running as quickly as possible. Screenshots are especially helpful at this stage.

2.1 Configuration Ideally, the user will not have to perform a great deal of configuration to get up and running. However, the necessary configuration steps should be outlined before continuing on to the first major topic.

If you need to include source code samples, simple select the Code style from the style menu:

def say_hello_world puts “Hello World!” end

3 Key Topic #1

Once users have set up your product, you should introduce how to accomplish the first major task. For example, if your product is a project management system, you may wish to explain how to create the first project and give a high-level overview of the different things users may accomplish with projects.

4 Key Topic #2

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

5 Key Topic #3

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

6 Troubleshooting

This section of the guide should highlight common issues users may encounter and offer simple solutions.

6.1 Common Issue #1 Describe the issue clearly and offer solutions in steps. Bulleted lists and screenshots work great here.

 Step #1  Step #2  Step #3

7 More Topics

Here you may link to additional guides that cover specific topics not addressed in this user guide.