Writing Research and

Design Reports

Technical Writing and Communication Skills-20200

Outline
o Scientific Reports
o Graduation Project
o Research Papers
Scientific Reports
Cover Page

Introduction
• Objectives
• Material/Equipment

Discussion
• Procedure
• Results

Conclusion
Cover Page
oUniversity’s Logo
o Department
o Lab’s Name
o Experiment Name Using MSword

o Experiment No.
o Date
o Group Number
Introduction
• Objectives: are what it is supposed to accomplish in the
experimental procedure itself, usually presented in terms of a specific
verb that describes what is supposed to be done in the lab, such as to
measure, to analyze, to determine, to test, etc.
• Material/Equipment

Discussion
• Procedure
• Results/Answers to Questions–Visualize data
Conclusions
• Go over Assignment. Verify what has been accomplished. Take a few
moments to make a list of what is supposed to demonstrate or learn in
the experiment.
• Revisit the Introduction. To make sure the conclusion is consistent with
the rest of the report, revisit the lab report’s introduction.  This is a good
tactic to help brainstorm exactly what to say in the conclusion.
• Explain: Explain the purpose of the lab, what is to figure out or discover?
Talk briefly about the procedure followed to complete the lab.
• Results: Explain the results and confirm whether or not the hypothesis
was supported by the results. Comment further by describing the
meaning of the experiment’s results. Clarify why the results indicated
support the hypothesis.
Conclusions
Senior Project
Computer • Research Template
Science • Project Template

Engineering • Design Template

 Computer Science Engineering
Research Template Project Template Design Template
Cover Page Cover Page Cover Page
Declaration of Originality Declaration of Originality
Acknowledgments Acknowledgments Acknowledgments
Abstract Summary Abstract
List of Abbreviations List of Abbreviations
Table of Contents Table of Contents Table of Contents
List of Figures List of Figures List of Figures
List of Tables List of Tables List of Tables
Introduction Introduction Introduction
Research Plan Project Plan Background and Literature
Literature Review Requirements Specification Review
Methodology System Design Design
Results and Discussion Implementation and Testing Results
Conclusion and Future Work Conclusions and Future Work Conclusion and Future Work
References Users’ Manual References
Appendix A Appendix
Appendix B
Main Points
• Cover Page
• Declaration of Originality
• Acknowledgments
• Abstract
• List of Abbreviations
• Table of Contents
• List of Figures
• List of Tables

10
Declaration of Originality
This document has been written entirely by the undersigned team
members of the project. The source of every quoted text is clearly
cited and there is no ambiguity in where the quoted text begins and
ends. The source of any illustration, image or table that is not the
work of the team members is also clearly cited. We are aware that
using non-original text or material or paraphrasing or modifying it
without proper citation is a violation of the university’s regulations
and is subject to legal actions.
 
Names and Signatures of Team Members:
Acknowledgments
Recognition or favorable notice for people.
I would like to thank my parents … supervisor .. Sponsors …

13
Abstract/Summary
Describe your project briefly in few paragraphs.
The abstract should not exceed one page.

http://www.wikihow.com/Write-an-Abstract

14
Abstract
•Motivation
Why do we care about the problem and the results? This section should include the importance of your work, the difficulty of
the area, and the impact it might have if successful.
•Problem Statement
What problem are you trying to solve? What is the scope of your work (a generalized approach, or for a specific situation)? In
some cases it is appropriate to put the problem statement before the motivation, but usually this only works if most readers
already understand why the problem is important.
•Approach
How did you go about solving or making progress on the problem? Did you use simulation, analytic models, prototype
construction, or analysis of field data for an actual product? What important variables did you control, ignore, or measure?
•Results
What's the answer? Specifically, most good papers conclude that something is so many percent faster, cheaper, smaller, or
otherwise better than something else. Put the result there, in numbers. Avoid vague, hand-waving results such as "very",
"small", or "significant."
•Conclusions
What are the implications of your answer? Is it going to change the world (unlikely), be a significant "win", or simply serve as a
road sign indicating that this path is a waste of time (all of the previous results are useful). Are your results general, potentially
generalizable, or specific to a particular case?
15
In a wireless network there are many signals that are broadcasted; Motivation
classifying these signals has been of great interest in the past few
decades. The main purpose of this study is to estimate the various
frequencies of each signal from the bundle of received signals.
The receiver monitors the broadcasted signals along with the
interfering signals, thus it needs to identify the desired and Problem Statement
undesired signals. After estimating the frequencies of the
undesired interfering signals, the system can then work on
suppressing these signals and maintaining the strength of the
desired signals.
The suggested new data model system fetches for the frequencies
of the received signals. The system contains an adaptive finite
Approach
impulse response (FIR) filter which exploits one of several random
search algorithms, which are the genetic algorithm and swarm
intelligent algorithms such as particle swarm optimization (PSO)
and ant colony optimization (ACO). Results
After estimating the frequencies a filter will be able to select the
various frequency components out of a collection of signals and to Conclusions
suppress any interfering signals.
The new technique should have advantages over other techniques
such as being non-parametric, and computationally efficient.

Always save the abstract for last.

16
List of Abbreviations
List the abbreviations you have used in your project if there are any
and what they stand for.
• UML: Unified Modeling Language.
• JSP: Java Server Pages.
• DLL: Dynamic Link Library.
• CMS: Content Management System.
Table
  of Contents
The table of contents should be automatically generated by going to:
References >> Table of Contents.
Choose Classic as the format of the table and set the number of
levels to be 3.
In order for the table of contents to be generated correctly:
• Each chapter title should be formatted using the style “Chapter”.
• Each section title should be formatted using the style “Section”.
• Each subsection title should be formatted using the style
“Subsection”

18
Table of Contents
1. Introduction..................................................................................................................................................2
1.1 Section ...............................................................................................................................................2
2 Background and Literature Review...............................................................................................................3
2.1 This should include:- .......................................................................................................................4
3 Design..........................................................................................................................................................5
3.1 Requirements....................................................................................................................................5
3.2 Analysis of Requirements and Constraints ..................................................................................5
3.3 Different Designs Approaches/ choices.......................................................................................5
3.4 Developed Design ...........................................................................................................................5
3.5 Did the Design Meet Requirements and Constraints ................................................................6
4 Results .........................................................................................................................................................7
4.1 Prototype Setup ...............................................................................................................................7
4.2 Experiment/ Simulation Setup .......................................................................................................7
4.3 Experiment/ Simulation Results Discussion:...............................................................................7
4.4 Validation of requirements/ constraints .......................................................................................7
5 Conclusion and Future Work .......................................................................................................................9
5.1 Appendix A: CODE .....................................................................................................................12
5.2 .................................................................................................................................................................13

19
List of Figures
• The table of Figures should be automatically generated by going to:
References >> Index Table of figure.
• Choose Classic as the format of the table and set the tab leader to
dots.
• In order for the table of figures to be generated correctly, the label of
each figure should be formatted using the style “Figure”.

20
List of Tables
• The table of tables should be automatically generated by going to:
References >> Index Table of figure.
• Choose Table as the caption, Classic as the format of the table and
set the tab leader to dots.
• In order for the table of contents to be generated correctly, the label
of each table should be formatted using the style “Table”.

21
Cross Reference

22
Future Work and Conclusion
The conclusion should draw out the implications (a conclusion
reached on the basis of evidence and reasoning) of findings and any
possible future work.
1. Tie together, integrate and combine the various issues raised in the
discussion sections and the solution presented whilst reflecting the
introductory thesis statement (s) or objectives.
2. Provide direction and areas for future research.
• Conclude
• Summarize
• Generalize

23
Appendix and Code
• Supporting evidence (e.g. raw data that is referred to in the text).
• Contributory facts, specialized data (raw data appear in the appendix,
but summarized data appear in the body of the text).
• Sample calculations (referred to in the text).
• Technical figures, graphs, tables, statistics (referred to in the text).
• Specification or data sheets (summarized in the text).
Reminder
Computer Science Engineering
Research Template Project Template Design Template

Introduction Introduction Introduction

Research Plan Project Plan Background and
Literature Review Requirements Literature Review
Methodology Specification Design
Results and System Design Results
Discussion Implementation
Testing
Introduction
1. Background of the project (motivation e.g. why is the design
important).
2. Objectives of the project and some description, including the
realistic constraints and design requirements.
3. Design achieved (brief description).
4. Indicate who exactly in the group is responsible for what.
5. Organization of the rest of the documentation.

26
Product Design and Requirements
• Design Engineers must consider a multitude of technical,
economic, social, environmental, and political constraints when
they design products and processes.
• There must be clear evidence in the design project that have
addressed the constraints that are relevant to the project.

•RealisticConstraints Examples
o Performance with cost/environmental restrictions.
o Accuracy/precision in determining properties.
o Need to do simulation for certain applications.
o Health and safety concerns.
Product Design and Requirements
• If you are designing a baseball bat, your design requirements
might be that the bat needs to be:
o Less than 1.5 pounds.
o Made out of a material approved by the league.
o Able to hit a baseball without breaking.
• If you are designing a better form of transportation for students
to get to school, your design requirements might be that the
transportation needs to be:
o Free for students.
o Quick: less than one hour round-trip.
o Safe.

28
Product Design and Requirements
General
• Performance Characteristics
oPhysical Characteristics
oAesthetics
• Cost
oInputs
• Energy Consumption
oFuel Consumption
oOutputs Product
• Power
oPollution
oUndesirable Side Effects
• Environmental Requirements
• Ease of Use
oEase of Learning
29
Product Design and Requirements
Software Programmes
• Functionality or feature set
• Speed, responsiveness
• Programming language
• Portability (ability to move to another operating system)

30
Product Design and Requirements
•Requirements
•Analysis of Requirements and Constraints
oBoth pre specified and based on requirements analysis
•Different Designs-Approaches/Choices
•Developed Design (VISIO)
oFlow charts
oSchematic
oPseudo codes
oSystem level diagrams
oArchitecture diagrams
oSystem/transistor diagram
•Did the Design Meet Requirements and Constraints
oUse table to summarize requirements and constraints met with justifications.
 

31
Background and Literature Review
• Review and contrast 5-7 conference or journal papers discuss
similar problem.
• Include references.
• Highlight any requirements or constraints of published work.
• Highlight your contribution to previous work.
• Brief description of the used technologies, equipment, circuits,
design, …etc.

32
Timeline

33
Results
• Prototype Setup
o Hardware
o Software
• Experiment/Simulation Setup
• Experiment/Simulation Results Discussion
o Tables
o Graphs
o Waveforms
o Figures
• Validation of requirements/constraints
• Discuss and analyze whether the requirements and realistic
constraints are met.
34
Common Mistakes
Try not to use I and we ….
• Example
X After working we discovered that …
 It was discovered from the above results that …..

Be smart in marketing and presenting your work! Documentation and

Presentation!

35
Scientific Papers
• In academic publishing, a scientific journal is a periodical
publication intended to further the progress of science, usually by
reporting new research.
• Write a scientific paper to report original empirical and theoretical
work within a scientific field.
• Why publish?
o Academics and Researchers
o Graduate Students
• How to value publications
o Peer Review
o Citations

http://slideplayer.com/slide/6295386/
Scientific Papers
• Primary Scientific Publications
oScientific research on original work
oAuthors present their own research work
• Published in
oScientific Journals
oConference Proceedings
oTechnical Reports
oBook Chapters
• Secondary Scientific Publications
oSurveys on research work
oAuthors present a synthesis of research articles on a topic to highlight advances of research.
• Published in
oReview journals
oBooks or compilations of articles.
Teamwork
• Limited time.
• Each has a distinctive role leading either to the team’s success or
failure.
• Limited resources.
• Communication is essential.

38