COMP 2007 R J Walters

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

COMP 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

COMP 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

COMP Other Documentation: Reviews Inspection Walk through Presentations Formal Informal Peer group review Casual conversations Testing??

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

COMP Inspections – How? Roles Moderator Chairman Producer Specification Monitor Checks code against specifications Recorder Keeps minutes

COMP 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

COMP 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?

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

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

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

COMP