ROYAL MILITARY COLLEGE OF CANADA
DEPARTMENT OF ELECTRICAL AND COMPUTER ENGINEERING
Detailed Design Document
(EEE455/457-DID-07)
for
High Speed Controller for a Blah Blah
Ocdt John Smith
OCdt Bill Johnson
Project /457/xx/xx
Supervisor: Dr. Sniffle Upagous
Project Manager: Maj Randy Hartman
15 March 20123
TABLE OF CONTENTS
Table of Contents ................................................................................................................................... ii
List of Figures .......................................................................................................................................iii
List of Tables ........................................................................................................................................ iv
1.
Introduction .................................................................................................................................... 1
1.1.
Background ............................................................................................................................. 1
1.2.
Project Thesis of Aim Statement ............................................................................................ 1
1.3.
Scope ...................................................................................................................................... 1
1.4.
Document Overview ............................................................................................................... 1
2.
Referenced documents ................................................................................................................... 1
3.
Requirements .................................................................................................................................. 2
4.
Architectural design ....................................................................................................................... 2
5.
Detailed design ............................................................................................................................... 3
5.1.
Overview ................................................................................................................................ 3
5.2.
Limitations .............................................................................................................................. 3
5.3.
Module Descriptions............................................................................................................... 3
5.3.1.
5.4.
(Module or component name) ......................................................................................... 3
5.3.1.1.
(Module or component name) design specification and constraints ....................... 3
5.3.1.2.
(Module or component name) design ...................................................................... 3
Interface Descriptions ............................................................................................................. 4
5.4.1.
(Interface Name) ............................................................................................................. 4
6.
Equipment Identification ................................................................................................................ 5
7.
Results ............................................................................................................................................ 5
7.1.
Testing .................................................................................................................................... 5
7.2.
Results .................................................................................................................................... 5
8.
Summary ........................................................................................................................................ 6
9.
Conclusion ...................................................................................................................................... 6
10.
Discussion................................................................................................................................... 6
11.
Future Work................................................................................................................................ 6
12.
Enclusures................................................................................................................................... 6
Appendix A The Title of the Appendix ................................................................................................. 7
Appendix B The Title of the Appendix ................................................................................................. 8
ii
LIST OF FIGURES
Figure 1. Class diagram of our developed path planning software (reproduced from [8]) .................... 2
iii
LIST OF TABLES
Table 1. Test Matrix, Maximum Radar Detection Range Test for Height Above Ground versus
Target Radar Cross Section ................................................................................................................... 5
iv
1
1.
INTRODUCTION
1.1. Background
Present an overview of the project in terms of its purpose and main features. The name of the
project and its abbreviation (if needed) must be given here. Go from the big picture to the
small picture to define the problem you are solving. This section shall also explain where this
project idea came from, i.e. its historical background. If applicable, explain how this project
fits with other related projects.
1.2. Project Thesis or Aim Statement
What will you do to meet the requirement / resolve the problem? It is the aim of your project.
1.3. Scope
What are the limitations or boundaries you are setting on your aim. Clearly indicate in this
section portions of the product designed/implemented by you and portions acquired off-theshelf.
1.4. Document Overview
Summarize the purpose and contents of this document. Tell the reader what is in each
section.
2. REFERENCED DOCUMENTS
Produce a standard list of all documents referenced in this DDD. Reference to documents
must be provided as a standard numbered list. Citations must be made using the Modern
Language Association (MLA) style. For example, the thesis cited as the 8th document would
be listed as follows:
[8] V.R. Roberge, “Contributions à la conception d’un système opérationnel de planification
de trajectoires en temps réel pour les drones,” M.S. thesis, Royal Military College of
Canada, Kingston, 2011.
This document presents a comprehensive approach to the design a UAV path planning
module. We used the theory presented in this document as a starting point for the
implementation of our UAV path planner software module as part of this project.
As written above, a short description must be included for each document included in this
section. This section should include some of your DIDs as required.
2
3. REQUIREMENTS
Present a summary of all the requirements that you designed to and will be tested against in
some way. If one of your requirements has changed from the initial Statement of
Requirement, you shall explain why. Numerate your paragraphs (one per functional
requirement) so that you could link your design part to your requirements in the next section
of this design doc.
4. ARCHITECTURAL DESIGN
Describe the high level view of your design including a brief description of your architecture
along with top level system block diagrams. Remember that one or two very well organized,
very clear diagrams goes along ways towards accurately describing your project. Take your
time and get this part completed correctly!
Below is an example of how to properly insert a figure into your document. Note that the title
is numbered and positioned below the figure (see Figure 1). The title is centered unless it
spans over two lines. In that case, the title is left justified. Also note that this figure is
reproduced from reference [8] which appears in the reference section of this document.
Car. de la trajectoire
1
1
Configuration
1
1
Interface graphique
1
Car. du drone
1
Planification de traj.
AG
OEP
Fichier de vol Horizon
Lissage
Fonction de coût
Figure 1. Class diagram of our developed path planning software (reproduced from [8])
3
5.
DETAILED DESIGN
5.1. Overview
Present a high-level description of the architectural breakdown for the product as “it was
designed”. This may differ from the breakdown presented in the PDS. The information
presented here should act as a roadmap through the following paragraphs. As appropriate,
figures and tables should be used. It is suggested you use a graphical representation (i.e. a
diagram) of the system structure to present the main modules of the system and how they
relate to each other. The graphical representation should be supplemented with a brief
narrative description of the modules and relationships between modules. This section will
put the reader in context and give the “big picture” view of your design. This will allow the
reader to better understand the elements of your design as they are presented.
5.2. Limitations
Clearly describe the limitations, assumptions, or unusual features that restrict the
performance of this product as a whole.
5.3. Module Descriptions
Create one sub-section for major module or component developed.
5.3.1. (Module or component name)
Note: The format of this section shall be modified slightly for software engineering projects
to accommodate one of the following formats:
a. Unified Modeling Language (UML) work products, i.e. class diagrams, collaboration
diagrams, etc.; or
b. Another notation specifically approved / directed by the Design Authority.
5.3.1.1. (Module or component name) design specification and constraints
State the design requirements, i.e. “What” the component is to do, for the module or
component, and any constraint on the design of this module or component. This
subparagraph shall specify the external interface of the module/component, and references to
other modules shall be made, as appropriate. The external interfaces may be with human
users of the product, may be other H/W or S/W elements of the product’s environment, or
may be other modules/components of your design. If applicable, man-machine design
requirements shall also be included.
5.3.1.2. (Module or component name) design
Specify the internal design of the module or component, i.e. “How” the component is to
function. Depending on the nature of the module/component, hardware or software diagrams
shall be used as much as possible to illustrate the design. Additional subparagraphs can be
added, numbered from 5.X.2.1, to cover the following topics, as applicable:
4
5.3.1.2.1. Internal structure of module/component.
Describe the internal structure of the module/component. The use of appropriate design
diagrams, schematics, graphs, timing info, etc. as appropriate for the design technique used is
required.
5.3.1.2.2. Interrupts and signals.
Identify and describe the interrupts and signals handled by the module/component. Identify
each interrupt and signal, as appropriate, its source, purpose, priority, expected response and
response time, and frequency of occurrence.
5.3.1.2.3. Description of Operation.
Identify and describe the mechanism/algorithms to be incorporated in the operation of the
module/component. The module operation may be described for example in terms of the
manipulation of input data elements or signals, and the generation of output data elements or
signals. The use of appropriate design diagrams, schematics, graphs, timing info, etc. as
appropriate for the design technique used is required.
Below is an example of how to properly insert an equation in your document. A table with
two columns is used to properly display the equation on the left and its label on the right. The
borders of the table are removed.
∞
𝑓(𝑥) = 𝑎0 + ∑ (𝑎𝑛 cos
𝑛=1
𝑛𝜋𝑥
𝑛𝜋𝑥
+ 𝑏𝑛 sin
)
𝐿
𝐿
(1)
5.3.1.2.4. Error handling.
If appropriate identify and describe the error detection and recovery features of the
module/component, including handling of erroneous input data and other conditions that
affect the behaviour of the module/component.
5.3.1.2.5. Miscellaneous.
Describe the use of other elements that are used by this module/components.
5.3.1.2.6. Limitations.
Describe any limitations or unusual features that restrict the performance of this
module/component.
5.4. Interface Descriptions
5.4.1. (Interface Name)
Similarly describe all system external and internal interfaces. Use the format described in the
PDS as a guideline. The question to ask yourself is: could someone else construct this system
based upon the information provided in this and the above section.
5
6. EQUIPMENT IDENTIFICATION
Provide a table plus any necessary description and explanation for all system components
which are both developed and Off-the-shelf (OTS). See the PDS for an example tabular
format.
7.
RESULTS
7.1. Testing
Discuss your testing methodology and how it relates to the requirements.
Include test matrices which show that you tested your design around the requirements values
for performance. Not all the matrices need to be shown in the test section. Show one or two
matrices and put the rest into an appendix and refer to them. An example test matrix is
shown below to illustrate (see Table 1). The matrix shows Maximum Radar Detection Range
for a variety of increasingly large reflector targets versus height above ground. As a side
note the test result values would go into the empty spots. There could potentially be a series
of the same matrix with a different radar look angle. Hence if there were 11 radar look
angles starting at 0° and incrementing by 0.1° to 2.0° then there would be 11 matrices, only
one or two of which would be shown in the main document text and the rest in an appendix.
Below is an example of how to properly insert a table into your document. Note that the title
is numbered and positioned above the table (see Error! Reference source not found.). The
title is centered unless it spans over two lines. In that case, the title is left justified.
Table 1. Test Matrix, Maximum Radar Detection Range Test for Height Above Ground versus Target Radar
Cross Section
Height Above Ground (m)
500
400
300
200
100
0
Target Radar Cross Section (m2)
Maximum Radar Detection Range (m)
1
2
5
10
20
100
200
7.2. Results
Based on your testing at the previous section, list the main requirements initially set for your
project and assess if they have been achieved, partially achieved or not achieved. Include
remarks for each of them. Present both the quantitative and qualitative successes (and failure)
of your project.
6
8. SUMMARY
The summary paragraph summarizes everything you did and mirrors the introduction and
thesis statements. It provides an overview of your design, testing, and results. Ideally
someone should be able to read the introduction, the summary and the conclusion sections
and understand everything you did except for the details supporting your work.
9. CONCLUSION
This is generally the part of the document that answers the “so what” question of your
project. Usually this is the answer to the question, “Do the results or your work substantiate
or invalidate the big picture reason for your project research and results”. What lasting
impression or overall concept do you want to leave with the reader on the topic.
10. DISCUSSION
This is the part of your project report where you may explain ‘issues’, complications,
difficulties, observations, or lessons learned you had with your project. In this section you
may describe any caveats to your thesis. If you discovered something novel or interesting in
the course of your project that doesn’t fit into your aim then you may present this here. You
would discuss the content of this section with your thesis advisors to determine whether you
should or should not include particular information.
11. FUTURE WORK
In this section you may present what you think the next step in research in this area would be.
If you did not finish everything you wanted to in your project you can describe what you
things should be done next.
12. ENCLUSURES
The latest version of any design artefacts that can not reasonably be placed in the DDD;
includes such things as COTS product specifications and data sheets. A separator shall
identify each document.
7
APPENDIX A
THE TITLE OF THE APPENDIX
Apopendix shall be used to provide information that supports the DDD: list of abbreviations, charts,
tables, etc.
8
APPENDIX B
THE TITLE OF THE APPENDIX
Another appendix.