Sommerville-p143

Sommerville-p143 - Software Documentation Written By: Ian...

Info iconThis preview shows pages 1–8. Sign up to view the full content.

View Full Document Right Arrow Icon
Software Documentation Written By: Ian Sommerville Presentation By: Stephen Lopez-Couto
Background image of page 1

Info iconThis preview has intentionally blurred sections. Sign up to view the full version.

View Full DocumentRight Arrow Icon
Discussion Topics 1. Introduction 2. Documentation Requirements 3. Process and Product  Documentation 4. Document Quality 5. Standards 6. Document Preparation 7. Document Storage 8. Conclusion
Background image of page 2
Introduction This paper provides an overview of  the  Reasons for software documentation Types of software documentation Ways to implement software  documentation Processes and “Good Ideas”
Background image of page 3

Info iconThis preview has intentionally blurred sections. Sign up to view the full version.

View Full DocumentRight Arrow Icon
Documentation Requirements General requirements of all software  documentation Should provide for communication  among team members Should act as an information repository  to be used by maintenance engineers Should provide enough information to  management to allow them to perform all  program management related activities Should describe to users how to operate  and administer the system
Background image of page 4
Documentation Requirements In all software projects some amount of  documentation should be created prior to  any code being written Design docs, etc.  Documentation should continue after the  code has been completed  User’s manuals, etc.  The two main types of documentation  created are  Process  and  Product   documents
Background image of page 5

Info iconThis preview has intentionally blurred sections. Sign up to view the full version.

View Full DocumentRight Arrow Icon
Process Documentation Used to record and track the  development process Planning documentation Cost, Schedule, Funding tracking Schedules Standards Etc.  This documentation is created to  allow for successful management of a  software product
Background image of page 6
Process Documentation Has a relatively short lifespan Only important to internal  development process Except in cases where the customer  requires a view into this data Some items, such as papers that  describe design decisions should be  extracted and moved into the  product  documentation category when they  become implemented
Background image of page 7

Info iconThis preview has intentionally blurred sections. Sign up to view the full version.

View Full DocumentRight Arrow Icon
Image of page 8
This is the end of the preview. Sign up to access the rest of the document.

Page1 / 24

Sommerville-p143 - Software Documentation Written By: Ian...

This preview shows document pages 1 - 8. Sign up to view the full document.

View Full Document Right Arrow Icon
Ask a homework question - tutors are online