1. Fall 2006 1 CS-EE 480 Lillevik 480f06-l6 University of Portland School of Engineering Senior Design Lecture 6 Other development processes Technical documents Functional Specifications

2. Fall 2006 2 CS-EE 480 Lillevik 480f06-l6 University of Portland School of Engineering Any questions? Prototype phase –Debug and Evaluation Plan document –Theory of Operations document –Prototype (Alpha) Release milestone Evaluation phase –Qualification Report document –Beta Release milestone

3. Fall 2006 3 CS-EE 480 Lillevik 480f06-l6 University of Portland School of Engineering Any questions? Production phase –Manufacturing Report document –Product Release (First Customer Ship) milestone

4. Fall 2006 4 CS-EE 480 Lillevik 480f06-l6 University of Portland School of Engineering Product development cycle Define Design Prototype Evaluation Production Milestones/ Approvals Product Approval Design Release Prototype Release Beta Release Product Release Documents Functional Specifications Project Plan Debug & Evaluation Plan Theory of Operations Qualification Report Not in class Manufacturing Report EOL Final Report

5. Fall 2006 5 CS-EE 480 Lillevik 480f06-l6 University of Portland School of Engineering End of Life Purpose: stop production (ramp-down) & support Notification Required: sent to all stakeholders Process: all resources removed from product and re-assigned to other products

6. Fall 2006 6 CS-EE 480 Lillevik 480f06-l6 University of Portland School of Engineering The development issue Development environment –Teams, some to 300 - 500 engineers –Multidisciplinary, multi-site, major $$$ –Long time frame, some to 5 years or more Problem: communications Solution –Process –Language Product Development Cycle

7. Fall 2006 7 CS-EE 480 Lillevik 480f06-l6 University of Portland School of Engineering Other development processes Waterfall: our model, follow steps in order, most common Iterative: start small, get big over time Formal: mathematical approach Top-down, bottom-up: big vs. small picture Rapid prototype: implement key pieces first to identify issues

8. Fall 2006 8 CS-EE 480 Lillevik 480f06-l6 University of Portland School of Engineering Which process is best? Top-down, bottom-up Depends Iterative/agile Relative Mixture

9. Fall 2006 9 CS-EE 480 Lillevik 480f06-l6 University of Portland School of Engineering Technical Documents Front material Body material Back material Most information here Your documents will contain these sections

10. Fall 2006 10 CS-EE 480 Lillevik 480f06-l6 University of Portland School of Engineering Front Material Title page Abstract (not required in this class) History revision Acknowledgements (Final Report only) List of figures, tables (LOF, LOT)

11. Fall 2006 11 CS-EE 480 Lillevik 480f06-l6 University of Portland School of Engineering Body material Summary Introduction Background Methods Results Conclusions and Recommendations Some documents will differ slightly

12. Fall 2006 12 CS-EE 480 Lillevik 480f06-l6 University of Portland School of Engineering Back material Appendices Index Glossary

13. Fall 2006 13 CS-EE 480 Lillevik 480f06-l6 University of Portland School of Engineering Why a summary?

14. Fall 2006 14 CS-EE 480 Lillevik 480f06-l6 University of Portland School of Engineering Why an introduction? Intro main points Doc organization Historical Provides a basis Identifies the audience

15. Fall 2006 15 CS-EE 480 Lillevik 480f06-l6 University of Portland School of Engineering Why a background? Historical context Past research relative to present What has been done before Why problem should be addressed now Assumptions

16. Fall 2006 16 CS-EE 480 Lillevik 480f06-l6 University of Portland School of Engineering Why a methods section? Explain what you’re doing How you did it Readers can reproduce experiment

17. Fall 2006 17 CS-EE 480 Lillevik 480f06-l6 University of Portland School of Engineering Why a results section? Compare against hypothesis Record your data Mention what went right/wrong

18. Fall 2006 18 CS-EE 480 Lillevik 480f06-l6 University of Portland School of Engineering Why a conclusions section? State success Suggest future work Restate main points

19. Fall 2006 19 CS-EE 480 Lillevik 480f06-l6 University of Portland School of Engineering Functional specifications Front: title page, revision history, TOC, LOF Body –Summary –Introduction –Background –Requirements –Conclusions Back: appendices

20. Fall 2006 20 CS-EE 480 Lillevik 480f06-l6 University of Portland School of Engineering Requirements section Contents: vary with technical discipline Overview: discuss the big picture Examples –Physical, environmental, hardware, software –Core functionality, security, user preferences, text editor, chat area, file transfer, portlets, user inteface –Inputs, outputs, display, power, physical, environmental

21. Fall 2006 21 CS-EE 480 Lillevik 480f06-l6 University of Portland School of Engineering FS hints Describe your project in as much detail as possible  most important !! If you are not sure about something, make a best guess Cluster requirements into logical groups Start with an overview, then describe the groups

22. Fall 2006 22 CS-EE 480 Lillevik 480f06-l6 University of Portland School of Engineering FS hints, continued. Use tables and figures, but reference and discuss them Every project’s requirements are different Don’t force your project into an example or the template >> This is the biggest single problem! <<

23. Fall 2006 23 CS-EE 480 Lillevik 480f06-l6 University of Portland School of Engineering

24. Fall 2006 24 CS-EE 480 Lillevik 480f06-l6 University of Portland School of Engineering Which process is best? Depends on the situation Each has advantages and disadvantages A company will select one for you

25. Fall 2006 25 CS-EE 480 Lillevik 480f06-l6 University of Portland School of Engineering Why a summary? Often called Executive Summary –CEO doesn’t have the time to read –Must say everything important Good overview for reading document for first time or first time in a while Limit to 1- 2 pages Write this last

26. Fall 2006 26 CS-EE 480 Lillevik 480f06-l6 University of Portland School of Engineering Why an introduction? State the topic or problem Identify the purpose: who is the audience and how will they benefit Clarify the scope: what’s in and what’s not covered Outline the remaining sections Typically 3 – 4 paragraphs, 1 page max

27. Fall 2006 27 CS-EE 480 Lillevik 480f06-l6 University of Portland School of Engineering Why a background? Prepare reader for rest of document –Historical perspective –Key technology –Principal mathematical derivation –Market description –Current situation analysis Set the scene

28. Fall 2006 28 CS-EE 480 Lillevik 480f06-l6 University of Portland School of Engineering Why a methods section? Describes “how” you did what you did –Assumptions –Software tools and environment –Procedures, equipment Allows another team to reproduce what you did or to enhance it

29. Fall 2006 29 CS-EE 480 Lillevik 480f06-l6 University of Portland School of Engineering Why a results section? Publish the data in one spot: tables, figures Describe significant observations and findings Compare theoretical versus experimental results Discuss possible sources of error Represents the bulk of the document

30. Fall 2006 30 CS-EE 480 Lillevik 480f06-l6 University of Portland School of Engineering Why a conclusions section? Show that the goals were met and how Explain any undesirable results Recommend future work or improvements Do not introduce new material Often 1 – 2 pages