Capstone Report Guide
Capstone Report Guide
The purpose of this guide, and the capstone report template (linked below) is to make the report writing process easier and to guide the
capstone team through the design process. This guide covers the preparation of both the project proposal (to be submitted at the end of
4991) and the final report (to be submitted at the end of 4992), these are very similar, requiring only one template to cover both.
The project proposal will outline your proposed solution of the problem with the aim of convincing your advisers that you are ready to
move on to the materialization phase in the following semester. By the end of the 4991 course semester you are expected to present a
description of the solution up to the physical architecture step. This description should remain the same (except for small updates) for
both the project proposal and the final report. Prototyping is encouraged, but depending on the type of project this may not be expected.
The final report in the second semester will continue from the project proposal, added an account of the materialization and validation of
the product.
2. Choose either "Capstone Project Proposal" for 4991, or "Capstone Project Final Report" for 4992, and write the title of the project
(include the project code).
If you are using the template for your status report, you can give it, for example, the title "Capstone Project Proposal (status report)"
3. List all your team members including their departments. Order names by surname so that everyone has equal status.
4. List the project advisers, again ordered by surname. Give proper titles to the advisers (you can find them on the faculty website).
Use the following (English language) titles:
Key Words
These are words or phrases that help people to search for publications that interest them. Keywords should be present in both reports.
If you follow the correct process for creating sections and sub-sections, MS Word will automatically build the table of contents for you.
Learn how to do this, it will save you a lot of time now, and in the future!
To add a section, subsection or sub-sub-section, select (in the text body, not the TABLE OF CONTENTS) the relevant Heading type.
Your editor might look something like this:
Once you have finished adding sections, go to the TABLE OF CONTENTS and update the list by
right-clicking on the lists and press “Update Field”; this will add newly-created objects and update
the page numbering automatically.
If you follow the correct process for creating table captions, MS Word will automatically build the list of tables for you. Learn how to do
this, it will save you a lot of time now, and in the future!
To add a new table, create and select the table, right-click and choose "Insert Caption", In the options choose "Table" (do not choose
"Tablo"). The Caption field will automatically give you the correct table number; add your caption description and press OK.
Remember that table captions should go above the table, and provide a short summary of what the table contains. Also, all tables should
be referred to in the main text, for example, "Calibration parameters used in the image processing are shown in Table 4.".
If you follow the correct process for creating figure captions, MS Word will automatically build the list of figures for you. Learn how to do
this, it will save you a lot of time now, and in the future!
To add a new figure, create and select the figure, right-click and choose "Insert Caption", In the options choose "Figure".
The Caption field will automatically give you the correct figure number, add your caption description and press OK.
Remember that figure captions should go below the figure and provide a short summary of what the figure contains. Also, all figures
should be referred to in the main text, for example, "The Control process for the system is illustrated in Figure 3.".
Repeated phrases can be replaced with well-known abbreviations (if they exist). In the main body of the text, a common way to use
abbreviations is to write them in full for the first time with the abbreviation in brackets, then use the abbreviation only for the rest of the
document. An example is given below.
In this project we use an Internet of Things (IoT) approach to improve control of household
energy consumption. The IoT architecture ....
In this case, the abbreviation "IoT" would be placed in the LIST OF ABBREVIATIONS in case the reader is not familiar and missed the
definition in the main text.
1. OVERVIEW
If you use the present tense, then your descriptions will be suitable for both the project proposal (before materialisation) and for the final
report (after materialisation). For example:
The robot is required to autonomously navigate a route reacting appropriately to obstacles and signs. These kind of statements are
given as a brief overview of
The robot is required to complete it's tasks within a reasonable time and with good accuracy. the requirements, they will
be explained in more detail
The robot should satisfy international safety and quality standards. in the following sections.
1.2.3. Constraints
A constraint is anything that limits your design decisions. Declare and discuss the key constraints that need to be considered in your
project. This should cover all sub-systems and should include, but not limited to:
Scheduling: How many team members do you have and what are their skills - how does this limit your design choices; how much time
do you have to complete the project, how does this limit your design choices.
Costs: What is your budget for the project, how does this limit your design choices.
Standards: Identify and discuss relevant legal requirements for your type of product, and recommended standards from your industry.
Other constraints: Also discuss, where relevant, business, environmental, social, ethical, health and safety considerations.
With the above definitions of the problem, and a review of the literature, you are now ready to develop your conceptual solutions
You can refer to literature (textbooks, handbooks, technical papers/reports, web sources etc) about similar products and include photos
and diagrams - make sure that your give appropriate references especially for photos of existing products that are not your own work
(you can refer to such products with, for example, "Figure 3 is an existing product that illustrates this type of solution [8].").
Describe your conceptual solutions and prepare a table (or tables) that lists and compares your concepts with respect to these
considerations. An example table (simplified) is provided in the capstone report template; you can add more considerations, and more
details.
Discuss the strengths and weaknesses of the alternative concepts and explain which design you finally arrived at and why.
Now that you have chosen a concept, you are ready to describe the overall physical architecture in Section 1.4.
a system interface diagram - this illustrates the relationship between sub-sytems, including the flow of energy, information and material.
Sub-systems should be clearly labelled; details of each sub-system can be left to Section 3.
a process chart - this is often in the form of a flow-chart, but can take other forms. The process chart shows the top-level step-by-step
operation of the system, that is the chain of events that lead to the overall operational behaviour of the system.
Simple examples of these figures can be found in the capstone report template.
You can create flow charts at https://www.lucidchart.com/
After describing the overall physical architecture, you will be ready to plan the tasks in Section 2.
2. WORK PLAN
Now that you have the overall physical architecture, you can assign tasks and plan the sequence and time of their execution. Note that
you are building a plan of action for the following semester (execution phase). In this section you will present the WBS, RM, PN, Gantt
chart and risks for the project. While the whole team should contribute to the preparation of this section, usually one member of the team
is assigned the task of planning responsible; this team member will make sure that tasks are planned and properly documented.
Introduce this section by reminding the reader about what is being built, by whom and which departments, and in what time-frame; then
proceed to the sub-sections.
2.1. Work Breakdown Structure (WBS) You can create the WBS (flow chart) at https://www.lucidchart.com/
The WBS provides a detailed hierarchical view of the structure of the product. It is a deliverable-oriented breakdown of the project into
smaller elements. The purpose is to indentify sub-systems and divide them further into elements that individual team members can
identify as areas that they can be responsible for. A simple example WBS is given in the report template. Adapt that example to your
project and add more structure and discuss details. Each element should be numbered, they will be referenced again later in the PN and
Gantt chart.
2.4. Gantt chart There are many software applications to choose from to create the Gantt chart, e.g. https://www.diagrams.net/
The Gantt chart tabulates the tasks from the PN and adds timing information. Rows can represent sub-systems, task groups and team
members. Remember that the project proposal documents the planning of activities for the materialization phase (in the following
semster); this typically involves sourcing and assembling components from Week 1. Take care to assign realistic timing for the start and
end of tasks such that there is sufficient time to complete the tasks and that tasks are not waiting for other tasks to be complete. Plan
to complete the product by Week 10 and give at least two weeks for verification; this will give time to deal with unexpected problems.
Also, consider emphasizing adding important milestones such as the completion of sub-system integration. For the final report, update
your Gantt chart to account for any changes, and explain those changes. Ideally, you would also add a separate Gantt chart for the first
semester (design phase); this can help you plan your first semester activities, or at least document them.
2.5. Costs
Tabulate the predicted costs for the project proposal and the actual costs in the final report. Divide the costs into sub-systems and
explain any significant differences between the predicted and actual costs. Give totals* for the sub-systems and whole system.
Before moving to the sub-sub-sections, begin with a short introduction to the sub-team and the functions that the sub-system performs
in the product.
3.x.1. Requirements
Using precise technical statements, give details of the functional and performance requirements of your sub-system; that is, what the
sub-system needs to do and how well it needs to perform to meet the requirements of the overall project. You can copy the relevant
parts from Section 1.2, extend and give more details.
For Software, include Functional Requirements (list of behaviors and attributes and their explanations as a table for each actor type) and
Nonfunctional Requirements (performance, security, safety, business rules).
3.x.3. Conceptualization
Refering to the overall architecture given in Section 1.4, consider two or three conceptual solutions for your sub-system. Compare them
to each other with respect to how well each concept would acheive the desired goals of the sub-system. You can repeat this for each key
component, for example for the choice of motors, image processing platform, control algorithm. Make use of tables to compare the
alternative components with respect to, for example, cost, complexity, performance and features, and any other relevant consideration.
At the end of this section, state which concept, in your considered opinion, is the best solution.
For software, provide your Use-case Modeling for alternative solutions (Actor glossary, Use-case glossary, Use-case scenarios and Use-
case diagrams - prepare a use-case diagram for each use-case scenario). Give your Interface Designs (Screen Images, Screen Objects and
Actions etc.) with explanations and summarize your architecture by providing Data Flow Diagram(s), Sequence Diagram(s), UML
Diagram(s), Activity Diagram(s).
3.x.6. Evaluation
Project Proposal Final Report
Describe your plans for the evaluation of your sub-system Describe the experiments that you have performed to
before it will be integrated with other sub-systems. Include evaluate (verify) your sub-system - explain any significant
plans for the experiments that you will perform, what data will changes with respect to the plan that was stated in the
be collected and how the data will be analysed to provide proposal. Show data and results of your analysis. Conclude
verification of your sub-system features and performance. with a statement about the success/failure of the verfication.
4.1. Integration
Project Proposal Final Report
Begin by reminding the reader about what sub-systems need Rewrite the description that you have already provided in the
to be integrated. Refer to the system interface diagram and project proposal in such a way that it presents a historical
the process chart that you provided in Section 1.4. Referring account of the actual integration. Explain any significant
to the PN and Gantt chart, discuss the organization and changes to the plan that was stated in the project proposal.
scheduling of the planned integration. Add photographs of the completed product. Discuss
successes, failures and fixes that you needed to apply.
4.2. Evaluation
Project Proposal Final Report
Remind the reader about the functional and performance Rewrite the description that you have already provided in the
requirements of the product that need to be verified. Describe project proposal in such a way that it presents a historical
your plans (for the following semester) for the experiments account of the actual experiments that you have performed.
that you will perform, what data will be collected and how the to evaluate (verify) your sub-system - explain any significant
data will be analysed in order to confirm that these functional changes with respect to the plan that was stated in the
and performance have been met. proposal. Show data and results of your analysis. Conclude
with a statement about the successes/failures of the
verfication process.
v2021.02.20 capstone report guide 22
5. SUMMARY AND CONCLUSION
This section presents a summary of the work done and a conclusion about successes, failures and experiences.
State any suggestions that you have about how the product can
be developed in the future.
APPENDIX
• Incorrect format of references and not citing them properly in the report.
• Not adding captions and/or not centering Figures/Tables.
• Not referencing a figure or table in the main body of the text.
• Abstract is too short.
• Submitting the docx version to advisers instead of converting it to PDF before sharing it.
• Not giving the report the proper file name
• "Bookmark not defined" error when the students did not add the Figures correctly.
• Not discussing/comparing conceptual solutions enough.
• Un-cited, copy-pasted sentences from Internet.
• Unreadable fonts in figures (fonts are too small)
• Poor image resolution in figures
• Using figures/photographs that are not your own without citation.
• Use bold or italic font in paragraphs.
• Adding full code in the body of the report instead of the Appendix; using double-spacing for source code.
• Poor/absent planning for product verification.
• Poor Conclusion section.