Project Requirements and Design

Agenda

• Proposal
• Requirements
• Design
• Questions

2

1.

Proposal

What are you building

Proposal

• What are you building?
• This does not specify how you are building the project
• Include background material
• What you still need to learn
• Details of the project specification process (Lesson 7)
• This is typically 1 page long (or less)

4

2.

Requirements

Like the proposal, but this time with feeling

Requirements

• What are you building?
• This does not specify how you are building the project
• Take your proposal document
• Include background material
• Add more detail
• This is typically 1-3 pages long

6

Requirements

• What is different between requirements and proposal?
• Not much, it’s just more!
• Use the proposal as a starting point
• Add in additional information on:
• How user input/output will work
• Getting training data for ML
• What you still need to learn for project success
• Anything you’ve learned in about the project since the proposal doc

7

3.

Design

How are you building it?

Design

• How are you building it?
• Create a repl and use comments
• Include any links to code/tutorials that you are using
• Indicate major portions of the code
• Now recurse through the comments until you have filled in details to be able to write code

9

4.

Questions

Now what?

Common Questions

• Does formatting matter?
• No, format this in a way that makes sense for you
• Is this cast in stone?
• No, the project will almost certainly change as you learn more and start to write code

11

Common Questions

• If the project changes, you do not need to update previously submitted documentation
• Although it’s probably a good idea

12

EXTRA GRAPHICS

13

CREDITS

Special thanks to all the people who made and released these awesome resources for free:

• Presentation template by SlidesCarnival

14