1. COMP 2007 R J Walters

2. COMP 2007 - 3 Remember - Documentation Defines your Engineering process Includes Requirements Design Testing User manuals Other things

3. COMP 2007 - 3 Introduction Looked a bit at requirements last time Dr Saunders will be looking at Design I will be back on testing later Today: User Documentation Other documents Reviews & Inspections, Version control … One other thing

4. COMP 2007 - 3 User Documentation Has to be complete and accurate Must comply with the client’s requirement Plan document generation Don’t leave it all to the end

5. COMP 2007 - 3 Other Documentation: Reviews Inspection Walk through Presentations Formal Informal Peer group review Casual conversations Testing??

6. COMP 2007 - 3 Inspections Popular with large developers Early identification of defects Easier and cheaper to make corrections Management tool To analyse development (process) To predict results

7. COMP 2007 - 3 Inspections – How? Roles Moderator Chairman Producer Specification Monitor Checks code against specifications Recorder Keeps minutes

8. COMP 2007 - 3 Inspections – How? Comparison of lower level document with its higher level precursor Line by line examination of low lever document Small group Outcome is often list of errors

9. COMP 2007 - 3 Inspections – How? Correct – its right Doc – its right but needs more explanation Style – its right but … Bug – it is wrong Puzzle – right, wrong, who knows?

10. COMP 2007 - 3 Version control Use for documents as well as code Unambiguous identification of versions Locking You have free access to CVS

11. COMP 2007 - 3 What about formal methods or extreme programming? Software Engineering principles still apply Documentation will be different Proofs of correctness Supporting documents Testing?

12. COMP 2007 - 3 Questions? Next time: Coursework 1 Suggested reading Your UML reference Software Engineering, 7th Edition, Ian Sommerville Software Engineering: A Practitioner's Approach, Roger Pressman

13. COMP 2007 - 3