View
212
Download
0
Category
Tags:
Preview:
Citation preview
CO32004 MDM Unit 4
Project Documentation
CO32004 MDM Unit 4 Slide 2 of 21 © Napier University 2003
Learning Outcomes
After completing this unit, you will be able to Select the appropriate form of documentation for each
stage of a project Prepare documentation that communicates effectively
with the target audience Use documentation to enhance control of difficult
projects. Maintain documentation after a project in a systematic
way
To help you: design and develop multimedia applications in a
structured and systematic manner
CO32004 MDM Unit 4 Slide 3 of 21 © Napier University 2003
Group Discussion
What is the purpose of project documentation ?
How detailed should it be ?
What do you see as being the consequences of poor project documentation ?
CO32004 MDM Unit 4 Slide 4 of 21 © Napier University 2003
Project Brief
A single page document
Concise and to the point
It’s a binding commitment – the project will be perceived to have succeeded or failed in meeting the brief
CO32004 MDM Unit 4 Slide 5 of 21 © Napier University 2003
Bid Proposal (top level)
General Introduction and Executive Summary
Table of Contents Needs Analysis and Description (…)Target Audience (profile, context)Creative Strategy (…)Project Implementation (…)
CO32004 MDM Unit 4 Slide 6 of 21 © Napier University 2003
Bid Proposal (detail)
Needs analysis & description: state what the client wants from the project the user needs from the application
Creative Strategy Description/rationalisation of the general treatment Variations on the treatment Outline diagram of the structure
Project Implementation Description of the human resources Work breakdown (in task hours) and schedule
(deadlines)
CO32004 MDM Unit 4 Slide 7 of 21 © Napier University 2003
Held to account- sample docs pages 1-4
The proposal documentation is your hostage to fortune!
Sample doc is a company’s report back to the customer, at the end of the first phase How well met were the objectives from
the original proposal? Note who signs it
CO32004 MDM Unit 4 Slide 8 of 21 © Napier University 2003
Working Drawings
This term covers a multitude of approaches, and may vary from customer to customer Requirements Specs Navigation Maps (and possibly Data Flow
Diagrams) Story-boards Design Rationale Test Specifications
Often there is no logical sequence to these!But often part payment is triggered by them!!
CO32004 MDM Unit 4 Slide 9 of 21 © Napier University 2003
Requirements Specification
Technical RequirementsTarget Audience Aims of Application Contents System Overview
System Structure (eg for extensibility) Navigation Guidelines Look & Feel - Screen Layout Guidelines
CO32004 MDM Unit 4 Slide 10 of 21 © Napier University 2003
Held to account – sample docs 5-11
Having defined the technical requirements etc, you will face problems meeting them.
Here the company required development in a specific unstable tool. Fundamentally this was a contradiction with the other requirements.
You need this kind of line-by-line critique of where the company’s requirements contradict each other.
It can still be ethical to “cover your back”
CO32004 MDM Unit 4 Slide 11 of 21 © Napier University 2003
Break
Back in ten minutes please
CO32004 MDM Unit 4 Slide 12 of 21 © Napier University 2003
Navigation Maps
LinearHierarchicalNon-linearComposite
Examples
CO32004 MDM Unit 4 Slide 13 of 21 © Napier University 2003
Multimedia Awareness
In groups discuss the following how useful are navigation maps for
representing hypermedia structures?
what alternatives could be used?
should navigation maps represent the logical or physical structuring of content?
how can dynamic sections be indicated on a navigation map?
CO32004 MDM Unit 4 Slide 14 of 21 © Napier University 2003
Storyboarding - sample docs 12-15
Schematic A rough sketch to help build a mental
modelDetailed
Prescriptive, defines exactly what the programmer and designer must do
Basis of test spec
CO32004 MDM Unit 4 Slide 15 of 21 © Napier University 2003
Test Documents
Test Schedule – implies summary reports
Report Forms – for raising new problems Alpha – may be testing a lot of known flaws
Beta – should be as good as we think it will get
Bug report (or “new feature” request?)
Revision documentation Changes needed to requirements/design/test
plan?
CO32004 MDM Unit 4 Slide 16 of 21 © Napier University 2003
Design Rationale
Provide a communication mechanismAid the transfer of accumulated
knowledgeEncourage deliberationHelp explain choicesEncourage consideration of all
alternativesCan help capture context
CO32004 MDM Unit 4 Slide 17 of 21 © Napier University 2003
Post-mortem
The time to document is during the project, but immediately afterwards is better than not at all. Store multiple versions of the design specs and
drawings – each hand mark-up may imply a contract Collate electronic documents into an archive, along
with all source code (eg Director files) and make multiple copies, complete with (tested) rebuild instructions
You may need to repeat job for another customerYou may need to adapt job for this customer
CO32004 MDM Unit 4 Slide 18 of 21 © Napier University 2003
Directed Study
Design Practice
Exercises 1 to 4
CO32004 MDM Unit 4 Slide 19 of 21 © Napier University 2003
Summary
Project BriefBid ProposalRequirements SpecificationNavigation MapsStoryboardingTest DocumentsDesign Rationale
CO32004 MDM Unit 4 Slide 20 of 21 © Napier University 2003
Questions for yourselves
You need to be able to design and develop multimedia applications in a
structured and systematic manner
Can you Select the appropriate form of documentation for each
stage of a project? Prepare documentation that communicates effectively
with the target audience? Use documentation to enhance control of difficult
projects? Maintain documentation after a project in a systematic
way?
CO32004 MDM Unit 4 Slide 21 of 21 © Napier University 2003
Next two weeks lectures(week 5 & 6)
You will form yourselves into groups of four or five. Bring pencils and paper
Each group may choose one of the two topics
You will brainstorm, with the lecturer’s support, a proposal
F11 is available for some of the groupsTutorials will involve a different exercise (but
also one that involves the same activities that you need to follow for the coursework
CO32004 MDM Unit 4 Slide 22 of 21 © Napier University 2003
History2
Team4
Simulation5
Equipment3
Movie
Presentation resets after Presentation resets after 2 minutes of inactivity2 minutes of inactivity
Navigation Map: Mines Rescue
Movie
Museum Exhibits 6
Credits6.1
Main Menu1
Welcome0
CO32004 MDM Unit 4 Slide 23 of 21 © Napier University 2003
1
What is a Multimedia PC?2
What kind of Processor ?3
Do I need a Modem ?5
How much Memory ?4
What type of Sound System ?6
What about Resolution and Colour ?7
Which software ?8
What type of Data Storage ?9
Do I need a CD ROM Drive ?10
Main Menu Page
1
Welcome
Exit Screen11
0
CO32004 MDM Unit 4 Slide 24 of 21 © Napier University 2003
How does the ear work ?
2
How does noise damage
the ear ? 3
How can the ears be
protected ? 5
What are the effects of
hearing loss ? 4
Have I achieved the learning outcomes ? 6
How do you measure
noise ? 3.1
Hearing Loss Section
Terminating exit option causes program to jump to main menu
Main Menu Section
Where can I get more
information ? 7
Ear Protection Section
Assessment Quiz Section
Help Page(floating window)
F 1
Welcome
0
Main Menu
1
Exit
8
Navigation Map: Main Navigation
Help windowcan be
called from all pages
hearing1
CO32004 MDM Unit 4 Slide 25 of 21 © Napier University 2003
60 year old 30 year
exposure4.5
60 year old15 year
exposure4.4
60 year old5 years
exposure4.3
Exposure to noise
4.2
Age4.1
Hearing Loss Section
How does the ear work ?
2
How does noise damage
the ear ? 3
How can the ears be
protected ? 5
What are the effects of
hearing loss ? 4
Have I achieved the learning outcomes ? 6
How do you measure
noise ? 3.1
Terminating exit option causes program to jump to main menu
Main Menu Section
Where can I get more
information ? 7
Ear Protection Section
Assessment Quiz Section
Help Page(floating window)
F 1
Welcome
0
Main Menu
1
Exit
8
Navigation Map: Main Navigation
Help windowcan be
called from all pageshea
ring2
CO32004 MDM Unit 4 Slide 26 of 21 © Napier University 2003
How does the ear work ?
2
How does noise damage
the ear ? 3
How can the ears be
protected ? 5
What are the effects of
hearing loss ? 4
Have I achieved the learning outcomes ? 6
How do you measure
noise ? 3.1
Terminating exit option causes program to jump to main menu
Main Menu Section
Where can I get more
information ? 7
Help Page(floating window)
F 1
Welcome
0
Main Menu
1
Exit
8
Navigation Map: Main Navigation
Help windowcan be
called from all pages
example n
5.n
example 1
5.1
example 2
5.2
Ear Protection Section
hearing3
Assessment Quiz Section
Hearing Loss Section
CO32004 MDM Unit 4 Slide 27 of 21 © Napier University 2003
How does the ear work ?
2
How does noise damage
the ear ? 3
How can the ears be
protected ? 5
What are the effects of
hearing loss ? 4
Have I achieved the learning outcomes ? 6
How do you measure
noise ? 3.1
Terminating exit option causes program to jump to main menu
Main Menu Section
Where can I get more
information ? 7
Help Page(floating window)
F 1
Help windowcan be
called from all pages
Welcome
0
Main Menu
1
Exit
8
Navigation Map: Main Navigation
Question n6.n
Question 46.4
Question 36.3
Question 26.2
Question 16.1
Assessment Quiz Section
Feedback6.n+1
Response(floating window)
F 2
Response window can be called from within all question pages
hearing4
Hearing Loss Section
Ear Protection Section
Recommended