Software design description: Difference between revisions

Revision as of 15:15, 7 January 2015

Latest revision as of 10:51, 27 August 2025

(43 intermediate revisions by 29 users not shown)

Line 1:

{{Short description|Written design description of a software product}}

{{Multiple issues|

{{See also|Game design document}}

{{refimprove|date=September 2014}}

{{cleanup|date=July 2010}}

}}

{{IEEE software documents}}

A '''software design description''' (a.k.a. '''software design document''' or '''SDD'''; just '''design document'''; also [[Software Design Specification]]) is a representation of a software design that is to be used for recording design information, addressing various design concerns, and communicating that information to the design’s stakeholders. <ref>{{Cite book|title=IEEE Standard for Information Technology--Systems Design--Software Design Descriptions|publisher=IEEE STD 1016-2009|date=July 2009|pages=1–35|doi=10.1109/ieeestd.2009.5167255|isbn=978-0-7381-5925-6 }}</ref> An SDD usually accompanies an architecture diagram with pointers to detailed feature specifications of smaller pieces of the design. Practically, the description is required to coordinate a large team under a single vision, needs to be a stable reference, and outline all parts of the software and how they will work.

'''IEEE 1016-2009''', titled ''IEEE Standard for Information Technology—Systems Design—Software Design Descriptions'',<ref name="IEEE1016">{{cite web|url=http://ieeexplore.ieee.org/stamp/stamp.jsp?tp=&arnumber=5167255&isnumber=5167254 |title=IEEE Standard for Information Technology — Systems Design — Software Design Descriptions |publisher=IEEE |date=2009-07-20 |accessdate=2014-07-06}}</ref> is an [[IEEE]] standard that specifies "the required information content and organization" for a '''software design description''' ('''SDD'''). [IEEE 1016, ''Abstract''].

IEEE 1016 does not specify the medium of an SDD; it is "applicable to automated databases and design description languages but can be used for paper documents and other means of descriptions." [IEEE 1016, ''Abstract'']

==Composition==

The 2009 edition was a major revision to IEEE 1016-1998, elevating it from recommended practice to full standard.

The SDD usually contains the following information:

This revision was modeled after [[IEEE 1471|IEEE Std 1471-2000]], ''Recommended Practice for Architectural Description of Software-intensive Systems'',

extending the concepts of [[IEEE 1471#IEEE Conceptual Framework for Architecture Description|view, viewpoint, stakeholder, and concern]] from architecture description to support documentation of high-level and detailed design and construction of software. [IEEE 1016, ''Introduction'']

#The ''Data-driven design'' describes structures that reside within the software. Attributes and relationships between [[data object]]s dictate the choice of [[data structures]].

Following the IEEE 1016 conceptual model, an SDD is organized into one or more design views. Each design view follows the conventions of its design viewpoint. IEEE 1016 defines the following design viewpoints for use [IEEE 1016, Clause 5]:

#The ''[[Software architecture|architecture design]]'' uses information flowing characteristics, and maps them into the program structure. The transformation mapping method is applied to exhibit distinct boundaries between incoming and outgoing data. The data flow diagrams allocate control input, processing and output along three separate modules.

#The ''[[Interface (computing)|interface design]]'' describes internal and external program interfaces, as well as the design of the [[User interface design|human interface]]. Internal and external interface designs are based on the information obtained from the analysis model.

#The ''[[procedural design]]'' describes structured programming concepts using graphical, tabular and textual notations.

These design mediums enable the designer to represent procedural detail, that facilitates translation to code. This blueprint for implementation forms the basis for all subsequent software engineering work.

== IEEE 1016 ==

'''IEEE 1016-2009''', titled ''IEEE Standard for Information Technology—Systems Design—Software Design Descriptions'',<ref name="IEEE1016">{{cite webbook|urlpublisher=http://ieeexploreIEEE |date=2009-07-20 |doi=10.ieee.org1109/stamp/stampIEEESTD.2009.jsp?tp=&arnumber=5167255&isnumber=5167254 |isbn=978-0-7381-5925-6 |title=IEEE Standard for Information Technology — --Systems Design — --Software Design Descriptions |publisher=IEEE |date=2009-07-20 |accessdate=2014-07-06}}</ref> is an [[IEEE]] standard that specifies "the required information content and organization" for aan SDD.<ref>IEEE 1016, ''Abstract'software'.</ref> IEEE 1016 does not specify the medium of an SDD; it is "applicable to automated databases and design description''' ('''SDD''').languages [but can be used for paper documents and other means of descriptions."<ref>IEEE 1016, ''Abstract'']. </ref>

The 2009 edition was a major revision to IEEE 1016-1998, elevating it from recommended practice to full standard. This revision was modeled after [[IEEE 1471|IEEE Std 1471-2000]], ''Recommended Practice for Architectural Description of Software-intensive Systems'', extending the concepts of [[IEEE 1471#IEEE Conceptual Framework for Architecture Description|view, viewpoint, stakeholder, and concern]] from architecture description to support documentation of high-level and detailed design and construction of software. [IEEE 1016, ''Introduction'']

Following the IEEE 1016 conceptual model, an SDD is organized into one or more design views. Each design view follows the conventions of its design viewpoint. IEEE 1016 defines the following design viewpoints for use [:<ref>IEEE 1016, Clause 5]:.</ref>

*Context viewpoint

*Composition viewpoint

Line 25 ⟶ 32:

*Algorithm viewpoint

*Resource viewpoint

In addition, users of the standard are not limited to these viewpoints but may define their own. [<ref>IEEE 1016, sub-clause 4.5].</ref>

== IEEE status ==

''Annex C'' of the standard provides the following (optional) template outline for SDDs:

IEEE 1016-2009 is currently listed as 'Inactive - Reserved'.<ref>{{cite book | doi = 10.1109/IEEESTD.2009.5167255| title = IEEE Standard for Information Technology--Systems Design--Software Design Descriptions| publisher = IEEE STD 1016-2009| date = July 2009| pages = 1–35| isbn = 978-0-7381-5925-6}}</ref>

*Frontspiece

**Date of issue and status

**Issuing organization

**Authorship

**Change history

*Introduction

**Purpose

**Scope

**Context

**Summary

*References

*Glossary

*Body

**Identified stakeholders and design concerns

**Design viewpoint 1

**Design view 1

*** ...

**Design viewpoint n

**Design view n

**Design rationale

==External linksSee also ==

* [[Game design document]]

*[http://www.iso-architecture.org/ieee-p1016/ IEEE 1016 website]

* [[High-level design]]

*{{cite doi|10.1109/IEEESTD.1987.122643}}

* [[Low-level design]]

*{{cite doi|10.1109/IEEESTD.1998.88828}}

*{{cite doi|10.1109/IEEESTD.2009.5167255}}

==References==

{{Reflist}}

==External links==

{{IEEE standards}}

*[http://www.iso-architecture.org/ieee-p1016/ IEEE 1016 website]

{{Design}}

{{IEEE standards}}

[[Category:Software design]]