Writing a Requirements Document for Multimedia and Software Projects

1. Writing a Requirements Documentfor Multimedia and Software Projects Rachel S. Smith Senior Interface Designer

2. Writing a Requirements Documentfor 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? rachel@cdl.edu | www.cdl.edu

3. 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 rachel@cdl.edu | www.cdl.edu

4. Introduction II • Who are you people, anyway? • Project managers • Programmers/developers • Graphic designers • Interface designers • Instructional designers • Other? Introduction rachel@cdl.edu | www.cdl.edu

5. 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 What is..? rachel@cdl.edu | www.cdl.edu

6. 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 What is..? rachel@cdl.edu | www.cdl.edu

7. 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 Why..? rachel@cdl.edu | www.cdl.edu

8. How do you write one? • Gather requirements • Record requirements • Classify requirements • Prioritize requirements • Requirements Tracker Tool • Gather all project documents • Requirements Document Template How do you write a requirements document? rachel@cdl.edu | www.cdl.edu

9. Gathering Requirements • User observations, interviews • Scenarios & personas • Project-related documents • Stakeholder interviews (managers, customers) • Developer & designer interviews • Market research How do you write a requirements document? rachel@cdl.edu | www.cdl.edu

10. 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) How do you write a requirements document? rachel@cdl.edu | www.cdl.edu

11. 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 How do you write a requirements document? rachel@cdl.edu | www.cdl.edu

12. 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 How do you write a requirements document? rachel@cdl.edu | www.cdl.edu

13. 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 How do you write a requirements document? rachel@cdl.edu | www.cdl.edu

14. 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. How do you write a requirements document? rachel@cdl.edu | www.cdl.edu

15. 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 How do you write a requirements document? rachel@cdl.edu | www.cdl.edu

16. How do you use a requirements document? • Part of the point is the process • Validating requirements • Product development • Product testing • After release How use..? rachel@cdl.edu | www.cdl.edu

17. Resources to help you • Workshop website • http://www.cdl.edu/resources/writing-requirements.html • Books on requirements engineering • Send me email… others? Resources rachel@cdl.edu | www.cdl.edu

18. Thank you! Rachel S. Smith rachel@cdl.edu