Report And User Manual Guidelines
User Manual:
Open the PDF directly: View PDF 
.
Page Count: 2
!
1"
Final"Report"and"User"Manual"Guidelines"
"
Marking"Criteria:"
The"following"criteria"are"used"in"evaluating"these"two"documents"
"
Description"
A1"
Final"report:"goal"and"background"are"clear"from"the"text"
B1"
Final"report:"final"results"are"clearly"stated"and"explained,"report"gives"a"
good"overview"and"is"written"concisely,"conclusion"shows"aspects"with"
improvement"potential"
C1"
Final"report:"clarity"of"document"structure,"formatting,"overview,"
language"and"design"
"
"
A2"
Manual:"clearly"understandable"for"the"target"audience"and"is"not"
ambiguous"(no"room"for"interpretation),"is"complete,"is"relevant"and"
prioritized"
B2"
Manual:"easy"to"comprehend"through"included"visuals"
C2"
Manual:"safety"aspects"are"sufficiently"covered,"easily"understandable"
and"prominently"placed"(if"the"project"does"not"have"safety"aspects,"
these"points"go"to"D)"
"
The"mark"/10"is"given"according"to"UWA’s"marking"guide,"where"5P6"is"passed,"6P7"is"
average,"7P8"is"distinction,"8P10"is"high"distinction."
"
Tips"for"final"report"and"manual:""
!
"#$!%&'()!*$+,*-!.#,/)0!1&2$!('!,2$*2&$3!,2$*!-#$!*$./)-.!,%!-#$!+*,4$5-!('0!6!,')7!3#$*$!
&8+,*-('-!6!0$.5*&9$!#,3!-#$!*$./)-.!3$*$!(5#&$2$0:!;))!-#$!,-#$*!0,5/8$'-.!)&<$!
*$=/&*$8$'-.!('0!0$.&1'>!=/()&-7!,*!8('/()!.#,/)0!9$!*$%$*$'5$0!&'!-#$!%&'()!*$+,*-:!
!
;!8('/()!6!().,!5())$0!/.$*!1/&0$>!/.$*!8('/()>!0(-(!.#$$->!.+$5!.#$$-!,*!#('09,,<!
0$+$'0&'1!,'!&-?.!(++)&5(-&,'!6!&.!(!0,5/8$'-!-,!.#,3!/.$*.!#,3!-,!#('0)$!(!.7.-$8!('0!
.,8$-&8$.!./88(*&@$.!-#$!+$*%,*8('5$!,%!-#$!.7.-$8:!A-!&.!-#$*$%,*$!&8+,*-('-!-#(-!-#$!
8('/()!&.!3*&--$'!3&-#!-#$!-(*1$-!(/0&$'5$!B!$'0!/.$*!&'!8&'0:!C,*!9$--$*!/'0$*.-('0&'1>!
8('/().!/./())7!5,'-(&'!5,**$.+,'0&'1!2&./().!9$.&0$!-#$!3*&--$'!1/&0$:!"#$.$!2&./().!5('!9$!
+#,-,.!,%!-#$!#(*03(*$!.7.-$8!,*!,%!(!+$*.,'!/.&'1!-#$!.7.-$8>!.5*$$'.#,-.!,%!.,%-3(*$!
&'-$*%(5$.>!0&(1*(8.>!&5,'.!,*!-(9)$.:!;!1,,0!8('/()!0,$.!',-!4/.-!.#,3!#,3!-,!/.$!5$*-(&'!
%/'5-&,'.!,%!-#$!.7.-$8>!9/-!1&2$.!(!1,,0!,2$*2&$3!,2$*!3#(-!%/'5-&,'.!-#$*$!(*$!('0!3#(-!
-#$7!(*$!%,*:!;',-#$*!&8+,*-('-!(.+$5-!,%!(!8('/()!5('!9$!-#$!3(*'&'1>!5(/-&,'!,*!0('1$*!
&'0&5(-&,'.!&%!.(%$-7!#(@(*0.!#(2$!-,!9$!5,'.&0$*$0!('0!-#$!.7.-$8!8('/%(5-/*$*!3('-.!-,!
(2,&0!)&(9&)&-7:!
!
D'1&'$$*&'1!0,5/8$'-.!(*$!/./())7!3*&--$'!&'!-#&*0!+$*.,'!B!&8+$*.,'():!E('1/(1$!.#,/)0!9$!
5,'5&.$!('0!%(5-/()>!',-!5,'2$*.(-&,'()!B!$8,-&2$:!F&./()&.(-&,'!&.!(!+,3$*%/)!-,,)!%,*!./5#!
0,5/8$'-.:!G&5-/*$.!B!0&(1*(8.!(*$!1,,0!-,!./++)$8$'-!-$H-!('0!1&2$!-#$!*$(0$*!(!9$--$*!
/'0$*.-('0&'1!,%!-#$!+*,4$5->!-#$7!.#,/)0!#,3$2$*!',-!4/.-!%&))!+(1$.!3&-#,/-!$H+)('(-,*7!
-$H-:!I,'?-!%,*1$-!+(1$!'/89$*.:"
"
"
The"groups"should"submit"2"clearly"separated"documents:"
!
2"
"
Structure"Final"Report:"
"
1)"Abstract"–"HalfPpager"summarising"the"whole"project"with"its"results"
2)"Task"allocation"–"Description"of"which"team"member"completed"which"tasks"
3)"Introduction"–"summary"of"project"with"overall"goal,"purpose"of"this"document,"what"will"
be"discussed"in"the"following"sections"
JK!L,8$'5)(-/*$!&%!'$$0$0>!E&.-!,%!C&1/*$.!('0!E&.-!,%!"(9)$.!M,+-&,'()K!
5)"Background"to"project"
6)"Results"of"project"work"
7)"Lessons"learned"
8)"Conclusion"/!Open"questions"/"future"extensions"–"what"are"the"most"critical"
characteristics"of"the"project"work,"what"aspects"will"future"work"have"to"specifically"
consider"or"improve"
9)"Reference"list"
!
The"final"report"should"contain"around"2P4"pages"*"students"in"team"for"the"final"report,"
excluding"appendices.""
!
!
Structure"Manual:"
"
1)"Introduction"–"very"brief"introduction"to"manual,"what"will"be"discussed"in"the"following"
sections,"who"is"the"target"audience"
NK!L,8$'5)(-/*$!&%!'$$0$0>!E&.-!,%!C&1/*$.!('0!E&.-!,%!"(9)$.!M,+-&,'()K!
3)"Contents"
JK!O$--&'1P.-(*-$0!1/&0$!6!9*&$%!-/-,*&()!,'!#,3!-,!.-(*-!-#$!.7.-$8!3&-#!0$%(/)-!.$--&'1.!
M,+-&,'()K!
5)"Manual"
QK!"*,/9)$.#,,-&'1!.$5-&,'!6!0$-(&)&'1!+,..&9)$!$**,*.!,*!+*,9)$8.!-#(-!8(7!,55/*>!(),'1!3&-#!
#,3!-,!%&H!-#$8!M,+-&,'()K!
RK!C;S!.$5-&,'!M,+-&,'()K!
TK!U$%$*$'5$!)&.-!M,+-&,'()K!
"
The"manual"should"contain"around"3P5"pages"*"students"in"team,"excluding"appendices.""
"
"
"
The"grade"for"both"documents"will"be"given"for"the"whole"team.""
"
"
"
"
For"more"information:"
"
Google"“good"user"manual"/"user"guide"/"report”"(or"the"same"with"“bad”)"
http://www.userfocus.co.uk/articles/usermanuals.html"
https://en.wikipedia.org/wiki/User_guide"
https://www.prismnet.com/~hcexres/textbook/user_guides.html"
"
