user guide template word

7/23/2019 User Guide Template word

1/12

Tech Comm TemplateUSER GUIDE

User Guide Template

Month 20YY

Version X.XX

Company Information


2/12


Copyright and third-party information as required

Template provided at no charge by TechWhirl.comYou are free to use and customize as needed.

2
http://techwhirl.com/http://techwhirl.com/


3/12

Tech Comm TemplateUSER GUIDEDocument Revisions

Date

Version

Number Document Changes

05/02/20xx 0.1 Initial Draft


4/12


Table of Contents

1 Introdction......................................................................................................!

1.1..Scope and urpose.......................................................................................... !

1.2..rocess "#er#ie$.............................................................................................!

2 "#roce$$/%or&'lo( 1).......................................................................................*

2.1..%Su&-rocess or 'or()o$ Step 1* +,ampe Con/gure Connect to manage

your $or(................................................................................................................

2.1.1........................................... "#rocedre$ for Step 1) Example+ To ,o- in to Connect+

*

2.1.2.............................................................................................."#rocedre$ for Step 2)+

2.2..%Su&-rocess or 'or()o$ Step 2* +,ampe sset ecord Statuses...............3

ppendice$.......................................................................................................

! Index..............................................................................................................10

1 Introduction

1.1 cope and !urpose

%Introduce the product and its purpose4 highighting (ey features and &ene/ts*

%Introduce the purpose of the user guide4 $hat functionaity or $or()o$s $i &e co#ered5re there any assumptions a&out the users6 (no$edge or e,perience4 or prerequisites5 *

1." !rocess #vervie$%ro#ide a concise description of the o#era processes managed &y the soft$are4 and ho$the user interacts $ith the system. s appica&e4 reference reated processes and

corresponding documentation 7you may $ant to create an ordered ist of each$or()o$8process to &e co#ered9.*

"tpical $e3ence for $in- the $oft(are to mana-e 4-rop of (or&o($/fnction$6+

1. Con7-re or (or&$pace

2. 8ana-e a &e (or&o(

. 8ana-e another &e (or&o(

!. Report


5/12

Tech Comm TemplateUSER GUIDE5. Tro9le$hoot)

%You may choose to incude a process )o$ diagram to accompany the te,t. Considerincuding su&process diagrams throughout the guide to introduce ne$ or su&sequent$or()o$s*


6/12

Chapter :ame

" %!rocess&'or()lo$ 1*%ro#ide a concise description of the conte,t for this process or $or()o$4 incudingany requirements or conditions that are ree#ant. epeat this entire section for eachma:or $or()o$ or process.*

,orem ip$m dolor $it amet; con$ectetr adipi$cin- elit. Etiam at porta e$t; etlo9orti$ $em. Di$ imperdiet in ni$l $ed lct$.


7/12

Chapter :ame

>. Enter $ome text.

. Dra- and drop a =ale.

10.Clic& or pre$$ $omethin- to complete the procedre.

%;"


8/12

Chapter :ame

"." %ub+!rocess or 'or(,o$ tep "*

-ample/ 4sset Record tatuses%If a su&-process or $or()o$ step requires additiona conte,t and detaiedinformation to propery prepare the user4 you can e,pand a conte,t section to incudeta&es 7such as de/nitions of the #aues a#aia&e in a dropdo$n9 or graphics such as

)o$ diagrams. You shoud add captions to identify ta&es and graphics4 and considerincuding a ta&e of /gures foo$ing the


9/12

Chapter :ame

5 4ppendices%ppendices are optiona4 and are used to pro#ide additiona detaied informationthat may hep the end user manage the o#era appication. +,ampes coud incudereferences to standards 7such as '?C standards94 technica speci/cations required

for reguatory compiance4 chec(ists4 or other information of a technica nature.*


10/12

Chapter :ame

6 Inde%@epending on the siAe or compe,ity of the /na document4 consider puing togetheran inde, to assist the using in ocation speci/c information. Inde, entries correspondto tags or categories4 and are usefu in na#igating ong &oo(s.*


11/12

Chapter :ame

6.1 tle heet Information

The follo(in- $tle$ ha=e 9een $et p in thi$ template. =oid applin- manal

character formattin- to the docment. pplin- the$e $tle$ (ill a$$i$t in thecon=er$ion proce$$ if the docment i$ to 9e laid ot in a $trctred athorin-

tool; content mana-ement tool; or an AT8, editor.

tle Name 4ppl to

Title Title a$ li$ted on the co=er pa-e of the docment

Su&tite S9title a$ li$ted on the co=er pa-e of thedocment

7 9eading 1Chapter :ame or #roce$$ or %or&o(

7.1 9eading "S9$ection or S9#roce$$ or %or&o( $tep

7.1.1 9eading 5S9$ection 2 or #rocedre

Callout :loc( CopNote

:ote$; cation$ or (arnin-$; $e arro( -raphic onthe left mar-in

Chapter Bod Cop Generic text follo(in- a headin-

Chapter Bod Cop Bllet

Unordered li$t (ithin a $ection or $9$ection;$ometime$ (ithin a Step to indicate alternati=e

(a$ to do $omethin-.

o Chapter Bod

Cop Bllet 2

$econdar nordered li$t; (ithin a hi-her le=el

ordered or nordered li$t

15.Chapter Bod Cop Step

n ordered li$t $e3ential? $ed in a procedre to

indicate the order of action$ to 9e ta&en

h? Chapter BodCop Step a

$econdar ordered li$t; e.-. $9$tep$ in a

procedre

Chapter Bod Cop

Indent

Set$ additional text in(ard $o that it ali-n$ (ith

either Chapter Bod Cop Bllet or Chapter BodCop Step

Chart Bod Cop Text (ithin a ta9le

Chart 9eader Information The 7r$t ro( of a ta9le.

Caption De$cripti=e text for a ta9le or -raphic.

Aeader Text that appear$ at the top of each pa-e.


12/12

Chapter :ame

tle Name 4ppl to

Footer Text that appear$ at the 9ottom of each pa-e.

Chart Title and Footer Info Copri-ht and other front matter precedin- the

Ta9le of Content$ additional information $ed to

footnote or pro=ide a le-end for a ta9le.

T#C 9eading Aeadin- $ed for Ta9le of Content$; Ta9le of'i-re$ if applica9le?; and the Docment Re=i$ion$

pa-e$ of the front matter to the docment.

T@C 1 T@C di$pla information for a chapter. Generatedatomaticall from Aeadin- 1.

user guide template word

Documents