CSC 480 Software Engineering Documentation

The Importance Documentation is the lifeblood of SE Major usages Those are separated from code Those are closely related to code Major usages Communication between development team and the client and among developers Milestones that can be used to check progress Roadmaps for the project Harnesses for keep quality standards Data helpful for future projects

Types of Documentation SVVP software validation & verification plan Verification & validation SQAP software quality assurance plan Quality assurance SCMP software configuration management plan Configuration SPMP software project management plan Project status Customer-oriented SRS software requirements specifications Requirements Developer-oriented Architecture SDD software design document Design Detailed design Code Source Code Types of Documentation STD software test documention Testing Operation User’s manual Adapted from Software Engineering: An Object-Oriented Perspective by Eric J. Braude (Wiley 2001), with permission.

Planning This set is a roadmap for the project and other documents It is a collection of plans or a big doc covering different aspects Process Deliverables and formats scheduling Staffing/organization Risks and strategies Quality

Standards Various models you can choose from IEEE standards as demonstrated in the text Sample documents for the video game application after each chapter RUP templates as shown in [Pollice et al, 2004] Sample documents available under samples folder TSPi templates as given in [Humphery, 2000]

Assigning Tasks SPMP STD SRS User’s manual Mtg minutes Source Code SDD Test Mgr SPMP software project management plan STD software test documention Plan Mgr SRS software requirements specifications User’s manual Mtg minutes Leader Source Code Support Mgr SDD software design document Tech Mgr Mtg agenda Status Rpt ReadMe file