CERN
CH-1211 Geneva 23 Switzerland
the
LHC Project Document No.
LHC-AB-CO-xxxx rev 0.2
CERN Div./Group or Supplier/Contractor Document No.
AB-CO
EDMS Document No.
Large Hadron Collider
project
yyyyyy
Date: 16-NOV-08
Functional Specification
THE WIRE SCANNER APPLICATION SOFTWARE DESIGN SPECIFICATIONS
Abstract The design specifications for the Wire Scanner Software Application are listed, described and explained here.
Prepared by :
Checked by :
Approved by:
E. McCrory, Fermilab D. Nicklaus, Fermilab M. Lamont AB/OP
R. Alemany, AB/CO G. Arduini, AB/ABP G. Crockford, AB/OP J-J. Gras, AB/BI L. Ponce, AB/OP J. Wenninger, AB/OP T. Bolshakov, Fermilab S. Gysin, Fermilab D. McGinnis, Fermilab J. Patrick, Fermilab
R. Bailey, AB/OP R. Jones, AB/BI H. Schmickler, AB/CO
LHC Project Document No.
LHC-AB-CO-xxxx rev 0.2
Page 2 of 5
Table of Contents
1. INTRODUCTION ............................................................................................................................................ 2 1.1. DOCUMENT OUTLINE.................................................................................................................... 2 1.2. DOCUMENT DESCRIPTION ............................................................................................................. 2 1.2.1. Introduction............................................................................................................................. 3 1.2.2. System Overview ..................................................................................................................... 3 2. DESIGN CONSIDERATIONS ....................................................................................................................... 3 2.1. 2.2. 2.3. 2.4. 3. 4. ASSUMPTIONS AND DEPENDENCIES .............................................................................................. 3 GENERAL CONSTRAINTS ............................................................................................................... 3 GOALS AND GUIDELINES .............................................................................................................. 3 DEVELOPMENT METHODS ............................................................................................................ 3
ARCHITECTURAL STRATEGIES .............................................................................................................. 4 SYSTEM ARCHITECTURE .......................................................................................................................... 4 4.1. SUBSYSTEM ARCHITECTURE......................................................................................................... 4
5. 6.
POLICIES AND TACTICS ............................................................................................................................. 4 DETAILED SYSTEM DESIGN...................................................................................................................... 4 6.1. 6.2. 6.3. 6.4. 6.5. 6.6. 6.7. 6.8. 6.9. 6.10. CLASSIFICATION ........................................................................................................................... 4 DEFINITION ................................................................................................................................... 4 RESPONSIBILITIES ......................................................................................................................... 4 CONSTRAINTS ............................................................................................................................... 5 COMPOSITION ............................................................................................................................... 5 USES/INTERACTIONS .................................................................................................................... 5 RESOURCES .................................................................................................................................. 5 PROCESSING ................................................................................................................................. 5 INTERFACE/EXPORTS .................................................................................................................... 5 DETAILED SUBSYSTEM DESIGN .................................................................................................... 5
7. 8.
GLOSSARY ...................................................................................................................................................... 5 BIBLIOGRAPHY ............................................................................................................................................ 5
1. Introduction
Blah blah in separate documents.
1.1. Document Outline
Here is the outline of this thing. Blah, blah.
1.2. Document Description
Here is the description of the contents (by section and subsection):
LHC Project Document No.
LHC-AB-CO-xxxx rev 0.2
Page 3 of 5
1.2.1.
Introduction
Provide an overview of the entire document:
1.2.2.
System Overview
Provide a general description of the software system including its functionality and matters related to the overall system and its design (perhaps including a discussion of the basic design approach or organization). Feel free to split this discussion up into subsections (and subsubsections, etc ...).
2. Design Considerations
This section describes many of the issues which need to be addressed or resolved before attempting to devise a complete design solution.
2.1. Assumptions and Dependencies
Describe any assumptions or dependencies regarding the software and its use. Blah, blah.
2.2. General Constraints
Describe any global limitations or constraints that have a significant impact on the design of the system's software.
2.3. Goals and Guidelines
Describe any goals, guidelines, principles, or priorities which dominate or embody the design of the system's software. Such goals might be: The KISS principle ("Keep it simple stupid!") Emphasis on speed versus memory use working, looking, or "feeling" like an existing product
2.4. Development Methods
Briefly describe the method or approach used for this software design. If one or more formal/published methods were adopted or adapted, then include a reference to a more detailed description of these methods. If several methods were seriously considered, then each such
LHC Project Document No.
LHC-AB-CO-xxxx rev 0.2
Page 4 of 5
method should be mentioned, along with a brief explanation of why all or part of it was used or not used.
3. Architectural Strategies
Describe any design decisions and/or strategies.
4. System Architecture
This section should provide a high-level overview of how the functionality and responsibilities of the system were partitioned and then assigned to subsystems or components.
4.1. Subsystem Architecture
Blah, blah.
5. Policies and Tactics
Describe any design policies and/or tactics.
6. Detailed System Design
Most components described in the System Architecture section will require a more detailed discussion. Other lower-level components and subcomponents may need to be described as well. Each subsection of this section will refer to or contain a detailed description of a system software component. The discussion provided should cover the following software component attributes:
6.1. Classification
Blah
6.2. Definition
Blah
6.3. Responsibilities
Blah
LHC Project Document No.
LHC-AB-CO-xxxx rev 0.2
Page 5 of 5
6.4. Constraints
Blah
6.5. Composition
Blah
6.6. Uses/Interactions
Blah
6.7. Resources
Blah
6.8. Processing
Blah
6.9. Interface/Exports
Blah
6.10. Detailed Subsystem Design
Blah.
7. Glossary
Term: Definition.
8. Bibliography
A list of referenced and/or related publications. This document hacked from the original by Brad Appleton http://www.bradapp.net