WRITING EXERCISE

BACKGROUND
Our documentation often break do!n into t"ree information t#$e%
&rocedure
Conce$t
Reference
T"i e'ercie focue on t!o of t"ee t#$e( $rocedure and conce$t)
&ROCEDURES
&rocedura* to$ic an!er t"e +uetion how) Eac" $rocedure "ou*d "a,e it o!n tit*e( !"ic" ref*ect t"e
uer -oa*)
T"e introductor# $ara-ra$" "ou*d e'$*ain why a uer !ou*d !ant to $erform t"e $rocedure or tr# t"e
e'am$*e) If t"e $rocedure i $art of a erie of tak( t"i introduction mi-"t a*o inc*ude a $ara-ra$"
about when to $erform t"e $rocedure)
.o**o!in- t"e introduction( $reent t"e $rocedure a an ordered *it !it" t"e fo**o!in- $art%
/) Uer action 0re+uired1
E'am$*e of uer action
S#tem re$one
2) Uer action 0re+uired1
3
CONCE&TS
Conce$tua* to$ic often $ro,ide u$$ortin- information to "e*$ uer $erform $rocedure uccefu**#)
.or e'am$*e( a conce$tua* to$ic mi-"t e'$*ain "o! to c"ooe t"e ri-"t $rocedure or function from e,era*
o$tion( define a term( or e'$*ain t"e tructure or or-ani4ation of an ob5ect) T"e conce$tua* to$ic "ou*d
"a,e it o!n tit*e( !"ic" te*e-ra$" it content)
ST67E GUIDE7INES
A$$*# t"ee t#*e -uide*ine a #ou do t"e e'ercie%
C"unk information into to$ic 0ection1 !"ere eac" decribe one $rocedure or one conce$t
uin- a *o-ica* content f*o!)
8ake to$ic tit*e specific and meaningful)
E*iminate redundanc#)
Write uccinct*#9 kee$ entence and $ara-ra$" "ort)
Ue active ,oice in second person)
Ue t"e ame -rammatica* form to indicate t"at item in a et are imi*ar or e+ui,a*ent) &ara**e*
contruction i e$ecia**# im$ortant in a *it of re*ated item) .or e'am$*e( if one item in #our *it
tart !it" an im$erati,e ,erb( a** t"e ot"er item in t"at *it "ou*d( too)
Ue conitent termino*o-#)
A,oid content:free !ord( *ike ;etc)<
Correct -rammatica* and $e**in- error)

TASKS
/) &*eae re!rite t"e content in subsystems.pdf to%
&reent $rocedura* to$ic and e'am$*e uin- t"e form and content decribed abo,e)
&reent conce$tua* to$ic t"at $ro,ide u$$ortin- information to "e*$ uer $erform t"e
$rocedure) T"e conce$tua* to$ic "ou*d ue t"e form and content decribed abo,e)
Conform to t"e t#*e -uide*ine decribed abo,e)
2) If #ou need more information to com$*ete t"e $rocedure and t"e conce$t( $ro,ide a *it of t"e
+uetion #ou !ou*d ak to fi** in t"e -a$)