Research

Sep 1, 2012 Ξ Comments are off

Design Documents

posted by Tenneti

The system architect or the software designer prepares the design document that describes the product in detail. It acts as a beginning point for the product development team. These documents help in providing a broad vision to all the teams involved in product development.

Design documents are classified either as high level and low level design documents or functional and technical design documents.

However, the typical sections in a design document include the following:

  1. The basic architecture of the system – lists out the components and the logical and informational flow between the various components. It is normally depicted in the form of an architecture diagram or a table.
  2. The interface elements of the system – details the various interfaces including the human interface to the system.
  3. The procedural design of the system – explains the programming constructs such as the procedures, methods, and references that are necessary to build the system. This is typical to the software development process.

Information from the design documents can be used for various end user documents such as the following:

  • User’s Guide –- The detailed technical specifications, the list of features and their explanation can be used to prepare and update the User’s Guide.
  • Online Help -– The features and the interrelationship between the various components can be used to prepare or update the Online Help.
  • Installation manuals -– The detailed technical specifications, the components of the system, and the details to begin using the system can be used to prepare or update the installation or configuration manuals.
  • API documentation -– The high-level technical information such as the procedural elements and programming constructs can be used to prepare and update the API deliverables.

Share This

Comments are closed.

Log in with:

Subscribe to our Newsletter

To subscribe to Techitive newsletter simply add your email below. A confirmation email will be sent to you!

Tweets

Resources

Understanding Source Documents – E-Book

Understanding Source Documents - E-Book

July 24th, 2013

Techitive Press presents the second E-Book for ready reference - Understanding Source Documents. [...]

E-Book – Technical Writing Process – An Overview

E-Book - Technical Writing Process - An Overview

July 15th, 2013

Techitive Press presents small E-Books for ready reference. [...]

Understanding articles

Understanding articles

September 22nd, 2012

[...]

Self Review Checklist

Self Review Checklist

September 16th, 2012

Grammar Verify the text for spelling mistakes and typographical errors. Verify the text fo[...]

Search on Techitive

Subscribe on Facebook