1 / 14

Requirements Documentation

This guide outlines the best practices for creating effective requirements documentation in the AIMS framework. It emphasizes customer and developer-oriented approaches, ensuring clarity and traceability from requirements to test cases. Key aspects include the use of common documentation standards, such as IEEE 830, and the importance of both formal and informal reviews. The documentation should facilitate unambiguous communication, covering functional requirements and detailed design while focusing on feasibility and testability. This comprehensive approach improves project outcomes and stakeholder satisfaction.

naoko
Télécharger la présentation

Requirements 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. Requirements Documentation Colin Potts Georgia Tech

  2. Customer- and developer-oriented documentation

  3. Post-requirements traceability Requirements derived from Test cases meets passes/fails Implementation

  4. Pre- and post-requirements traceability in AIMS Requirements meets derived from Specification Test cases meets Detailed design passes/fails meets Implementation

  5. Input: CoWorker record in which blah = 1, and ... Expected output: blah = 2 1.1 The system shall blah, blah... 1.2 If the co-worker is blah, blah, the system shall inform the user ... 1.2.1... if !(fizzwick(cw)) { for (i=0;i=max;i++) update(cw, i); ... else ... Traceability (cont). Reqt Test case .... Code

  6. Documentation standards • Common document standards exist • e.g IEEE 830 (Software Reqts. Specs.)

  7. AIMS Documentation structure • Reqts. definition

  8. AIMS Documentation structure • Specification & design

  9. AIMS Documentation structure • Functional reqts./app. overview/det. design

  10. Documentation and models • Models are formal representations (usually graphical) of the HAS or product • e.g. interaction, data flow, entity-relationship diagrams • Should models be produced with or after reqt. documentation? Customer- oriented Developer- oriented Models Option 1 Customer- oriented Developer- oriented Option 2 Models

  11. Customer-oriented Unambiguous In customer’s language Complete with respect to intent Developer-oriented Technically precise Consistent Complete specifications Feasible Testable Qualities of requirements documents • Both • Clear • Unambiguous • Free of “gold plating”

  12. Informal reviews Purpose: Critique and improve requirements When: Incrementally & throughout Who: Interested parties Formal reviews Purpose: Approve requirements and authorize project When: When reqts. docs. are complete Who: Owner (in SSM terms) Requirements reviews & inspections

  13. Class exercise: Requirements critique • Take the requirements document • Individually read several paragraphs carefully, looking for ambiguities • As a class, discuss: • general quality • specific issues • recommend reformulation of reqts.

  14. Requirements documentation: how to find out more • Example standards • Contained in Dorfman & Thayer’s “green” tutorial • Heavy systems engineering & DOD emphasis • IS organizations will want to water down many of these guidelines

More Related