Design Documentation

Introduction to Design Documentation

An important product of the design  process is a set  of documents  that  describe the system  to be built. Our part  must  tell what the system will do and the other part will  describe the technical terminology to describe the  system structure data and functions. The design documents should conation a section, called the design rationale outlining  the critical issues and trade off that were considered in generating the design. This guiding physiology  helps the customers and other developers to understand how to and why certain parts of the design fit  together.

The design also contains description of the components  of the system. One  section should  address how the users interact with  the system  including the  followings:

  • Menus and other display screen formats.
  • Human interfaces function keys touch screen descriptions etc.
  • Report formats.
  • Input - where data come from how they are formatted and on what media they are stored.
  • Output- where data are sent how they are formatted and on what media they are stored.
  • General functional characteristics
  • Performance constraints .
  • Archival procedure.
  • Fault- handling approach.
  • Usually a set of diagrams or formal notations describe the overall organization and structure of the system including all levels of abstraction.
  • The design document outline is as in table 5.2.

1. Scope

Much  of the  information  contained in scope is derived  from the system  specification and  other software definition phase documents.

2. Reference Documents

They are specific documents  to support documentation.

3.Design Description

Design description is  completed  as part of the preliminary design. Design is information driven that  is the flow  and structure  of data will dictate the architecture of software. Data  flow diagram or other data representation developed during  requirements analysis are refined and used to derive software structure.

4. 4 and 5 Modules for Each Module

In section 4 file structure and global data evolve as preliminary design  moves into detail design. Modules separately addressable elements  of software such as subroutines or functions  are initially described with  an English  language processing narrative. The processing narrative explains the procedural function of a module.

In  section 5 a description of data  organization is contained. File structures maintained on  secondary storage media are described during  preliminary design global data are assigned and a cross reference that associates individual modules to files or global  data is  established.

6. Requirements cross reference

Design specification contains a requirements  reference matrix. The purpose of this matrix.

To establish  that all requirements are satisfied by the software design.

To indicate which modules are critical to the  implementation of specific requirements .

7. Test Provisions

The first stage in the development  of test procedures is  contained in this section. Once software structure and interfaces have been  established, we can develop guidelines for testing  of individual modules  and the integration of the  entire package.

8. Section  Package

Requirement  and consideration for  software packaging are presented in this  section. Secondarily it describe the approach that  will be  used to transfer software to customer site.

9. Special Notes and Appendices:

It contain supplementary data  algorithm description, alternative   procedures, tabular data  and other  relevant  information that  presented as a special note or as a separate appendix. It may  be advisable  to develop a preliminary  operations Installation Manual and  in clued it as an appendix to the design  document.

If  the system  is distributed the configuration in the design is detailed enough to show  theology of the network, how the  network nodes will access one another and the  allocation of  functions to the nodes. If the system  requirements  include constraints of timing or if the nodes of the network must be  synchronized the design  describes  how the timing will work. Similarly the design  contains information about  the control  and routing  of messages. It may also  include desecration for the integrity of the  network  making sure that the  data are accurate or  can be recovered after a failure.

If the customer requires elements of the design  may address monitoring  system performance. In addition there may be a manual override of the system  and the design  describes  how it will work. Finally the design  is cross referenced with  the requirements   to demonstrate how  the design is derived from them. This correspondence forces us to  check for completeness and consistency.  And such  a cross reference will make enhancements or modifications  easier to track later. For example if a requirements changes, the  cross reference points to the corresponding  design  changes needed.

Latest technology based Software Engineering Online Tutoring Assistance

Tutors, at the www.tutorsglobe.com, take pledge to provide full satisfaction and assurance in Design Documentation homework help via online tutoring. Students are getting 100% satisfaction by online tutors across the globe. Here you can get homework help for Design Documentation, project ideas and tutorials. We provide email based Design Documentation homework help. You can join us to ask queries 24x7 with live, experienced and qualified online tutors specialized in Design Documentation. Through Online Tutoring, you would be able to complete your homework or assignments at your home. Tutors at the TutorsGlobe are committed to provide the best quality online tutoring assistance for Software Engineering homework help and assignment help services. They use their experience, as they have solved thousands of the software engineering assignments, which may help you to solve your complex issues of Design Documentation. TutorsGlobe assure for the best quality compliance to your homework. Compromise with quality is not in our dictionary. If we feel that we are not able to provide the homework help as per the deadline or given instruction by the student, we refund the money of the student without any delay.

©TutorsGlobe All rights reserved 2022-2023.