1 / 9

Software Development Documentation

Software Development Documentation. Introduction. Documentation can be tied into the entire software development cycle. Unfortunately, documentation is often an afterthought. This presentation defines 5 important software development documents. Overview.

elma
Download Presentation

Software Development Documentation

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript

  1. Software Development Documentation

  2. Introduction Documentation can be tied into the entire software development cycle. Unfortunately, documentation is often an afterthought. This presentation defines 5 important software development documents.

  3. Overview The software development process should include the following documents: • Market Requirements Document (MRD) • Product Requirements Document (PRD) • Design Documents • Specifications • Test Cases

  4. Market Requirements Document (MRD) The market requirements document is: • Created by Marketing • Explains what the marketplace is looking for • Identifies important product features

  5. Product Requirements Document (PRD) The product requirements document is: • Created by Product Management • Explains how the product will fulfill the Market Requirements Document (MRD) • Lists and describes key product features

  6. Design Documents Design documents are: • Created by Development • Explain, often in substantial technical detail, how the product will be designed • Indicates how the product design will fulfill the Product Requirements Document (PRD)

  7. Specifications Specification documents are: • Created by Development • Indicate precisely how the product should behave in certain conditions • May apply to internal operations, external operations, and the user interface • Serves as basis for test cases

  8. Test Cases Test cases are: • Created by Quality Assurance (QA) • Verifies that the product fulfills the Product Requirements Document (PRD) • Validates that the product conforms to specifications • Serves as basis for end user documentation

  9. End-user documentation End-user documentation: • Is created by a technical writer • Provides installation instructions • Explains how to use the product

More Related