Transcript Writing a Requirements Document

Writing a Requirements Document
for Multimedia and Software Projects
Rachel S. Smith
Senior Interface Designer
Writing a Requirements Document
for Multimedia and Software Projects
•
•
•
•
•
•
Introduction
What is a requirements document?
Why write one?
How do you write one?
How do you use one?
What resources are available?
Introduction
[email protected] | www.cdl.edu
What is..?
Why..?
How do you write a requirements document?
7/8/2015
How use..? Resources
slide 2
Introduction 1
• Who is this Rachel person, anyway?
– Senior Interface Designer @ CDL
•
•
•
•
•
•
Gather needs from users
Interpret needs into requirements
Help project teams refine requirements
Help users validate requirements
Design interfaces from requirements documents
Other odd jobs
– Mother of David, aged 4 years
• I’m sure you can imagine what this entails.
Introduction
[email protected] | www.cdl.edu
What is..?
Why..?
How do you write a requirements document?
7/8/2015
How use..? Resources
slide 3
Introduction II
• Who are you people, anyway?
–
–
–
–
–
–
Project managers
Programmers/developers
Graphic designers
Interface designers
Instructional designers
Other?
Introduction
[email protected] | www.cdl.edu
What is..?
Why..?
How do you write a requirements document?
7/8/2015
How use..? Resources
slide 4
What is a requirements document?
• A formal list of requirements, which are:
– Descriptions of how the system should work
– Descriptions of system properties
– Constraints placed upon development
process
– In general, statements of what a system
should do rather than how it should do it
• Includes requirements from end users,
customers, and developers
Introduction
[email protected] | www.cdl.edu
What is..?
Why..?
How do you write a requirements document?
7/8/2015
How use..? Resources
slide 5
What is a requirements document?
• Includes user, system, and interface
requirements (sometimes others)
• Explains why the product is needed or
useful
• Describes the context in which the
product is being developed
• Describes what the finished product will
be like
Introduction
[email protected] | www.cdl.edu
What is..?
Why..?
How do you write a requirements document?
7/8/2015
How use..? Resources
slide 6
Why write a requirements document?
• Ensures all stakeholders agree on what is
to be created
• Serves as a guide to development,
scheduling, and project planning
• Helps set expectations
• Gathers project information in one handy
place
Introduction
[email protected] | www.cdl.edu
What is..?
Why..?
How do you write a requirements document?
7/8/2015
How use..? Resources
slide 7
How do you write one?
•
•
•
•
Gather requirements
Record requirements
Classify requirements
Prioritize requirements
– Requirements Tracker Tool
• Gather all project documents
– Requirements Document Template
Introduction
[email protected] | www.cdl.edu
What is..?
Why..?
How do you write a requirements document?
7/8/2015
How use..? Resources
slide 8
Gathering Requirements
•
•
•
•
User observations, interviews
Scenarios & personas
Project-related documents
Stakeholder interviews (managers,
customers)
• Developer & designer interviews
• Market research
Introduction
[email protected] | www.cdl.edu
What is..?
Why..?
How do you write a requirements document?
7/8/2015
How use..? Resources
slide 9
Recording Requirements
• Information to collect with each stated
requirement:
–
–
–
–
Source & person recording
Rationale
Desired priority (according to source)
Stakeholders most affected
• How to collect it?
– Use a form (paper or online)
Introduction
[email protected] | www.cdl.edu
What is..?
Why..?
How do you write a requirements document?
7/8/2015
How use..? Resources
slide 10
Classifying Requirements
• Project components
– system, user interface, database, security…
• Type of requirement
– system, process, out of scope…
• System components, if applicable
– for more complex projects
• Why do this?
– Organizes your requirements
Introduction
[email protected] | www.cdl.edu
What is..?
Why..?
How do you write a requirements document?
7/8/2015
How use..? Resources
slide 11
Prioritizing Requirements
• How to assign priorities?
–
–
–
–
Review source & desired priority
Review stakeholders involved
Estimate cost of implementation
Negotiate with stakeholders as needed
• Why do this?
– It’s likely not all requirements will be
implemented; this helps you choose
Introduction
[email protected] | www.cdl.edu
What is..?
Why..?
How do you write a requirements document?
7/8/2015
How use..? Resources
slide 12
Requirements Tracker Tool
• An open-source project started at CDL
• Available on SourceForge.net
• Features to help with process
–
–
–
–
Easily record requirements
Classify & prioritize in same system
Flag as validated, accepted, rejected, etc.
Generate lists of requirements to place in
requirements document
Introduction
[email protected] | www.cdl.edu
What is..?
Why..?
How do you write a requirements document?
7/8/2015
How use..? Resources
slide 13
Writing the Document
• Gather all project documents
– Requirements source documents
– Reference list
– Any other pertinent documents
• Organize requirements
– Use Tracker tool to generate report
– Or sort requirements by type, priority, and/or
stakeholder, etc.
Introduction
[email protected] | www.cdl.edu
What is..?
Why..?
How do you write a requirements document?
7/8/2015
How use..? Resources
slide 14
Requirements Document Template
• Download from workshop website
• Instructions are included in document
• Fill in sections as needed
–
–
–
–
Introduction
General Description
Specific Requirements
Appendices, Glossary, References & Index
Introduction
[email protected] | www.cdl.edu
What is..?
Why..?
How do you write a requirements document?
7/8/2015
How use..? Resources
slide 15
How do you use a requirements
document?
•
•
•
•
•
Part of the point is the process
Validating requirements
Product development
Product testing
After release
Introduction
[email protected] | www.cdl.edu
What is..?
Why..?
How do you write a requirements document?
7/8/2015
How use..? Resources
slide 16
Resources to help you
• Workshop website
– http://www.cdl.edu/resources/writing-requirements.html
• Books on requirements engineering
• Send me email… others?
Introduction
[email protected] | www.cdl.edu
What is..?
Why..?
How do you write a requirements document?
7/8/2015
How use..? Resources
slide 17
Thank you!
Rachel S. Smith
[email protected]