Appendix 1: Final Documentation Format Guidelines

Typographical Format and Binding

Page Format:

Page size: A4
Top margin: 1.00 inch
Bottom margin: 1.00 inch
Left margin: 1.25 inch
Right margin: 1.00 inch

Page numbering: Bottom right - part of the footnote

Title page not numbered
All other pages before the page of chapter one numbered in lower
roman numerals (i, ii, iii, …)
All other pages starting from first page of chapter one to last page
of the report numbered in integers (1, 2, 3, …)

Footer: Each page shall have a footnote

“Department of Software Engineering
Faculty of Computing & IT
University of Sialkot”
Left aligned
In case of long titles shorter versions should be used.
There shall be a line over the footnote.

Header: Each page shall have a header “Project Name”

Left aligned
In case of long titles shorter versions should be used.
There shall be a line under the footnote.

Chapter Startup: Each chapter shall be numbered as Chapter 1, Chapter 2, etc. The
name of the chapter shall be written immediately below. Both shall
be centered horizontally as well as vertically.
The actual chapter content shall start from the next page.7

Text: Only one side of the paper shall be used.

The other side shall be blank.
When a report is opened the right side would contain text, figures,
or tables and the left side would be blank.

Tables and Figures: Tables and figures shall be placed on one side only
Separate pages shall be used for figures and tables.
One page may contain more than one figure or table but text will
not be combined or interlaced with figure or table.
 Each table / figure shall be numbered.
For example "Table 1.2: Population distribution in Asia" or
"Figure 3.2: Temperature distribution"
The table number or figure number shall be placed as normal text
centered at the bottom of the table or figure or sideways with
table / figure title coming on the opening side of the paper and note
on the binding side.

Paragraph:

Single-spaced.
Line entered paragraph.
DONOT put indents at the beginning of the paragraph.
Left aligned or justified.

Text Format

Normal and plane text:

Font Type: Times New Roman
Font Size: 12
Headings:
Chapter Heading: Times New Roman Bold Size 16 Title Case normal
Heading 1: Times New Roman Bold Size 14 Title Case normal
Heading 2: Times New Roman Bold Size 12 Title Case normal
Heading 3: Times New Roman Bold Size 12 Title Case italic

Sections and Subsections

In case of sections and subsections follow this format:

1 Section
1.1 Sub Section
1.1.1 Nested Sub Section
a
b
i
ii

The subsequent reference to a any section shall be made using the section and its number.
For example section 2.1.3 means chapter 2 section 1 subsection 3.

Mathematical Equations

The following numbering scheme should be used to number the equations:

f(x) = x+3 (XX:YY)
 Where XX is the chapter number and YY is the sequence number of that equation in that
chapter.
If an equation is previously quoted in an earlier chapter, say as equation 4:5 and need to
be re-quoted in chapter 5, its number will remain as equation 4:5.

References

References are to be placed in square brackets and interlaced in the text. For example "A
comprehensive detail of how to prevent accidents and losses caused by technology can be
found in the literature [1]. A project report / thesis cannot be accepted without proper
references. The references shall be quoted in the following format:

The articles from journals, books, and magazines are written as:
[1] Abe, M., S. Nakamura, K. Shikano, and H. Kuwabara. Voice conversion through
vector quantization. Journal of the Acoustical Society of Japan, April 1990, E-11
pp 71-76.
[2] Hermansky, H. Perceptual linear predictive (PLP) analysis for speech. Journal of
the Acoustical Society of America, January 1990, pp 1738-1752.
The books are written as:
[1] Nancy G. Leveson, Safeware System Safety and Computers, A guide to
preventing accidents and losses caused by technology, Addison-Wesley
Publishing Company, Inc. America, 1995.
[2] Richard R. Brooks, S. S. Iyengar, Multi-Sensor Fusion Fundamentals and
Applications with Software, The Prentice-Hall Inc. London, 1998.

Binding

All reports shall be bounded with an appropriate print on the backbone.

Two copies should be submitted.
Two CDs (All code and document in soft form)

Color of the binding:

For BS : Maroon cover and silver writing (Engraved)
Contents of the CD Attached
All reports / theses must accompany a CD whose contents will have the following:

Top-level directories:
Doc All documents related to the project
Instructions how to access the CD to the point to running the
project
All reports already submitted
The final project report in thesis form
Installation instructions
Trouble shooting instructions in case of problems
User manual
Research material including URLs
 Papers consulted / referred to
Slides of the presentations
Source All source files that will be needed to compile the project.
Further subdirectories can be used.
This must include sample data files as well.
Project The running project including sample data files as well as sample output.
This should be in a form that if copied to a machine runs without errors.
This may an exe file of an entire project, an installer depending on the
project or simply a running project.
You can have sub directories with appropriate names.

Length

The length of your dissertation depends on the type of project you have selected. An excellent
dissertation will often be brief but effective (its author will have said a lot in a small amount of
space). Voluminous data can be submitted electronically on CD.