Purpose of the System Describe why the system was created and its purpose Benefits


Download 54.1 Kb.
NamePurpose of the System Describe why the system was created and its purpose Benefits
A typeDocumentation
manual-guide.com > manual > Documentation



Logo Here


This manual template has been developed in black and white in order to accommodate the Project color schemes. Please substitute your colors where appropriate. The majority of text should be black for easy reading.



T
Contrasting Color here to off set title.
itle Here

Table of contents

Table of contents 2

Introduction and Overview 1

Purpose of the System 1

Benefits 1

Overview of Functions 1

Function 1 1

Function 2 1

Function 3 1

Function 4 1

Schematic Overview 1

How to Use This Manual 2

Key Terms 2

Navigation Basics 3

Logging In 3

Overview of Screen 3

How to access menus 4

Navigating through screens 4

Toolbars 4

Searching 4

Help 4

Function 1 5

Task 1 5

Task 2 5

Task 3 5


How to get help

Insert help contacts here




Chapter

1




Introduction and Overview

This section describes the purpose, benefits, and use of the application. The user manual should be written so that anyone can pick it up and understand what the application is used for.

Purpose of the System


Describe why the system was created and its purpose

Benefits


Describe the benefits in bullet points .

Overview of Functions


Describe the major functions of the system using a flow chart and table as applicable.

Function 1

Function 2

Function 3

Function 4


Function 5






Name

Description

Function 1




Function 2




Function 3




Function 4





Schematic Overview


If there is a schematic or conceptual model that would be helpful to users, put it here.

How to Use This Manual



icon key

    ! Important tip

  • Additional information

  • Common question

     Shortcut stroke
Describe how the information is set up. Process steps are set up so that they can be read easily. More information is given in a separate section. Additional text is categorized as important tip, additional info, common questions.


Add anything else they may need to know.

Key Terms


Put definitions of terms here. Use a list format with the term in bold. Bullet points are not necessary. If this list is very long, put a glossary of terms in an appendix.

Term 1 – this is the definition of the first term.

Term 2 – this is another definition that takes up more space than the first. Try to be as concise as possible when writing definitions.



Chapter

2





Navigation Basics

Use this section to put information and instructions that apply to everyone using the system and to most of the functions in the system. The purpose here is to give a general orientation and to avoid repeating same instructions in multiple sections.

Logging In


Put log in procedure and information here. Emphasize how to get a user account and password.

Overview of Screen


H
1. XXXX Menu
ere is where you will put a screen shot of the main screen(s) with arrows describing the menus and icons.






How to access menus


Information on right click menus, pop-up boxes, etc. is here

Navigating through screens


If there are any unique instructions on scrolling, moving back and forward, etc., put it here. Assume basic computer and internet competency.

Toolbars



Searching



Help




Chapter

3


Function 1

This section describes the steps to perform a specific function. The sections of the user manual should be segregated by job or position, if possible, and then by the functions in a work flow. For instance, if I am a R&D formulator, there should be a section in the user manual that describes the work flow I need to know. Another job position may perform some different and some overlapping functions, but these should be in one place for that person. This does not always apply. In those cases, organize the user manual according to a logical work flow.

Give a brief overview of the contents of this section.

Task 1

Task 2

Task 3


Task 4




How to perform Task 1 Put the steps in a task together in one visual container. This lets the user know instantly how complicated this task is.

If needed, put a brief explanation here. If not, omit.

Insert screen shot here


Use this space to describe the process steps. Users should be able to read these at a glance. Do not put a lot of explanation here. Think of this as essential information

  1. Open menu item

  2. Choose desired option

  3. Perform action




    • Use this space to describe more information such as tips, notes, or more in-depth comments and explanations.

      • Use a slightly different font for this information. (One type size smaller)

      • Use icons to categorize the type of information

      • Think of this as non-essential information.




Use lines to align rows when there is a lot of text, in order to match the notes with the steps. Otherwise, leave unlined so that the reader will naturally read the steps first.

Index

a

Index 1, 1

Index 1, 1

Index 1, 1

Index 2, 2

Index 3, 3

Index 1, 1

Index 1, 1

b

Index 1, 1

Index 1, 1

Index 1, 1

Index 2, 2

c

Index 1, 1

Index 1, 1

Index 1, 1

Index 2, 2

Index 1, 1

Index 1, 1

Index 1, 1

d

Index 1, 1

Index 1, 1

Index 1, 1

Index 1, 1

e

Index 1, 1

Index 1, 1

Index 1, 1

Index 2, 2

Index 1, 1

Index 1, 1

Index 1, 1

g

Index 1, 1

Index 1, 1

Index 1, 1

Index 1, 1

Index 1, 1

Index 1, 1

h

Index 1, 1

Index 1, 1

Index 1, 1

Index 1, 1

Index 2, 2

Index 1, 1

Index 1, 1

Index 1, 1

Index 1, 1

Index 1, 1

Index 1, 1

k

Index 1, 1

L

Index 1, 1

Index 2, 2

Index 1, 1

Index 1, 1

Index 2, 2

Index 1, 1

Index 1, 1

Index 1, 1

Index 1, 1

Index 1, 1

m

Index 1, 1

Index 1, 1

Index 1, 1

Index 2, 2

n

Index 1, 1

Index 1, 1

Index 1, 1

Index 2, 2

Index 1, 1

Index 1, 1

Index 1, 1

r

Index 1, 1

Index 1, 1

s

Index 1, 1

Index 1, 1

Index 1, 1

Index 2, 2

Index 1, 1

Index 1, 1

Index 1, 1

t

Index 1, 1

Index 1, 1

Index 1, 1

Index 1, 1

Index 2, 2

w

Index 1, 1

Index 1, 1

Index 1, 1

Index 2, 2

Index 1, 1

Index 1, 1

Index 1, 1

Index 1,



Share in:

Related:

Purpose of the System Describe why the system was created and its purpose Benefits iconCmw+ 1 Installation Cover Letter (cmw435c doc) 0 The purpose of this...

Purpose of the System Describe why the system was created and its purpose Benefits iconAbstract Use cases are one of the uml diagram used to illustrate...

Purpose of the System Describe why the system was created and its purpose Benefits icon1 2 Labeling All fire alarm system equipment shall be listed for...

Purpose of the System Describe why the system was created and its purpose Benefits icon1 2 Labeling All fire alarm system equipment shall be listed for...

Purpose of the System Describe why the system was created and its purpose Benefits icon1 2 Listings All fire alarm system equipment shall be listed for...

Purpose of the System Describe why the system was created and its purpose Benefits iconAbstract Microcontroller is a basic building block for implementing...

Purpose of the System Describe why the system was created and its purpose Benefits iconThese specifications describe requirements for a Thermal Management...

Purpose of the System Describe why the system was created and its purpose Benefits iconAbstract The purpose of this study was to describe a group of individuals...

Purpose of the System Describe why the system was created and its purpose Benefits iconThe purpose of this guide specification is to assist the specifier...

Purpose of the System Describe why the system was created and its purpose Benefits iconAbstract We describe an animation system for

Purpose of the System Describe why the system was created and its purpose Benefits iconFor the afp retirement and Separation Benefits System (afprsbs)Compound

Purpose of the System Describe why the system was created and its purpose Benefits iconSchedule-based system providing maximum flexibility of programming...

Purpose of the System Describe why the system was created and its purpose Benefits iconThe mini nvr was specially designed for network video surveillance...

Purpose of the System Describe why the system was created and its purpose Benefits iconCollection and input of new equipment data is critical to the continued...

Purpose of the System Describe why the system was created and its purpose Benefits iconAbstract This guide outlines enhancements to the Windows® desktop...

Purpose of the System Describe why the system was created and its purpose Benefits icon1. 1Aim 1The aim of the Operational and Support Concept Document...

Purpose of the System Describe why the system was created and its purpose Benefits iconLooking to Bring the Benefits of Digital Power Conversion Including...

Purpose of the System Describe why the system was created and its purpose Benefits iconHospital Management System provides the benefits of streamlined operations,...

Purpose of the System Describe why the system was created and its purpose Benefits iconManual release switches and the load distribution center. The Dcr...

Purpose of the System Describe why the system was created and its purpose Benefits iconUser-definable, interactive displays may be created magic sheet view....




manual


When copying material provide a link © 2017
contacts
manual-guide.com
search