How to write a Setup Guide


About Us	Free Tools	Tips	Templates	Affiliates	Site Map

Want to know how to write a Setup Guide? Get a pen, grab a coffee, and listen to this...

Getting Started

The first few pages of most Setup Guide templates include boiler-plate legal text, such as Trademarks and Software License Agreements. These should be the standard text as approved by your legal team. Don’t get ‘creative’ and try to make this up. Consult with the legal people or escalate to the Product Manager.

Download Now for $7.99 - Buy Here!

Once this is out of the way, you can get down to writing the actual Setup Guide.

This is one of the standard documents found in most ‘technical document packages’.

What is a Technical Document package?

This is the collection of technical documents that accompanies the product. Most software releases come with a (minimal) set of documents, such as the User Guide, Reference Guide, Release Notes and System Administration Guide depending on the nature of the beast.

The Setup Guide (also called an Installation Guide) accompanies products that must be setup/installed by the user.

While the level of detail will vary, the following topics are usually covered.

Introduction
About My Product
Key Benefits of My Product
System Requirements
Unplugging My Product
Installing My Product
Starting My Product
Activating My Product
Saving and Loading Configurations
Uninstalling My Product
Backing Up My Product
Frequently Asked Questions

About Your Product

Next, describe the product.

Again, try to remember that your customers may not be familiar with this product —which is why they are reading this document —and are looking for some information that places it in context.

Also remember that many people may be stressed out when ready this document, so don’t add to this frustration by adding superfluous information or adopting a superior tone.

Talk to the reader as though they were across the table — and you sincerely wanted to help him/her setup this product.

Ok, here’s an example of how you can introduce the product.

To make My Product readily available to individuals that need it, we have introduced My Product 2.0 which lets you send information over the internet securely.

You can setup and run My Product whenever and wherever you need to (with administrative privileges), without having to purchase additional licensing or activate each installation of the software.

This makes My Product both convenient and inexpensive for both individuals and organizations, and faster to deploy in network environments.

Once My Product has been installed on a system, it will automatically start up each time you log in – activated and ready to use.

Highlight the Benefits

With the product described in nice, short sentences, let’s move on and highlight some of its benefits.

Key Benefits

My Product provides these important key benefits:

Web Access - With My Product you can plug in and run My Product on any system without having to purchase additional licensing.

Portable - My Product’s mobile device fits in your pocket or around your neck, so it’s always with you when you need it.

Ease of use - Just plug it in and it automatically starts up.

License Management - As the serial number is tied to My Product, there are no license activations to worry about.

System Requirements

Following this, you need to describe the minimum system requirements.

These may include the amount of memory that’s required, a processor, or for non-technical products, for example, if you were setting up a cabinet, you might tell the reader that they will need a hammer, nails, saw and other such tools.

Sample text.

The system requirements for using My Product are as follows.

450 MHz Pentium® III processor or equivalent
Windows Vista, XP or 2000 operating system
Internet Explorer 7.0 or later
Minimum 256 MB RAM (2 GB for Windows Vista)
Minimum 25 MB disk space
Sound card
Web connection

Unplugging my product

Once you have described the product and the system requirements, i.e. the academic side of things, you can then move onto more technical details, such as how to install, remove, upgrade the product.

The level of detail here will vary on what you need to cover. Make sure to consult the Product Manager before writing these sections.

Get them to approve the table of contents before you start. Otherwise you may end up writing material that is not required or (worse) overlooking something that users are screaming for.

Sample Warning text.

It is important that the My Product is not unplugged while the system is downloading information, as this will corrupt important files needed to install and run My Product.

Setting Up the product

Next, describe how to setup the product.

Describe to the reader what they will accomplish by following these steps and flag any pre-requisites or warning that need to be flagged here.

But I've already told them?

I know.

But remember: they have not ready your document from the start; they may have skipped the introduction and went straight to the installation steps.

Do I need to put the Warning here?

Yes, if you feel that they may overlook the intro and/or the warnings are so significant that it is best to repeat it, rather than risk them hurting themselves or the product.

Sample text.

My Product is easy to install on your computer. My Product includes a setup program with large-print dialog boxes that guide you through the installation.

Note: The My Product setup program will install system-level components, which requires administrator privileges. If you do not have these privileges, contact your System Administrator before starting the installation.

To install:

1. Close virus-protection software and all other programs.

2. Make sure you are connected to the internet.

The Setup program starts automatically.

3. Follow the instructions to complete the installation.

If Setup does not start automatically

4. In the Windows Start menu, select Run.

5. Browse to the correct CD drive, for example, E.

6. Select the AutoStart program and click Open.

7. Click OK.

For complete information on the setup options, refer to the User Guide.

Starting my product

How to start the product.

After the person has installed the product successfully, the next step is to show them how to start it — usually quite obvious, but we need to cover all options — and also allow for products that can be started in different ways.

For example, some products can be started from the command line, with keyboard shortcuts, from the icon bar and also from external devices. Think of how you start your car.

You can use your keys but you can also use the remote control and now use mobile devices to get it started.

Sample text.

Once My Product is installed on your system, the program will start automatically each time you log-in. If you are already logged in to the system, you can also start it using one of the following procedures:

On the Windows desktop, select the My Product program icon.

In the Windows Start menu, choose Programs, My Product, My Product.

Activating my product

How to activate the product.

This does not apply to all applications but needs to be considered for items that require activation, for example, entering a serial number of a special code.

This can be a little complicated it there are multiple installs or if the reader is upgrading the product and already has the serial number from the older version.

Sample text.

Single-user versions of My Product include five activations.

This allows you to activate My Product on the computers you use the most.

For complete information on the My Product activation process, refer to the User Guide.

Add special notes that help the reader navigate this (potentially) tricky area. Many complaints to tech support relate to customers wrestling with serial numbers.

Sample text.

Note: While the software may be activated on up to five computers, use of the collective installations is restricted to one user at any given time. Simultaneous use by more than one person violates this license agreement.

Saving Configurations

Write this section if the application offers the reader the option to select different settings or to configure the product during setup.

For example, when I install Microsoft Office, I'm have the option to select the standard installation or to cherry pick the options that suit me best.

While this is usually self-explanatory, explain to the reader the benefits, or additional functionality, they will gain if they choose these options.

Tip — write this text in positive terms. Don’t intimidate or bully the reader into installing all the options. Explain the relative merit of each option.

Sample text.

When you start My Product using the My Product drive the configuration settings are loaded and saved to configuration files stored on your PC. This feature insures that your saved settings are always with you as you move from one computer to another. For complete information on saving and restoring your configuration settings, refer to the User Guide.

Uninstalling my product

While this section may seem self-explanatory, highlight to the reader any steps they need to take before they uninstall the application, for example, files they should backup or other items that need to be considered.

Another scenario is when the application may be part of a larger solution. In this event, warn them that they may impact the other (dependent) applicant.

Again, choose your words carefully. Your aim is not to frighten the reader into uninstalling the application; rather to flag items that they may have over-looked.

Tip — avoid blaming the user; guide them through the process as you would a friend learning to use it for the first time.

Sample text.

If you no longer need My Product on your system, you can uninstall it at any time. Uninstalling My Product erases all its program files and returns your system to the state it was in before installing.

To uninstall:

1. In the Windows Start menu, choose Programs, My Product, and then Uninstall My Product.

The My Product Uninstall program starts.

2. Follow the on-screen instructions.

For complete information on the uninstall process, refer to the My Product User Guide.

FAQs

Now that you have described how to install, modify, and un-install the application, well, what’s left?

Most products are not perfect.

For this reason, you can do the reader a huge favor by listing the typical problems they are likely to encounter.

Speak to the Helpdesk or Tech Support Dept and ask them what 10 frequently asked questions are they asked the most.
Write down the answers and check that these are correct.

Then answer them.

Sample text.

Where can I find my serial number?

After installing My Product, your product serial number will appear in the Program Info dialog box. To view this dialog box, in My Product’s menu bar, choose Help, About and then select the Program Info tab.

How many machines can I install it on?

The Software may be activated on five systems; use of the collective installations is restricted to one user at any given time.

Can I use my My Product as a storage device?

Yes. Your My Product drive contains approximately 400MB of free space that can be used to store your personal files.

Are the files on my My Product drive protected?

No. As with all writable storage devices, the files contained on the My Product drive may be overwritten – accidentally or intentionally.

Download Now for $7.99 - Buy Here!

If you want to create a Setup Guide in a few easy steps, then this template will tell you how to do it. This template includes sample instructions on how to setup an application, product or system, including sections on registering the software, adding troubleshooting tips and providing FAQs.

This Setup Guide step is described in detail and is accompanied by practical tips and hints.

Click here to download this 29 page template instantly.

You can use this Setup Guide template to:

Describe different installation types, for example, single user or group installations
Identify the minimum system requirements
Highlight pre-requisites that must be installed before the installation can start
Outline the contents of the Setup packages
Provide instructions on how to update, modify and repair an existing application
Develop FAQs that help customers find the answer to common queries and reduce the workload on your Technical Support Dept
Encourage users to register the product

What is a Setup Guide?

A Setup Guide provides instructions for setting up and installing a range of application, for example, your company’s software applications, or other devices, such as printers, medical equipment, hardware, or mobile solutions.

When do I use a Setup Guide?

You use a Setup Guide after you have developed an application and are now ready to hand it over to the users. In some cases, the setup guide will be used by System Administrators, for example, when setting up network, complex solutions or other detailed installations, while in other cases, it will be the end user who sets up the product, for example, setting up a Microsoft Office type application, a video player, Wifi connection, or an MP3 player.

What's included in a Setup Guide?

The following is generally included in a Setup Guide: About the product, Key Benefits, System Requirements, Installing, Starting Up, Activating, Uninstalling, Backing Up, Registering and Frequently Asked Questions.

Sample Screenshots

Chapter 1, Introduction

Chapter 1.3, System Requirements

Chapter 2, Single-User Installation

How to select different options

How to Install from a CD on the Windows Platform

Table of Contents

1 Introduction

1.1 Solution Overview
1.2 Installation Types
1.3 System Requirements
1.4 Contents Of The Download Setup Packages
1.5 Contents Of The Installation CD
1.6 Before You Install From a CD
1.7 Before You Install From a Downloaded Set
1.8 Updating an Existing Installation

2 Single-User Installation

2.1 Installation Requirements
2.2 Starting The Installation
2.3 Setup Procedure
2.4 Verifying The Installation
2.5 Starting The [System]
2.6 Uninstalling The [System]

3 Multi-User and Network Installation

3.1 Server Installation
3.2 Workstation Installation

4 Modifying an Existing Installation

4.1 Modify
4.2 Repair
4.3 Remove

5 Registering the Software

6 FAQs

7 Appendix A: Acronyms, Abbreviations & Definitions

8 Appendix B: Related Documentation

What's included in the template pack

The template is in Microsoft Word format and can be downloaded online for only $7.99.

Setup Guide Template

29 pages