System Design Description template

Size: px

Start display at page:

Download "System Design Description template"

Randall Sullivan
9 years ago
Views:

1 Document Template Document Number ESS Date Jul 16, 2014 Revision 1 State Released System Design Description template Authors Reviewers Approver Name Affiliation European Spallation Source ESS AB Visiting address: ESS, Tunavägen 24 P.O. Box 176 SE Lund SWEDEN

2 TABLE OF CONTENT Table of content Introduction Purpose of the document Definitions, acronyms and abbreviations References System characteristics System purpose System overview Hardware description Mechanical design Structural design Fluid mechanical design CAD references Electrical design Instrumentation design Software description Safety design Equipment design Packaging Handling Storage Transportation...5 2(6)

3 1. INTRODUCTION 1.1 Purpose of the document <The system Design Description of the X describes how this system is to be built. It takes the functional requirements [what the system will do], concepts of operations [how the system will be used] and translates them into a hardware and software descriptions that can be built while considering constraints [interface specification, safety and regulatory requirements, other constraint requirements]. Collectively, the purpose of these documents is to: Provide a documented description of the design of the system that can be reviewed and approved by the stakeholders during a critical design review, Provide a description of the system in enough detail that its component parts can be procured and built ( built-to ), Provide a description of the hardware and software system components in sufficient detail for them to be maintained and upgraded, This document addresses the design from various disciplines: mechanical, electrical, thermal, and/or plasma/particle beams aspects. This document contains design descriptions and refers to other design specifications as needed. In this respect, it is the entry point for identifying all design specifications. When the design description is the result of an analysis identified as a verification activity for the system, the description shall mention the concerned set of requirement by their Id and the related Verification Plan and Verification Report (use section References ).> 1.2 Definitions, acronyms and abbreviations Abbreviation Explanation of abbreviation XXX Xxxxxx XXX Xxxxxx <<>> <<>> 1.3 References <Please input relevant text that pertains to the above subject matter > 2. SYSTEM CHARACTERISTICS 2.1 System purpose < This short section gives a brief overview of the main functions of system to be built. It is a high-level description.> 2.2 System overview < This is an overview of the system to be developed. This describes what it interfaces with, its states and modes, and the system architecture. Note that the system architecture is not a design [that will be 3(6)

4 done later].> 3. HARDWARE DESCRIPTION 3.1 Mechanical design Structural design <Please input relevant text that pertains to the above subject matter > Fluid mechanical design <Please input relevant text that pertains to the above subject matter like cooling > CAD references < This section completes the description of the hardware components. It contains a detailed list of the exact hardware items to be procured by name, part number, manufacturer, and quantity. If necessary, it lists any hardware component specifications or drawings which have been prepared by the design team.> 3.2 Electrical design <Please input relevant text that pertains to the above subject matter like electrical architecture, radio frequency design, > 3.3 Instrumentation design <Please input relevant text that pertains to the above subject matter like control systems design, front end electronics and sensors > 4. SOFTWARE DESCRIPTION <This section completes the description of the software components. It contains a detailed list of the COTS software products to be procured, by vendor, name, part number, and options. If the project involves custom software applications, this section could become the dominant and largest part of this document. Its purpose is to provide enough information so the code can be developed. Subsequently, so the code can be understood for maintenance and system upgrades. As a result, the overriding requirement is that the descriptions of the software components are complete and the link between these descriptions and the actual source code is clear and explicit. If a software design tool is used, it may produce most of the Detailed Design Specification required in this document. For example, if an object oriented software design methodology is to be used, the description of the custom software components would include: Class description for significant internal and external classes necessary to implement the functional requirements, Description of each class attributes, methods, and relationships, Class diagrams and other diagramming methods as appropriate, such as: sequence, package, activity concurrency, and state diagrams 4(6)

5 Component diagrams to describe the physical partitioning of the software into code components Descriptions of common patterns to be used in the software design, such as, the pattern to be used for inter-process communication, or for implementation of an operator interface> 5. SAFETY DESIGN <Please input the features specifically designed to enhance the safety. This applies for hardware and software components.> 6. EQUIPMENT DESIGN <if applicable> 6.1 Packaging <This section contains a detailed list of the exact packaging items to be procured by name, part number, manufacturer, and quantity. If necessary, it lists any hardware component specifications or drawings which have been prepared by the design team.> 6.2 Handling <This section completes the description of the handling components. It contains a detailed list of the exact hardware items to be procured by name, part number, manufacturer, and quantity. If necessary, it lists any hardware component specifications or drawings which have been prepared by the design team.> 6.3 Storage <This section completes the description of the components for supporting the storage. It contains a detailed list of the exact hardware items to be procured by name, part number, manufacturer, and quantity. If necessary, it lists any hardware component specifications or drawings which have been prepared by the design team.> 6.4 Transportation <This section completes the description of the components for supporting the transportation. It contains a detailed list of the exact hardware items to be procured by name, part number, manufacturer, and quantity. If necessary, it lists any hardware component specifications or drawings which have been prepared by the design team.> 5(6)

6 6(6)

Appendix <<1>> System Status Report for System template

Appendix <<1>> System Status Report for System template Document Template Document Number ESS-0004799 Date Sep 3, 2013 Revision 1 (2) State Preliminary Appendix System Status Report for System template Authors Reviewers Approver Name Affiliation European