SYST28515 - Systems Analysis & Design

SYST28515 Documentation Standards

The following guidelines apply to all written deliverales! e"#ept
Deliverale 1 Team $ontra#t% The team #ontra#t is to e #ompleted!
stapled and sumitted as a & page do#ument%
The remaining deliverales will follow a standardi'ed format% (hile
ea#h deliverale will have its spe#i)# format and re*uirements! there
are general guidelines that will apply to deliverales 2! &! and +! as
noted elow%
1. Deliverables 2, 3 and 4 must be submitted in pdf format as
one document. The are to be submitted b the !roup"s
pro#ect leader. Do not submit the document in sections. $f
submitted in sections, a 1%& penalt 'ill appl for each da
it is not submitted in the proper format. (fter 3 das late, a
!rade of )ero is assi!ned.
All deliverales are #he#,ed y Turn -t in.
Deliverale 1! the team #ontra#t! is handed in as a signed! paper
#opy% A group name is re*uired%
Deliverale 5! the powerpoint slides of the presentation! must e
sumitted as a ppt do#ument to the dropo" on the day of the
presentation! efore you present%
2. .a#h deliverale must have a title page% The title page will list/
The #ase study #lient #ompany name and #onta#t name0s1
The due date
The group name
The group memer names in alphaeti#al order y last name and
si!ned b all !roup members 0signatures #an e s#anned in
as a 2peg1
The professor3s name
3. .a#h deliverale will have a #overing letter atta#hed% The #overing
letter is in usiness letter format% -t is addressed to the #ase study
#lient and its purpose is to introdu#e the deliverale and rie4y
e"plain what it is! what it #ontains and what the #lient is supposed
to do with it%
4. .a#h deliverale must have an ."e#utive Summary% An e"e#utive
summary is to #omment on the essen#e of the material that it is in
5age 1 of 2
SYST28515 - Systems Analysis & Design
the deliverale% -t must highlight and summari'e the important
points of the deliverale%
5. .a#h deliverale must have a Tale of $ontents%

*. .a#h deliverale must have an -ntrodu#tion% The introdu#tion must
e"plain the purpose of the do#ument! its layout and what is found in
the various se#tions%
+. The spe#i)# re*uirements for ea#h deliverale are to e in#luded at
this point%
8. .a#h deliverale must e word pro#essed! organi'ed and presented
in a professional format% The se#tions of the deliverale must have
a uni)ed appearan#e in te"t! headings! font style! si'e et#% The
produ#t must loo, as if one individual produ#ed it%
,. .a#h deliverale must e properly spell #he#,ed and grammati#ally
#orre#t%
1%. ."plain the diagram or )gure 6-7ST and then in#lude it in the
report%
11. Some deliverales will re*uire appendi#es su#h as #osting details
from the internet% These appendi#es must e listed in the tale of
#ontents! i%e% 8ardware details 9%% Appendi" A% Any information
that is pla#ed in the appendi" must e referen#ed from the ody of
the report% Appendi#es must e separated from the ody and from
one another with tas for ease of referen#e%
12. At the end of ea#h deliverale in#lude a tale detailing the name
of the group memer and the se#tions of the deliverale that he:she
was responsile for! e"ample given elow% The pro2e#t leader will
assign se#tions to the memers%
;roup <emer name
0printed1
Deliverale se#tion0s1
#ompleted
<emer Signature
5age 2 of 2