FORMATTING GUIDES FOR PROJECT REPORT

Ahmet Çalışkan and Fatma Azimli

Department of Software Engineering, Istanbul Aydin University, Istanbul, Turkey

Abstract
This document gives complete guidelines for authors preparing their reports in a paper format. In this part, briefly
describe your problem, approach, and key results. Should be no more than 300 words.

1. INTRODUCTION
In this introduction section, describe the problem you are working on, why it's important, and an overview of
your results.

This document describes, and is written to conform to, author guidelines for the project report. It is prepared
in Microsoft Word as a .docx document. Although other means of preparation are acceptable, the final
version of your report must conform to this layout. Although formatting instructions may often appear
daunting, the simplest approach is to use this word template and insert headings and text into it as
appropriate.

The following formatting rules must be followed strictly. This (.docx) document may be used as a template
for reports prepared using Microsoft Word. The project reports not conforming to these requirements
are not acceptable.

2. RELATED WORK
Discuss published work that relates to your project. How is your approach similar or different from others?

Any code that was used as a base for projects must be referenced and cited in the body of the paper. This
includes SEN503/339 assignment code, finetuning example code, open-source, or Github implementations.
You can use a footnote or full reference / bibliography entry.

2.1. General Format, Page Layout and Margins

Standard A4 (210 mm x 297 mm) portrait page set-up should be used. The left, right, top and bottom
margins should be 20 mm. Do not use any headers, footers or footnotes. No page numbers. Single column.
All main text paragraphs, including the abstract, must be fully (left and right) justified. All text, including
title, authors, headings, captions and body, will be Times New Roman font.

2.2. Title
The title is to be written in 20 pt. Garamond font, centred and using the bold and “Small Caps” formats.
There should be 24 pt. (paragraph) spacing after the last line.

2.3. Authors
Author names are to be written in 13 pt. Times New Roman format, centred and followed by a 12 pt.
paragraph spacing. If necessary, use superscripts to link individual authors with institutions. Author
affiliations are to be written in 12 pt. Times New Roman, centred.

2.4. Abstract
The Abstract section begins with the word, “Abstract” in 13 pt. Times New Roman, bold italics, “Small
Caps” font with a 6pt. spacing following. The abstract must not exceed 300 words in length in 10 pt. Times
New Roman italics. The text must be fully justified, with a 12 pt. paragraph spacing following the last line.
2.6. Section and Sub-section Headings
Section headings are numbered 1. Xxx, 2. Yyy, etc. in 14 pt. bold “Small Caps” Times New Roman font
with a 6 pt. line spacing following.
Subsection headings are numbered 1.1. Aaa, 1.2. Bbb, etc. in 12 pt. bold Times New Roman font with a 6pt
line spacing following.

2.6.1. Further Subsections

Further sub-sectioning, if required, is indicated using 1.1.1. Qqq, etc. headings with 11 pt. bold Times New
Roman font with a 6pt line spacing following.

2.7. Text
Main-body text is to written in fully (left and right) justified 11 pt. Times New Roman font with a 6pt.
(paragraph) line spacing following the last line of each paragraph, but a 12pt. (paragraph) line spacing
following the last paragraph. Do not indent paragraphs.

2.8. Figures and Tables

Table 1. Heading and text fonts.

Text Alingnment Font Followed by:

Title Centre 20 pt. TNR, bold, small-caps 24 pt. line sp.
Authors Centre 13 pt. TNR 12 pt. line sp.
Addresses Centre 12 pt. TNR
emails Centre 11 pt. italic TNR 18 pt. line sp. (last)
Abstract heading Left 13 pt. bold italic TNR, small caps 6 pt. line sp.
Abstract text Left 10 pt. italic TNR 12 pt. line sp.
Keywords heading Left 13 pt. bold italic TNR, small caps 6 pt. line sp.
Keywords Left, left, .. 10 pt. italic TNR 18 pt line sp.
Section headings Left 14 pt. bold TNR, small caps 6 pt. line sp.
Sub-section heads Left 12 pt. bold TNR 6 pt. line sp.
Sub-sub-sections Left 11 pt. bold TNR 6 pt. line sp.
Body text Full (left/right) 11 pt. TNR 12 pt line sp. (last)
Figures Centre 6 pt. line sp.
Figure captions Centre 11 pt. TNR 12 pt. line sp.
References Left 10 pt. TNR (as shown) 6 pt. line sp

All inserts, figures, diagrams, photographs and tables must be centre-aligned, clear and appropriate for
black/white or greyscale reproduction.

Figures (eg, Figure 1) must be numbered consecutively, 1, 2, etc., from start to finish of the paper, ignoring
sections and subsections. Tables (eg, Table 1) are also numbered consecutively, 1, 2, etc., from start to finish
of the paper, ignoring sections and subsections, and independently from figures.

Figure 1. Spam traffic sample.

All figures, tables, etc. must have a caption, centre-justified in 11 pt. Times New Roman. Captions precede
tables but follow figures. Tables and figures must appear as close to their point of reference as satisfactory
formatting of the final document permits.

2.9. Acknowledgements
An (unnumbered) acknowledgements section may be inserted if required.

2.10. References
References should be cited in the main text, in passing [1] or explicitly as in [2]. The full references should
be given as below (essentially IEEE format), in the order in which they are cited, in 10 pt. Times New
Roman, with a 6pt spacing between each.

3. OVERVIEW, METHODS AND TOOLS

Briefly and technically introduce your project here in this section. Write sentences giving the answers for the
following typical questions:

Discuss your approach for solving the problems that you set up in the introduction. Why is your approach the
right thing to do? Did you consider alternative approaches? You should demonstrate that you have applied
ideas and skills built up during the quarter to tackling your problem of choice. It may be helpful to include
figures, diagrams, or tables to describe your method or compare it with other methods.

If you use any open software module as a base code for your project, first give information about this module
by referencing its address which is given in the references part of your report. Explain how you use it in your
project.

Draw diagrams, preferable UML diagrams (at least package and class diagrams if your code has more that
one package and many classes), showing the relations between software packages and classes of your
project.

Explain the language and software tools that you use in your project.

4. ARCHITECTURE, ALGORITHMS, MODELS AND DATA

Formulate your software solution using Agents and AI terminology and AI solutions methods that were
presented in class. Think about using the following examples:

 Write PEAS for your solution.

 What are the properties of your agent software? (like observable, deterministic, episodic, sequential,
static, discrete, single/multi-agent software, … etc.)
 States, Initial State, Successor Function, Goal Test, …
 Some typical examples of graphs generated during runtime can be drawn.
 Completeness, Optimality, Time and Space Complexity information about your solutions.
 For example, for a project using backtracking algorithm in Sudoku game you can say that “our
software is based on improved Backtracking Algorithm which is a solution for a Constraint
Satisfaction Problem using ordering and filtering heuristics.” Variables, Domains, and Constraints
of the program must be given for this kind of agent software.

Describe the software and hardware architecture; introduce the algorithms, models used, and data. Use UML
diagrams for software architecture, other figures and tables to give different abstraction views of your
solution.

Data: Describe the data you are working with for your project. What type of data is it? Where did it come
from? How much data are you working with? Did you have to do any preprocessing, filtering, or other
special treatment to use this data in your project?
5. EXPERIMENTS, ANALYSIS AND PERFORMANCE
Discuss the experiments that you performed to demonstrate that your approach solves the problem. The exact
experiments will vary depending on the project, but you might compare with previously published methods,
perform an ablation study to determine the impact of various components of your system, experiment with
different hyperparameters or architectural choices, use visualization techniques to gain insight into how your
model works, discuss common failure modes of your model, etc. You should include graphs, tables, or other
figures to illustrate your experimental results.

6. CONCLUSIONS
Summarize your key results - what have you learned? Suggest ideas for future extensions or new
applications of your ideas.

The project reports in this format must not exceed twenty (15) pages in length. The project reports should be
submitted to Google Classsrom.

7. REFERENCES
[1] D. Parnas, “On the Criteria to be Used in Decomposing Systems into Modules”, Communications of ACM, vol. 15,
no. 12, pp. 1053-1058, 1972.
[2] S. McConnell, Rapid Development, Microsoft Press, 1996.
[3] The CHAOS Reports, http://www.standishgroup.com.
[4] ISO/IEC 9126-1, Software Engineering - Product Quality - Part 1: Quality Model, 2001.
[5] J. Heaton, Generating Faces with a Generative Adversarial Networks (GAN) in Keras/Tensorflow 2.0 (7.2), 11
December 2019, https://www.youtube.com/watch?v=Nrsy6vF7rSw
[6] J. Louis, Image Processing and Neural Networks Intuition: Part, January 16, 2018.
https://www.datasciencecentral.com/profiles/blogs/image-processing-and-neural-networks-intuition-part-1