Documents
Resources
Learning Center
Upload
Plans & pricing Sign in
Sign Out

Software design Template - DOC

VIEWS: 37 PAGES: 7

  • pg 1
									                             DataGrid
                     SOFTWARE DESIGN



                                    Document identifier:   DataGrid-xx-TED-xxxx-x-x
                                                           (if diferent than nnnn)
                                    EDMS id:

                                    Date:                  26/03/2010

                                    Work package:          WPx

                                    Document status        DRAFT




Abstract: This document provides a template for software design specification.




IST-2001-xxxxx                          INTERNAL                                      1/7
                                                                                Doc. Identifier:
                                                                     DataGrid-xx-TED-xxxx-x-x
                          SOFTWARE DESIGN
                                                                              Date: 26/03/2010




                           Document Change Record
Issue       Date               Comment                               Author
                   First draft based taking input from
0_0     18/09/01                                         Bob Jones
                   templates provided by various sources




IST-2001-xxxxx                        INTERNAL                                            2/7
                                                                                                                                                     Doc. Identifier:
                                                                                                                                    DataGrid-xx-TED-xxxx-x-x
                                                       SOFTWARE DESIGN
                                                                                                                                                  Date: 26/03/2010



                                                                         CONTENT
1. INTRODUCTION ............................................................................................................................................. 4
    1.1. OBJECTIVES OF THIS DOCUMENT................................................................................................................... 4
    1.2. APPLICATION AREA ...................................................................................................................................... 4
    1.3. APPLICABLE DOCUMENTS AND REFERENCE DOCUMENTS ............................................................................. 4
    1.4. DOCUMENT EVOLUTION PROCEDURE ............................................................................................................ 4
    1.5. TERMINOLOGY.............................................................................................................................................. 4
2. DESIGN CONSIDERATIONS ........................................................................................................................ 5
    2.1. ASSUMPTIONS AND DEPENDENCIES .............................................................................................................. 5
    2.2. GENERAL CONSTRAINTS ............................................................................................................................... 5
    2.3. OPERATING ENVIRONMENT .......................................................................................................................... 5
3. DESIGN ............................................................................................................................................................. 6
    3.1. SYSTEM DESIGN ........................................................................................................................................... 6
    3.2. SUBSYSTEM DESIGN ..................................................................................................................................... 6
       3.2.1. Subsystem N .......................................................................................................................................... 6
4. ACKNOWLEDGEMENTS .............................................................................................................................. 7




IST-2001-xxxxx                                                             INTERNAL                                                                              3/7
                                                                                               Doc. Identifier:
                                                                                    DataGrid-xx-TED-xxxx-x-x
                                 SOFTWARE DESIGN
                                                                                             Date: 26/03/2010




1. INTRODUCTION

1.1. OBJECTIVES OF THIS DOCUMENT
Summary of purpose, scope, audience, and objective for the design.
It is assumed that a design document will be written for each work package producing (i.e. developing
or packaging) software to be used in the deployed DataGrid.

1.2. APPLICATION AREA
Identify which work-package the design applies to and how it fits into the “big picture”.

1.3. APPLICABLE DOCUMENTS AND REFERENCE DOCUMENTS
DataGrid Documents:
Provide a list of DataGrid documents referenced in this document (information used for the document
configuration management).
[A1]   Applicable documents are documents of higher level such for example: Architecture document
[R1]   External document referenced in this document
External Documents:
Provide a list of external documents referenced in this document, for example:
[R2] Mark A. Baker, Geoffrey C. Fox and Hon W. Yau. NHSE ReviewTM 1996 Volume First
     Issue. Cluster Management Software.
     http://www.crpc.rice.edu/NHSEreview/CMS/index.html
[R3] Axel Keller, Alexander Reinefeld. Anatomy of a Resource Management System for HPC-
     Clusters. http://www.zib.de/PaperWeb/abstracts/ZR-00-38/

1.4. DOCUMENT EVOLUTION PROCEDURE
Explain the procedure for updating this document, for example:
The document author is the present responsible for this document, and the only person allowed to
modify it.
For comments, change proposals, change of revision of status or any modification, please contact the
author (email address).

1.5. TERMINOLOGY
Provide a list of terms used in the document and their descriptions, for example:
Open Source               A certification standard issued by the Open Source Initiative (OSI) that indicates
                          that the source code of a computer program is made available free of charge to
                          the general public.
Glossary
Provide a list of acronyms used in the document and the definitions, for example:
API                       Application Programming Interface




IST-2001-xxxxx                                INTERNAL                                                   4/7
                                                                                           Doc. Identifier:
                                                                                DataGrid-xx-TED-xxxx-x-x
                                      SOFTWARE DESIGN
                                                                                         Date: 26/03/2010




2. DESIGN CONSIDERATIONS
This chapter describes the issues that influence the design and need to be addressed or resolved before
attempting to devise a complete design solution.

2.1. ASSUMPTIONS AND DEPENDENCIES
Describe any assumptions or dependencies of the software, its use, the operational environment, or
significant project issues.

2.2. GENERAL CONSTRAINTS
Describe any global limitations or constraints that have a significant impact on the design of the
system's software (and describe the associated impact). Such constraints may be imposed by any of the
following (the list is not exhaustive):
   Hardware or software environment
   End-user environment
   Availability or volatility of resources
   Standards compliance
   Interoperability requirements
   Interface/protocol requirements
   Data repository and distribution requirements
   Security requirements (or other such regulations)
   Memory and other capacity limitations
   Performance requirements
   Network communications
   Verification and validation requirements (testing)
   Other means of addressing quality goals
   Other requirements described in the requirements specification


2.3. OPERATING ENVIRONMENT
Describe the hardware and software that the system must operate in and interact with.




IST-2001-xxxxx                                    INTERNAL                                           5/7
                                                                                              Doc. Identifier:
                                                                                   DataGrid-xx-TED-xxxx-x-x
                                  SOFTWARE DESIGN
                                                                                            Date: 26/03/2010




3. DESIGN
This chapter provides the top-level design view of the system and a basis for more detailed design in
the following sections.

3.1. SYSTEM DESIGN
This section provides a high level overview of the structural and functional decomposition of the
system. Focus on how and why the system was decomposed in a particular way rather than on details
of the particular components. Include information on the major responsibilities and roles the system
(or portions their of) must play.
Feel free to make use of design patterns, either in describing parts of the design (in pattern format), or
for referring to elements of the design that employ them.
If there are any diagrams, documented scenarios or use-cases of the system behavior and/or structure,
they may be included here (unless you feel they are complex enough to merit being placed in the
Detailed System Design section). Diagrams that describe a particular component or subsystem should
be included within the particular subsection that describes that component or subsystem.
Please use the UML notation for all diagrams. An exception being a context diagram where the system
being described appears in the middle and all the external systems appear around it..
Suggested diagrams to be included in this section are:
1 Context diagram
1 Component diagram
Sequence or collaboration diagrams showing exchanges between subsystems for important scenarios
Deployment diagram if appropriate

3.2. SUBSYSTEM DESIGN
This section provides more details of the design of each subsystem.

3.2.1. SUBSYSTEM N
Describes the design of a single subsystem.
The section may be further sub-divided if merited by the complexity of the sub-system.
Suggested diagrams to be included in this section are:
Class diagrams (for important classes only)
Sequence or collaboration diagrams showing exchanges between objects for important scenarios
Notes:
Each subsystem need not be described in the same level of detail
This section really applies only to newly developed (or yet-to-be developed) portions of the system. If
there are parts of the system that already existed before this development effort began, then you only
need to describe the pre-existing parts that the new parts of the system depend upon, and only in
enough detail sufficient to describe the relationships and interactions between the old parts and the
new parts. Pre-existing parts that are modified or enhanced need to be described only to the extent
that is necessary for the reader to gain a sufficient understanding of the nature of the changes that
were made.


IST-2001-xxxxx                                 INTERNAL                                                 6/7
                                                                                           Doc. Identifier:
                                                                                DataGrid-xx-TED-xxxx-x-x
                                 SOFTWARE DESIGN
                                                                                         Date: 26/03/2010




4. ACKNOWLEDGEMENTS
Identify all people who have contributed to the design as described in this document but are not listed
as authors.




IST-2001-xxxxx                                INTERNAL                                               7/7

								
To top