Chapter 1

Documentation Format
CoE/EE/ECE 198 (Special Problems in Computer/Electrical/Electronics and
Communication Engineering) students shall do an undergraduate student project (referred
to in this text as the Project). A passing grade shall not be given unless the student (or
students, in the case of a team project) (the Author) submits (submit) copies of the
Project’s final documentation (the Documentation). One copy shall be given to the
Department of Electrical and Electronics Engineering (the Department), one copy shall be
given to each faculty adviser of the Project (the Adviser), and one copy shall be given to
each host research laboratory of the Project. The Documentation shall follow the
approved format.

1.1 Cover
The hard-bound front cover shall contain the following information, each centered
in a separate line, and in the following order: the title of the Project; the words
“Undergraduate Student Project”; the full name of the Author (not the student number);
the words “B. S. Computer Engineering,” or “B. S. Electrical Engineering,” or “B. S.
Electronics and Communications Engineering,” depending on what 198 course was taken
by the Author; the word “Adviser” or “Advisers”; the full name of the Adviser; the words
“University of the Philippines, Diliman”; and the date of completion of the Project
(month and year).
If there is sufficient space, the spine may contain the following information,
which may be abbreviated, shortened, or not included as necessary: the name of the
Author, the title of the Project; the word “UP”; the year of completion of the Project.

1.2 Pages
The paper used shall be white, with a size of 8½” × 11” (letter). Only one side of
each page shall have content, the other side shall be blank. All pages shall have a margin
of one inch at the top, right, and bottom, and a margin of one and a half inches at the left.
The page numbering shall start at the first page of Chapter 1, starting at “1”,
located at the lower right corner. The previous sections may be numbered in small roman
numerals (i, ii, etc.)
The documentation starts on a new page for each chapter, with the word
“Chapter” and the chapter number in 24-point Times New Roman Bold, with a paragraph
spacing of one line above. The next line is the chapter title, in 24-point Times New

1
Roman Bold, with a paragraph spacing of one line above and one line below. Engineering
Numbering (1.1, 1.1.1, etc.) will be used to denote sections and sub-sections in each
chapter, with the first level indicating the chapter number. Body text shall be in a 12-
point Times New Roman font, single line spacing, full justified alignment, with a
paragraph spacing of one-half line below. Headings shall be left-justified, with the
heading title (not the number) indented half an inch from the left margin. First headings
(those that start with 1.1, 1.2, etc. shall be in a 14-point boldface Arial font, with a
paragraph spacing of one line above and half line below. Second headings (those that
start with 1.1.1, 1.2.1, etc.) shall be in a 12-point boldface Arial font, with a paragraph
spacing of one-half line above and one-half line below. Third headings are not numbered
anymore. Rather, they appear as is in 12-point boldface italics Times New Roman font,
with a paragraph spacing of one-half line above and one-half line below.
Below is an example to illustrate sections and subsection headings in Chapter 1:

1.1 Chapter 1, Section 1

Text here. Text here. Text here. Text here. Text here. Text here. Text here. Text
here. Text here.

1.2 Chapter 1, Section 2

Text here. Text here. Text here. Text here. Text here. Text here. Text here. Text
here. Text here.

1.2.1 Chapter 1, Section 2, subsection 1

Text here. Text here. Text here. Text here. Text here. Text here. Text here. Text
here. Text here.

1.2.2 Chapter 1, Section 2, subsection 2

Text here. Text here. Text here. Text here. Text here. Text here. Text here. Text
here. Text here.

Chapter 1, Section 2, subsection 2, subsubsection1

Text here. Text here. Text here. Text here. Text here. Text here. Text here. Text
here. Text here.
Chapter 1, Section 2, subsection 2, subsubsection2
Text here. Text here. Text here. Text here. Text here. Text here. Text here. Text
here. Text here.

2
1.3 Figures and Tables
Figures and tables shall be included in the body of the documentation to illustrate
or clarify the accompanying text. Thus, figures and tables must be referenced in the text
in order for them to be meaningful.
Figures in a chapter shall be numbered consecutively, with the first figure in
chapter x labeled as “Figure x-1”, and the second figure as “Figure x-2”. Similarly, tables
in a chapter shall be numbered consecutively, with the first table in chapter y labeled as
“Table y-1”, and the second table as “Table y-2”.
Each figure or table shall have a caption, with the words “Figure [x-y].” or “Table
[x-y].” in a 12-point boldface Times New Roman font, and the label in a 12-point Times
New Roman font. The label should indicate the significance of the figure. An example is
shown below.

R
C

F Q Q F Q, Q
complementary
inputs

NMOS C
logic trees
R F, F

Figure 4-1. DCVS logic with completion circuit and timing

Parameter Format
Single Single Double Double
Extended Extended
p 24 ³ 32 53 ³ 64
Emax +127 ³ +1023 +1023 ³ +16383
Emin –126 £ –1022 –1022 £ –16382
Exponent width in 8 ³ 11 11 ³ 15
bits
Format width in bits 32 ³ 43 64 ³ 79
Table 4-1. IEEE 754 format parameters

3
Chapter 2
Front Matter
The front matter contains material that precedes the body of the document, such as
acknowledgments, table of contents and list of figures. Each of the sections below start on
a new page, with page numbers in small roman numerals (i, ii, iii, etc).

2.1 Title page

The title page shall contain the following information, each centered in a separate
line, and in the following order: the title of the Project; the words “Undergraduate
Student Project”; the full name and student number of the Author; the words “B.S.
Computer Engineering,” or “B.S. Electrical Engineering,” or “B.S. Electronics and
Communications Engineering,” depending on what 198 course was taken by the Author;
the word “Adviser” or “Advisers”; the full name of the Adviser; the words “University of
the Philippines, Diliman”; and the date of completion of the Project (month and year).
The title shall be in a 24-point Arial font, while the rest shall be in a 12-point Times New
Roman font.

2.2 Approval Sheet

The approval sheet shall contain the following information, full justified: the
words “Approval Sheet” in a 14-point boldface Arial font; the body text “In partial
fulfillment of the requirements for the degree of Bachelor of Science in
[Computer/Electrical/Electronics and Communications] Engineering, this project entitled
“[Project title],” prepared and submitted by [the Author], is hereby recommended for
approval.”; the signature of the Adviser; the Adviser’s full name; the word “Adviser”; the
signature of the Reader; the Reader’s full name; the word “Reader”; the body text
“Accepted in partial fulfillment of the requirements for the degree of Bachelor of Science
in [Computer/Electrical/Electronics and Communications] Engineering.”; the Department
Chairman’s signature; the Department Chairman’s full name; the words “Chairman,
Department of Electrical and Electronics Engineering”.

2.3 Acknowledgments
The acknowledgments page shall contain the following information, full justified:
the words “Acknowledgments” in a 14-point boldface Arial font; body text containing the
acknowledgments and dedications.

4
2.4 Table of Contents
The table of contents shall contain the following information, full justified: the
words “Table of Contents” in a 14-point boldface Arial font; the headings, with each
heading being followed by a series of dots, and the page number where it starts. Chapter
numbers shall have no indentations from the left margin, first headings (section numbers)
shall have half an inch indentation from the left margin, and second headings (subsection
numbers) shall have a one inch indentation from the left margin. The Bibliography and
the titles of the Appendices, as well as the page numbers where they start, shall also be
listed. The following shall not be given entries in the table of contents: title page,
approval sheet, acknowledgments, table of contents, list of figures, list of tables, abstract.

2.5 List of Figures

The list of figures shall contain the following information, full justified: the
words “List of Figures” in a 14-point boldface Arial font; the figure numbers and labels,
with each being followed by a series of dots, and the page number where it starts. If the
figure is the yth figure under chapter x, it shall be numbered x-y.

2.6 List of Tables

The list of tables shall contain the following information, full justified: the words
“List of Tables” in a 14-point boldface Arial font; the table numbers and labels, with each
being followed by a series of dots, and the page number where it starts. If the table is the
yth table under chapter x, it shall be numbered x-y.

2.7 Abstract
The abstract shall contain the following information, full justified: the words
“Abstract” in a 14-point boldface Arial font; the body text. The abstract should include a
concise description the project, its objectives and a summary of important results.

5
Chapter 3
Body of the Documentation
The main body of the document will follow the following chapters and sections,
where applicable.

3.1 Introduction
This chapter should contain the following sections: background of the project,
project objectives, and overview of the project.

3.1.1 Background of the Project

This section states the reasons why the Project is being done. If the Project is
related to previous projects, a short history of what the previous projects accomplished
shall be included. If the Project is part of a larger work, a brief mention of the rest of the
work shall be made.

3.1.2 Project Objectives

This section clearly states what the project wishes to achieve.

3.1.3 Overview
A block diagram giving an overview of the basic building blocks of the Project
and how they relate to each other shall be shown. If the Project was done by a team, the
division of labor shall be clearly discussed.

3.2 Literature Review

A review of previous work related to the Project shall be done.

3.3 Methodology
This chapter discusses the methods and techniques used to implement the project.
This includes not only the actual implementation, but also how tests are designed and
their results obtained and analyzed. The methodology should contain at least three
sections: design, implementation, and testing.

3.3.1 Design
Information on how the design was obtained shall be presented. It shall be
indicated whether the tools, parts, and algorithms used in the Project were created by the
Author or by a different source.

6
3.3.2 Implementation
In formation on how the design was implemented shall be presented. It shall be
indicated if the labor was performed by the Author or by a different source.

3.3.3 Testing
Information on how the design and the implementation was tested shall be
presented.

3.4 Results and Analysis

This chapter summarizes the data gathered during testing, significant results and
their analysis. Note that only important data should be presented here, data that will
support the analysis and conclusion. Raw data, large tables and charts should be placed in
the Appendix instead

3.5 Conclusions and Recommendations

3.5.1 Conclusions
A summary of the results of the Project shall be given and a conclusion should be
drawn. The conclusion should tie up the results with the project objectives.

3.5.3 Recommendations
Comments on what can be done in the future to improve or expand the Project
may be offered.

3.6 Alternative Organization of the Documentation

For projects consisting of modules which may be treated independently, the
following organization may be be used after Chapter 2 (Review of Related Literature):

Chapter 3 Module 1
Contains the design, implementation, testing, results and analysis for module 1.

Chapter 4 Module 2
Contains the design, implementation, testing, results and analysis for module 2.

Chapter n Module x
Contains the design, implementation, testing, results and analysis for module x.

Chapter (n+1) Conclusions and Recommendations

Ties up the significant results of each module and what they mean as a whole.

7
Chapter 4
Back Matter
The back matter contains the Bibliography, additional References, Appendices,
Notes, and other materials following the main body

4.1 Bibliography
The bibliography shall contain the following information, full justified with a
hanging indention: the words “Bibliography” in a 44-point boldface Times New Roman
font; the bibliographic entries.
Here are the suggested formats for: [1] a textbook, [2] a manual (in this case, in
electronic format), [3] a paper in a journal, [4] a paper in a proceedings, [5] a web page,
[6] other work (data sheets, theses, etc.), presented as examples. They may be listed in
the order that they are used in the document, or alternatively, in alphabetical order (first
author’s last name).
[1] C. Mead and L. Conway, Introduction to VLSI Systems. Reading, MA: Addison-
Wesley Publishing Company, 1980.
[2] Cell Design Tutorial, Layout Design, IC Tools. OpenBook Version 3.3. Cadence
Design Systems, Inc., February 1997.
[3] J. C. Ebergen, “A formal approach to designing delay-insensitive circuits,”
Distributed Computing, vol. 5, no. 3, pp. 107–119, July 1991.
[4] P. Patra, S. Polonsky, and D. S. Fussell, “Delay insensitive logic for RSFQ
superconductor technology,” in Proceedings of the Third International
Symposium on Advanced Research in Asynchronous Circuits and Systems, pp.
42–53, 1997.
[5] T. Verhoeff. Encyclopedia of delay-insensitive systems (EDIS).
http://edis.win.tue.nl/ (November 1999).
[6] J. C. Ebergen, Translating Programs into Delay-Insensitive Circuits. Centre for
Mathematics and Computer Science, Amsterdam, CWI Tract 56, 1989.

4.2 Appendices
If there is only one appendix, it shall be labeled “Appendix:” and the appendix
title. If there are more than one appendix, they shall be labeled “Appendix A: [title]”,

8
“Appendix B: [title]”, etc. Each appendix shall start with a page containing its title in a
24-point boldface Times New Roman font.
For software projects, appendices may include program listings, screen shots, and
sample input and output files. A CD-ROM or other media may be attached. For
hardware projects, appendices may include printed circuit board layouts and geometric
design layouts. Other possible appendices include user manuals (created by the Author
for the Project), long mathematical proofs, and reviews of basic concepts.