ACADEMIC Research

You might also like

Download as pdf or txt
Download as pdf or txt
You are on page 1of 7

ACADEMIC RESEARCH

Format for Project Reports:


The project reports should be like conference papers: concise and focusing on what you did.
Format: Use 1 inch margins (left and right), 1 inch margins (top and bottom), 11 point times
font for the main text, and use 10 point courier font for computer code. Use your judgment for
other situations (for example indented, italics, and 10 point courier font for quotations). Single
space your text. Make the text fully-justified (where the letters are aligned on both the left and
right). The text should be in 2-columns, with 3/8 of an inch of space between columns. Your
paper should be 4 pages long. Having only 3 pages is fine, as long as the content is good.
Anything 6 pages or longer will not be graded.
If you want to use LaTeX, here are two examples with the formatting already done. You can just
remove the text that you do not need. You will also need either the ieee.cls class file or the
IEEEconf.cls class file. Just download both class files until you decide which one you like.
1. Example final report, journal style .tex file and its output.
2. Example final report, conference style .tex file and its output.
You are allowed to have appendices, as needed. Appendices are mainly for code or mathematical
derivations. Appendices do not count in the page count. For example, if you have 4 pages of
report, you may also turn in an appendix that is as long as you like. The appendix should be like
a separate document, with your name(s) on it. Attach it physically to the report, e.g. with a binder
clip.
Yes, your code should be in the appendix, monospaced, single column. You do not have to
turn in all code used in your experiment; use your best judgement. You may want to include only
relevent sections of code. For example, you should not include code that someone else wrote,
unless you made major modifications. If your code is 100 pages, you should not print all of it. If
your code is 6 pages, then you should print all of it.
If you include a work-log, you can put it in the appendix. Or you could incorporate it into one of
the sections of the report, if it is appropriate.
The references must be in the same 2-column format as the rest of your paper.
You can use this PDF example, but follow the instructions below. If you want to use LaTeX,
here are directions and an example file you can use as a template.

Under authors' names, instead of address put the Class name, number, date, and instructor
Abstract should be no more than 150 words. The abstract is a short summary of the paper.
If you had to re-state what your paper says in 150 words or less, what would you say?For

a conference paper, most people will read the abstract to see if they find it interesting
enough to read the whole paper. This makes a lot of sense if you go to a conference in a
topic that interests you, but find that there are 100+ other papers.

By the way, I recommend writing the abstract LAST, since it is easier this way.
Introduction
o Why your topic is important (convince us!)
o Where is it used? Applications
o What you will talk about/do
o Overview of the rest of your paper (section 2 covers...section 3 presents...)
Background
o Any relevant and specific info
e.g. hardware statistics, equipment used
o

What other people had to say on this topic(s)


(be sure to cite your references, and quote as appropriate)

o
o
o

You are expected to discuss the books and papers that you include in your
references. You must also cite them. If nothing else, include a brief rationale
explaining why you thought it was useful.
What other people did on this topic (or related topics)
Problems and shortcomings of their work
How your work is different and better

Project
o
o
o

Your approach to the problem


What you did
Design
- what you already had (and where it came from). what you added/changed
- for parts, include close-up drawings (e.g. Magic screenshots)

o
o
o

What did/didn't work?


Include graphs, equations, pictures, etc. as appropriate
Results
Include relevant observations, measurements, and statistics. For example, for the
VLSI Class: Include statistics such as timing information if available by
simulation, or if not, your own analysis about critical path, delays, and clock
cycles. Be sure to include size information: the total size of the circuit measured
(X lambda by Y lambda), and the transistor count.

Summary
o Try to draw together the intro, background, and project sections.

How do they all relate together? (They may appear to be disjoint sections to an
unfamiliar reader).
o Restate important results
Conclusions
o What was accomplished / learned
o What you would have done differently
o Future work
References
o You should include a number of books and papers that were useful. If no number
if specified, then include at least 5 books or papers. (If this is a group project,
include at least 5 per person.) Webpages do not count toward this minimum
number. Wikipedia is not appropriate, and you will be penalized if you include it.
o Cite the papers/books that you used
o Anything you found useful
o Include textbooks from class if you want

Format for a Scientific Report


Abstract
Short (three-quarters of a page) description of the paper. Describe what the
issue or problem is, why it is important or interesting, and your findings.

Introduction

What is the issue or problem?


Literature review: what is current thinking, findings, and approaches on the
problem?
What is the significance of the problem?
How do you plan to deal with the problem? What is your solution?

Methods

How did you search for information or data on the topic?


What is your impression of the ulility, relevance, or quality of the data you
collected?
What special steps did you take to select or utilize the data?

Results

What are your findings?


Are their problems with your findings in terms of answering the questions
posed in the introduction?

Discussion

What do your observations mean?


Summarize the most important findings.
What conclusions can you draw?
How do your results fit into a broader context?

Format for an Industrial Training Report


How to Write the Industrial Training Report:
The expected content of the Industrial Training Report is explained in the
template below. Your write-up should adhere to those guidelines. Most
importantly, all the write-up and figures and tables in your report (except the
appendix) must belong to you, and must be in your own sentences. Any material
that is copied from another source must be put in the appendix only, and properly
referenced.
Content and Organize:
Dividing the Report into Sections and Logical Parts
Below are some guidelines describing what sections are expected in a training
report and what each section should include.
Abstract (zete): Start your report with a brief abstract that describes in a few
sentences where you have done your summer training, what you have done, and
what you have learned.
1. Introduction (Giris): Have an introductory section that will make a smooth
beginning to the document. In the introduction section include the following:

The name of the company and department where you have done your summer
training, the main focus area of the company, and your motivation for choosing
this company as the place for your summer training.

Brief summary of the work you have done, the motivation behind it, and the
significance of the work that you have done in the overall project.

Explanation of the organization of the rest of the report.

2. Company Information (Firma Bilgisi): Have a section providing detailed


information about the company and department where you did your training, its
hardware/software systems and resources, its focus and project area, its
organization, etc. The name, address, telephone number, email address, and
information about the education of your supervisor must be given (including the
name of the university and department from which he/she graduated, and the year
of graduation). Additionally, you must list the names of your team members and
their backgrounds.
3. Training Work (Staj alisma): This is the most important part of your report.
The number of sections in this part, their titles, and their contents depend on the
work that you have done and the information you would like to provide.

This part should include at least the following:

Information about the main project, if the work you have done is part of such
a project.
The significance of the work you have done.
The motivation behind the particular work that you have done and why it is
required.
Detailed description of the work done, including for example:
The algorithms/pseudo-code developed.
Hardware/software environment used.
Software tools used.
Design methods used and learned.
Testing methods and tools used and learned.
Project management methods and processes followed or observed.
Any engineering standards that are followed or observed.
Design, development, documentation and testing participated in or
observed.
Any training received, including seminars attended.
Any configuration and/or maintenance tasks performed.
Detailed description of your own contribution and clearly identification of
the distinctions from others work.
A section in which you explain in detail what knowledge and skills learned
in school you were able to apply to real-world problems during your summer

training, and specifically where and how the knowledge or skills were
useful.
A section in which you explain in detail engineering problems related to
computer systems and applications that you solved.
A section in which you explain in detail the teamwork you were involved in
during the summer training, including (for each team you participated in) the
team role or function of each team member, the training in their background
and current work area, and some information about the team dynamics as
you worked together. You should clearly explain how you related to the
others on the team. If you were not involved in a formal team, the definition
of the term could be interpreted loosely to mean working together with
others on a shared task.
A section in which you explain in detail which professional issues and workrelated ethical issues you saw or became aware of during your summer
training, and how the issue was handled or managed at your company or
institution.
A section in which you explain specifically what you learned or understood
about the economic, environmental, societal and global impact of the
engineering solutions in the projects developed at your company or
institution. You should also write in general about the contemporary issues
that are related with computer engineering, as you understand them from,
and related to, your summer training.
A section in which you explain the self-learning that you did during your
summer training. You should mention any sources that you located and how
you found them (this would include Web sites, books, journals, experts, etc),
and what part of your summer training task you needed them for. Also,
mention any that you made regular use of, and any that you are continuing to
use.
A section in which you explain in detail any new tools or technologies that
you encountered and used during your summer training, how you learned to
use them, and what level of proficiency you came to by the end of your
summer training.
When writing this section, do not forget that the reader may not be familiar
with the topic of the work that you have done. Therefore, explaining too
much is better than not enough.

4. Conclusion (Sonu): Have a conclusion section where you summarize the work
you have done. Clearly re-state your contribution, what you have learned,
experienced and acquired. Be specific in relating these to what you have learned at
Gediz University.

5. References (Kaynaklar): List references such as papers, documents, manuals,


web pages, etc.

You might also like