Project Documentation

The following pages lay out the guidelines for writing your term project. These guidelines will be
updated in future memos, if necessary. It is recommended that you set up and format your project
binders as soon as possible, as this will help to facilitate managing the volume of documentation
associated with this project.
Overview of Content
You will be required to turn in both a paper copy and an electronic copy of your project binder.
The project binder should include the following items, in the order listed:
Title Pages
Table of ontents
!even main sections:
". Project #anagement Plan
$. %equirements !pecification
&. 'nalysis
(. )esign
*. Implementation
+. Test )ocumentation
'ppendices, including:
'. ,lossary
-. !ource ode
. .ersion Inde/
). %eferences
0. Progress reports
1. Time logs
0ach of these items will be dealt with in more detail below. The following pages illustrate the way
that your pages should loo2 when properly formatted with headers and footers, and can be used as a
template.
Basic format guidelines
Times 3ew %oman "$4point font
"4inch margins 5top, bottom, left and right6
)o not justify te/t7 use left alignment e/cept for the cover sheet
!ingle4spaced te/t (Please note: this is a change from writing assignment formats, due to the size
of this project.)
learly label in bold any tables, graphs or charts used. Example: Table 3a
!ection headings in bold on separate lines from the te/t body
0ach page 5e/cept the title page6 includes a page header. The header should show: project
leader8s last name, et al. 5meaning 9and the others:6. Example: ;amison, et al.
0ach page also includes a footer. The left footer shows the version and date revised and the
right footer shows the section <, subsection <, and page number. 5,uidelines for versions and
page numbers are given later in this document.6
The first time an acronym is introduced in the te/t, it should be spelled out in its entirety.
Guidelines for Versions
You will be required to trac2 the progress of your project through all its revisions. To do this, you
need to 2eep a record of each document as it is created and revised. 0ach revision of a document is a
version. 0very main section of your project will be a separate document and will have its own
version number. It is recommended that you 2eep current versions 5numbered and dated=6 in your
project binder and remove them to a separate folder as revisions progress. This way, you will be able
to reconcile your hard and soft copies, and also easily create a version inde/ at the end of the
project.
>hen a document is first written, it is said to be created on that date, and its version number is
?.?. If the document undergoes a major revision it is said to be revised on that date and its
version number increases by 1. If the document undergoes a minor revision it is also said to
be revised on that date and its version number increases by 1.
Major Revision (Version # increases by 1): any revision of a document that adds to, subtracts
from, or alters the content or meaning of the document. Example: The original timeline for phase
$ of the project is determined to be impossible to meet7 therefore, the timeline is altered.
Minor Revision (Version # increases by .1): any revision of a document that changes its form
without altering the content or meaning. #inor revisions include grammar and spelling corrections
and reorgani@ations.
>hen you turn in your project binder at the end of the term, you will only submit the final version
of each document 5each main section6. Aowever, in t!e "roject a""endices you will also need
to include an inde# s!owing all versions and t!eir revision dates $%""endi# C&.
Guidelines for Page 'umbers
The page numbering scheme for the project is also based on sections and subsections. 0ach
subsection will be individually page4numbered. 0ach page number will consist of three parts: the
main section, the subsection, and the page. Example: In the Project #anagement section 5the
first main section of the project6 the project scope and objectives section 5second subsection6 is
two pages long. Its page numbers are ".$." and ".$.$.
To number pages in the appendices, substitute the appendi/ letter for the main section number
5appendices should not require subsections.6 Example: if 'ppendi/ ' 5the ,lossary6 has three
pages, they should be numbered '.", '.$, and '.&. To number the Title Pages and Table of
ontents page5s6 simply use lower4case roman numerals 5the Title Pages should be numbered: i,
ii7 the Table of ontents: iii, iv, etc.6
Title Pages
The first title page is similar to the cover sheet used on other reports and papers written for this
class. It should include:
Your Project Title 5underlined6
Term Project
! (*?+BIT0&*?+
Prof. !. Cu
'ames( student )s( and emails of Project Team #embers
'ames and emails of Partner Team
)ate !ubmitted
The second title page is the same as the first, but should only include first names of team members
and should remove student <s and emails.
The title pages should be single4spaced and center4aligned. The te/t should be centered on the
page. Dist the project team leader8s name first, followed by the other team members8 names on
separate lines. The title page should include a page footer with the page number i, but should not
include a page header.
0/ample: !oju on4line boo2store
Term Project
! (*?+BIT0&*E+
Prof. !. Cu
Project Team Name Partner Team Name
'ame( *D( email 'ame( *D( email
'ame( *D( email 'ame( *D( email
;uly $F, $??*
Table of Contents
The format for the Table of ontents can be copied from the following e/ample:
Table of Contents
Title Pages....................................................................................................................G i, ii
Table of ontents........................................................................................................G. iii, iv
Project #anagement Plan...........................................................................................G.
Hverview.GGGGGGGGGGGGGGGGGGGGGGGGGGG. "."."4/
!cope and Hbjectives.GGGGGGGGGGGGGGGGGGGGGG.. ".$."4/
'ssignment of %oles and %esponsibilities.....................................................G.. ".&."
Project !cheduleGGGGGGGGGGGGGGGGGGGGGGGGG ".(."
%equirements !pecificationsGGGGGGGGGGGGGGGGGGGGGGGG. $."4/./
'nalysisGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGG. &."4/./
)esignGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGG (."4/./
ImplementationGGGGGGGGGGGGGGGGGGGGGGGGGGGG.. *."4/./
Test )ocumentationGGGGGGGGGGGGGGGGGGGGGGGGGGG +."4/./
'ppendicesGGGGGGGGGGGGGGGGGGGGGGGGGGGGGG.
,lossaryGGGGGGGGGGGGGGGGGGGGGGGGGGGG.. './
!ource odeGGGGGGGGGGGGGGGGGGGGGGGGGGG -./
.ersion Inde/GGGGGGGGGGGGGGGGGGGGGGGGGG. ./
%eferencesGGGGGGGGGGGGGGGGGGGGGGGGGGG.. )./
Progress reportsGGGGGGGGGGGGGGGGGGGGGGGGG.. 0./
Time logsGGGGGGGGGGGGGGGGGGGGGGGGGGGG 1./
3otification of any changes to this outline will be communicated via a memo posted to the class
web page.
Project +anagement Plan $document D1&
The management plan defines the purpose of the project and its organi@ation. It should include a
subsection for each of the listed topics and others as necessary.
Hverview the project 5general e/planation6
Project scope and objectives 5specifics44>hat is the project team responsible for producingI -y
what timeI6
'ssignment of %oles and %esponsibilities 5identification of project Team Deader7 identification
of Team #embers8 roles, such as Programmer, Tester, etc.7 definition of responsibilities for each
role. 0ach team member may have more than one role, and each role may be assigned to
more than one team member 51or e/ample, there can be several Programmers on a team, one
of whom is also the Team Deader, another the )ocumentation !pecialist, and the third a Tester.66
Project !chedule440ach phase of project development will be given a timeline. The timelines
will include wor2 activities and milestones, as well as set dates for the completion of those
milestones.
,e-uirements ."ecifications $document D/&
This section will consist of a requirements document outlining the system services to be delivered
and will be provided by the instructor 5This will be the first subsection of this main section
document.6
%nalysis $document D/&
This section will document your analysis model. It should include 5but is not limited to6 material
covering items listed below:
'n introduction that includes a description of the problem
Jse case diagrams
Jse case description
Design $document D3 and D0&
This section will document your design model. It should include:
'rchitecture design and interface design
' specification view of the lass )iagrams that shows the most important services provided
lass descriptions 5one for each lass6 that provide an e/planation of the class diagram
)ata #embers for each lass 5)escribe what information they contain.6
#ember 1unctions for each lass7 i.e., a logical description of what the functions do
ollaboration and sequence diagrams
*m"lementation $document D1&
This section will document your implementation model. It should include:
oding standards employed by your team
0/ecution instructions and machineBsystem configuration used
3otice of code changedBadded from the previous product, with reference to which requirement5s6
is being met
Test Documentation $document D2( o"tional&
This section will document the testing procedures used and their results. It will include test plans,
test cases, and a log of the results. Test plans and test cases should illustrate that requirements have
been met and that the design will wor2. Dogs should show supplied inputs, e/pected outputs, and
how actual outputs are compared with the e/pected outputs, in order to determine whether a test
passes or fails.
%""endi# %3 Glossary
'll terms used in the body of your te/t that could be ambiguous or unclear to the reader should be
defined here 51or e/ample, you should define terms such as 9failure: and 9verification.:6
'cronyms should also be listed with their definitions.
%""endi# B3 .ource Code
You will be required to attach a complete copy of your source code. The code document should
follow it own requirement.
%""endi# C3 Version *nde#
's e/plained under the guidelines for versions, this is a list of all version numbers and revision dates
for each main section.
%""endi# D3 ,eferences
Include a bibliography of resources consulted andBor cited in completion of this project. Don4t
forget to reference any gra"!ics from online sources Jse the citation format provided in the class
guideline for writing assignments. %ecommended bibliography format is given by the
Institute of 0lectrical and 0lectronics 0ngineers 5I0006, available in all I000 journals and online at
http:BBcomputer.orgBauthorBstyleBcs4style.htm under the lin2 for 9references.:
%""endi# 53 Progress re"orts
%""endi# 63 Time logs