Ieee recommended Practice for Software Design Descriptions




Yüklə 323.79 Kb.
səhifə1/3
tarix29.02.2016
ölçüsü323.79 Kb.
  1   2   3
IEEE Std 1016-1998

(Revision of

IEEE Std 1016-1987)


IEEE Recommended Practice for

Software Design Descriptions

Sponsor
Software Engineering Standards Committee of the



IEEE Computer Society

Approved 23 September 1998



IEEE-SA Standards Board

Abstract: The necessary information content and recommendations for an organization for Software Design Descriptions (SDDs) are described. An SDD is a representation of a software system that is used as a medium for communicating software design information. This recommended practice is applicable to paper documents, automated databases, design description languages, or other means of description. Keywords: software design, software design description, software life cycle process

The Institute of Electrical and Electronics Engineers, Inc.

345 East 47th Street, New York, NY 10017-2394, USA
Copyright © 1998 by the Institute of Electrical and Electronics Engineers, Inc.

All rights reserved. Published 4 December 1998. Printed in the United States of America.


Print: ISBN 0-7381-1455-3 SH94688

PDF: ISBN 0-7381-1456-1 SS94688


No part of this publication may be reproduced in any form, in an electronic retrieval system or otherwise, without the prior written permission of the publisher.

Authorized licensed use limited to: INDIAN INSTITUTE OF TECHNOLOGY BOMBAY. Downloaded on May 31,2013 at 12:18:46 UTC from IEEE Xplore. Restrictions apply.



IEEE Standards documents are developed within the IEEE Societies and the Standards Coordinating Committees of the IEEE Standards Association (IEEE-SA) Standards Board. Members of the committees serve voluntarily and without compensation. They are not necessarily members of the Institute. The standards developed within IEEE represent a consensus of the broad expertise on the subject within the Institute as well as those activities outside of IEEE that have expressed an interest in participating in the development of the standard.
Use of an IEEE Standard is wholly voluntary. The existence of an IEEE Standard does not imply that there are no other ways to produce, test, measure, purchase, market, or provide other goods and services related to the scope of the IEEE Standard. Furthermore, the viewpoint expressed at the time a standard is approved and issued is subject to change brought about through developments in the state of the art and comments received from users of the standard. Every IEEE Standard is subjected to review at least every five years for revision or reaffirmation. When a document is more than five years old and has not been reaffirmed, it is reasonable to conclude that its contents, although still of some value, do not wholly reflect the present state of the art. Users are cautioned to check to determine that they have the latest edition of any IEEE Standard.
Comments for revision of IEEE Standards are welcome from any interested party, regardless of membership affiliation with IEEE. Suggestions for changes in documents should be in the form of a proposed change of text, together with appropriate supporting comments.
Interpretations: Occasionally questions may arise regarding the meaning of portions of standards as they relate to specific applications. When the need for interpretations is brought to the attention of IEEE, the Institute will initiate action to prepare appropriate responses. Since IEEE Standards represent a consensus of all concerned interests, it is important to ensure that any interpretation has also received the concurrence of a balance of interests. For this reason, IEEE and the members of its societies and Standards Coordinating Committees are not able to provide an instant response to interpretation requests except in those cases where the matter has previously received formal consideration.

Comments on standards and requests for interpretations should be addressed to: Secretary, IEEE-SA Standards Board



445 Hoes Lane

P.O. Box 1331

Piscataway, NJ 08855-1331

USA


Note: Attention is called to the possibility that implementation of this standard may require use of subject matter covered by patent rights. By publication of this standard, no position is taken with respect to the existence or validity of any patent rights in connection therewith. The IEEE shall not be responsible for identifying patents for which a license may be required by an IEEE standard or for conducting inquiries into the legal validity or scope of those patents that are brought to its attention.
Authorization to photocopy portions of any individual standard for internal or personal use is granted by the Institute of Electrical and Electronics Engineers, Inc., provided that the appropriate fee is paid to Copyright Clearance Center. To arrange for payment of licensing fee, please contact Copyright Clearance Center, Customer Service, 222 Rosewood Drive, Danvers, MA 01923 USA; (978) 750-8400. Permission to photocopy portions of any individual standard for educational classroom use can also be obtained through the Copyright Clearance Center.

Authorized licensed use limited to: INDIAN INSTITUTE OF TECHNOLOGY BOMBAY. Downloaded on May 31,2013 at 12:18:46 UTC from IEEE Xplore. Restrictions apply.



Introduction
(This introduction is not a part of IEEE Std 1016-1998, IEEE Recommended Practice for Software Design Descriptions.)
Purpose
This recommended practice specifies the necessary information content and recommends an organization for Software Design Descriptions (SDDs). This document does not explicitly support, nor is it limited to, any particular software design methodology or descriptive technology. It will guide the production of anything from paper design documents to an automated database of design information. For an organization in the process of developing a design description standard, use of this document will help the new standard meet the needs of all of its users. For an organization with a mature design description standard, it should prove useful in evaluating and modifying that standard in light of the informational and organizational needs of the design description user community.
This practice can be applied to commercial, scientific, and military software. Applicability is not restricted by size, complexity, or criticality of the software. This practice considers both the software and its system operational environment. It can be used where software is the system or where software is part of a larger system that is characterized by hardware and software components and their interfaces.
Overview
This document consists of six clauses. Clause 1 defines the scope of the recommended practice and Clause 2 references other standards that should be followed when applying this practice. Clause 3 provides definitions of terms within the context of the practice. Clause 4 places the SDD into the framework of the software development life cycle. Clause 5 describes the minimum information that shall be included in an SDD and Clause 6 gives a recommended organization for SDDs. Annex A shows a sample table of contents for an SDD. Annex B provides guidelines for using this standard to meet the requirments of IEEE/EIA 12207.1-1997, IEEE/EIA Guide for Information Technology— Software life cycle processes—Life cycle data.
Audience
This document is intended for those in technical and managerial positions who prepare and use SDDs. It will guide a designer in the selection, organization, and presentation of design information. It will help standards developers ensure that a design description is complete, concise, and well organized.
SDDs play a pivotal role in the development and maintenance of software systems. During its lifetime, a given design description is used by project managers, quality assurance staff, configuration managers, software designers, programmers, testers, and maintainers. Each of these users has unique needs, both in terms of required design information and optimal organization of that information. Hence, a design description must contain all the design information needed by those users.
Terminology
This recommended practice follows the IEEE Standards Style Manual. In particular, the word shall and the imperative form identify mandatory material within the recommended practice. The words should, might, and may identify advisory material.
Limitations
This standard assumes a functional decomposition approach to design understanding. This may limit its utility with object-oriented approaches.

Copyright © 1998 IEEE. All rights reserved. iii

Authorized licensed use limited to: INDIAN INSTITUTE OF TECHNOLOGY BOMBAY. Downloaded on May 31,2013 at 12:18:46 UTC from IEEE Xplore. Restrictions apply.



History
The project authorization request (PAR) for development of this recommended practice was approved by the IEEE Standards Board on 22 September 1983. Modification of the authorization request to change the title and scope was approved on 13 March 1986. A series of 10 meetings were held within the United States and internationally between March 1983 and March 1986. These meetings produced the draft submitted for balloting in April 1986. The first edition of this recommended practice was approved by the IEEE Standards Board on 12 March 1987 and reaffirmed on

2 December 1993. The PAR for this revision, which added a new Annex B, was approved by the IEEE Standards Board on 16 September 1997.


Suggestions for the improvement of this practice will be welcome. They should be sent to
Secretary

IEEE-SA Standards Board

Institute of Electrical and Electronics Engineers, Inc.

445 Hoes Lane

P.O. Box 1331

Piscataway, NJ 08855-1331


Original contributors
This document was originally developed by the Software Design Description Working Group of the Software Engineering Standards Subcommittee of the IEEE Computer Society. The Software Design Description Working Group Steering Committee had the following members:
H. Jack Barnard, Chair James A. Darling, Vice Chair Robert F. Metz, Secretary


Chris Beall Patricia Cox Leo Endres

H. Gregory Frank Manoochehr Ghiassi Daniel E. Klingler

John McArdle Arthur L. Price Basil Sherlund



The Software Design Description Working Group had the following members:


Frank Ackerman Jim Anderson Sandro Bologna Fletcher Buckley Lori J. Call

Wan P. Chiang François Coallier Cliff Cockerham Patricia W. Daggett Jim DeLeo

Cammie Donaldson Euiar Dragstedt Laurence E. Fishtahler David Gelperin

Yair Gershkovitch

Tom Gilb

Shirley A. Gloss-Soler Larry J. Hardouin Fredrick Ho

David M. Home William S. Junk Laurel Kaleda Tom Kurihara Jim Lemmon

F. C. Lim

Oyvind Lorentzen

Bert Martin

Lindsay McDermid

Glen Meldrum

Walter Merenda Randy Peterson Robert Poston Ian C. Pyle

Ann S. Ping Hans Schaefer David Schultz David Siefert Peter Smith

Richard H. Thayer

T. H. Tse David Weiss Charles J. Wertz G. Robert Zambs





iv Copyright © 1998 IEEE. All rights reserved.

Authorized licensed use limited to: INDIAN INSTITUTE OF TECHNOLOGY BOMBAY. Downloaded on May 31,2013 at 12:18:46 UTC from IEEE Xplore. Restrictions apply.



The following persons were on the balloting committee of the 1998 revision of the recommended practice:


Syed Ali

Theodore K. Atchinson Mikhail Auguston Robert E. Barry

H. Ronald Berlack Richard E. Biehl Sandro Bologna Juris Borzovs Kathleen L. Briggs M. Scott Buck Michael Caldwell James E. Cardow Enrico A. Carrara

Lawrence Catchpole

Keith Chan Antonio M. Cicu Theo Clarke Sylvain Clermont

Rosemary Coleman

Virgil Lee Cooper

W. W. Geoff Cozens

Paul R. Croll Patricia W. Daggett Gregory T. Daich Taz Daughtrey Bostjan K. Derganc Perry R. DeWeese James Do

Evelyn S. Dow

Carl Einar Dragstedt Charles Droz Sherman Eagles

Leo Egan


Richard L. Evans Richard E. Fairley John W. Fendrich Jay Forster Richard C. Fries Roger U. Fujii Adel N. Ghannam

Marilyn Ginsberg-Finner

John Garth Glynn

Julio Gonzalez-Sanz

L. M. Gunther David A. Gustafson Jon D. Hagar

John Harauz Herbert Hecht William Hefley Manfred Hein Mark Heinrich Debra Herrmann

Umesh P. Hiriyannaiah

John W. Horch Peter L. Hung George Jackelen Frank V. Jorgensen

Vladan V. Jovanovic

William S. Junk Ron S. Kenett Judith S. Kerner Robert J. Kierzyk Shaye Koenig

Thomas M. Kurihara

John B. Lane

J. Dennis Lawrence

Randal Leavitt Fang Ching Lim William M. Lively Dieter Look

John Lord Stan Magee David Maibor Harold Mains Robert A. Martin

Tomoo Matsubara Mike McAndrew Patrick D. McCray Sue McGrath Jacques Meekel James Bret Michael Alan Miller

Celia H. Modell James W. Moore Pavol Navrat

Myrna L. Olson Indradeb P. Pal Alex Polack Peter T. Poon

Lawrence S. Przybylski

Kenneth R. Ptack Ann E. Reedy Annette D. Reilly Dennis Rilling Andrew P. Sage Helmut Sandmayr Stephen R. Schach

Norman Schneidewind

David J. Schultz Lisa A. Selmon Robert W. Shillato David M. Siefert Carl A. Singer Nancy M. Smith Luca Spotorno Julia Stesney

Fred J. Strauss Sandra Swearingen Toru Takeshita Richard H. Thayer Booker Thomas Patricia Trellue

Theodore J. Urbanowicz

Glenn D. Venables

Udo Voges Ronald L. Wade David D. Walden Delores Wallace William M. Walsh John W. Walz

Camille S. White-Partain

Scott A. Whitmire P. A. Wolfgang Paul R. Work Zhou Zhi Ying Janusz Zalewski

Geraldine Zimmerman

Peter F. Zoll




Copyright © 1998 IEEE. All rights reserved. v

Authorized licensed use limited to: INDIAN INSTITUTE OF TECHNOLOGY BOMBAY. Downloaded on May 31,2013 at 12:18:46 UTC from IEEE Xplore. Restrictions apply.



The final conditions for approval of this standard were met on 23 September 1998. This standard was conditionally approved by the IEEE Standards Board on 16 September 1998, with the following membership:
Richard J. Holleman, Chair

Donald N. Heirman, Vice Chair Judith Gorman, Secretary


Satish K. Aggarwal Clyde R. Camp James T. Carlo

Gary R. Engmann Harold E. Epstein Jay Forster* Thomas F. Garrity Ruben D. Garzon James H. Gurney

Jim D. Isaak Lowell G. Johnson Robert Kennelly

E. G. “Al” Kiener Joseph L. Koepfinger* Stephen R. Lambert Jim Logothetis

Donald C. Loughry

L. Bruce McClung

Louis-François PauRonald C. Petersen Gerald H. Peterson John B. Posey

Gary S. Robinson Hans E. Weinrich Donald W. Zipse




*Member Emeritus
Kristin Dittmann

IEEE Standards Project Editor

vi Copyright © 1998 IEEE. All rights reserved.

Authorized licensed use limited to: INDIAN INSTITUTE OF TECHNOLOGY BOMBAY. Downloaded on May 31,2013 at 12:18:46 UTC from IEEE Xplore. Restrictions apply.



Contents
1. Scope ...................................................................................................................................................................1
2. References ...........................................................................................................................................................1
3. Definitions...........................................................................................................................................................2
4. Considerations for producing an SDD ................................................................................................................2
4.1 Software life cycle ..................................................................................................................................... 2

4.2 SDD within the life cycle ........................................................................................................................... 2

4.3 Purpose of an SDD..................................................................................................................................... 2
5. Design description information content ..............................................................................................................3
5.1 Introduction ................................................................................................................................................ 3

5.2 Design entities ............................................................................................................................................ 3

5.3 Design entity attributes .............................................................................................................................. 3
6. Design description organization..........................................................................................................................5
6.1 Introduction ................................................................................................................................................ 5

6.2 Design views .............................................................................................................................................. 6


Annex A (Informative) Sample table of contents for an SDD.....................................................................................10
Annex B (Informative) Guidelines for compliance with IEEE/EIA 12207.1-1997.....................................................11

Copyright © 1998 IEEE. All rights reserved. vii

Authorized licensed use limited to: INDIAN INSTITUTE OF TECHNOLOGY BOMBAY. Downloaded on May 31,2013 at 12:18:46 UTC from IEEE Xplore. Restrictions apply.



IEEE Recommended Practice for

Software Design Descriptions

1. Scope

This is a recommended practice for describing software designs. It specifies the necessary information content, and recommended organization for a Software Design Description (SDD). An SDD is a representation of a software system that is used as a medium for communicating software design information.

The practice may be applied to commercial, scientific, or military software that runs on any digital computer. Applicability is not restricted by the size, complexity, or criticality of the software.

This practice is not limited to specific methodologies for design, configuration management, or quality assurance. It is assumed that the quality design information and changes to the design of description will be managed by other project activities. Finally, this document does not support nor is it limited to any particular descriptive technique. It may be applied to paper documents, automated databases, design description languages, or other means of description.




2. References

This standard shall be used in conjunction with the following publications:


IEEE Std 610.12-1990, IEEE Standard Glossary of Software Engineering Terminology.1

IEEE Std 730-1998, IEEE Standard for Software Quality Assurance Plans.

IEEE Std 828-1998, IEEE Standard for Software Configuration Management Plans.

IEEE Std 830-1998, IEEE Recommended Practice for Software Requirements Specifications.



Freeman, P. and A. I. Wasserman, Tutorial on Software Design Techniques. 4th Edition, IEEE Computer Society Press, Annotated Bibliography, pp. 715–718, 1983.
1IEEE publications are available from the Institute of Electrical and Electronics Engineers, 445 Hoes Lane, P.O. Box 1331, Piscataway, NJ 08855-

1331, USA (http://standards.ieee.org/).


Copyright © 1998 IEEE. All rights reserved. 1

Authorized licensed use limited to: INDIAN INSTITUTE OF TECHNOLOGY BOMBAY. Downloaded on May 31,2013 at 12:18:46 UTC from IEEE Xplore. Restrictions apply.

IEEE

Std 1016-1998 IEEE RECOMMENDED PRACTICE FOR



3. Definitions

The definitions listed here establish meaning in the context of this recommended practice. Definitions of other terms used in this document can be found in IEEE Std 610.12-19902.



3.1 design entity: An element (component) of a design that is structurally and functionally distinct from other elements and that is separately named and referenced.
3.2 design view: A subset of design entity attribute information that is specifically suited to the needs of a software project activity.
3.3 entity attribute: A named characteristic or property of a design entity. It provides a statement of fact about the entity.
3.4 software design description (SDD): A representation of a software system created to facilitate analysis, planning, implementation, and decision making. A blueprint or model of the software system. The SDD is used as the primary medium for communicating software design information.

  1   2   3


Verilənlər bazası müəlliflik hüququ ilə müdafiə olunur ©azrefs.org 2016
rəhbərliyinə müraciət

    Ana səhifə