DEPARTAMENTO DE INFORMÁTICA
Bachelor in Computer Science Engineering
TITLE OF DOCUMENT
Report of the TSIW implementation project
January 2007
GRUPO G-NN
NAME OF STUDENT (STUDENT ID)
NAME OF STUDENT (STUDENT ID)
PROFESSOR: JOÃO MOURA PIRES
Summary
This is a summary of the work done by the student(s). This section must not
exceed 1024 characters and is limited to one page.
This document presents a set of formatting instructions and the structure for the
creation of the report. Moreover, it can be used as a template.
For the writing of the report, the student must follow the instructions given by
the Professor. Thus, the formatting of the cover page and the summary are the
only compulsory elements.
Some parts of this document are used to show the structure and formatting of
the report, and are therefore fictitious. Nevertheless, we recommend reading all
sections carefully.
-I-
Table of Content
1
Introduction ________________________________________1
2
Requirements and functional specifications ________________2
2.1
3
Architecture of the software solution _____________________4
3.1
4
Section 2.1 __________________________________________________ 2
Sub-Section 3.1 _______________________________________________ 4
Implementation _____________________________________5
4.1
Sub-Section 3.1 _______________________________________________ 5
5
Conclusions ________________________________________6
6
Bibliography ________________________________________7
7
Appendices _________________________________________8
7.1
Appendix 1 – Title oF appendix 2 _________________________________ 8
- III -
1
Introduction
In this section students must indicate the chosen topic, the reason for choosing
it, the delimitation of the considered scope, and the sources of information used
for the accomplishment of this work. That is, at the end of this section the
reader must have a clear idea of the technology used for the development of the
application -at least an essential grasp.
After that, students should present succinctly the structure of the report; this
section must have between 1 to 2 pages. The Report, beginning from this page,
must have up to 40 pages excluding the bibliography and eventual annexes.
Notes about the structure of this document. It is enough to consider -as a
guideline for your orientation- that this document must have the following
sections: 1) Introduction; 2) Requirements and functional specifications; 3)
Architecture of the software solution; 4) Implementation; 5) Conclusion.
For sections 2, 3 and 4 there are not any indications given about the number of
pages to be written, as it depends not only on the chosen type of work, but on
the adopted solution and the writing style. The most relevant aspects to present
are the ones related to the use of XML technologies.
-1-
2
Requirements and functional
specifications
In this section students must present the functional requirements and others
that might be relevant for the “application” or prototype to be implemented. The
way to present the requirements and specifications is to be chosen by each
group. However, students should use the proper words and without directly
referring to the text of the statements.
It is important that by the end of this section students manage to present
clearly, simply and directly what is intended to be implemented.
In the case students use some kind of formal notation, it must be used properly
and clearly. It should be noticed that in this section it can be possible to present
a wider scope than the one to be implemented; if that is the case, students must
clearly indicate what was really implemented from the whole picture described
here.
2.1
SECTION 2.1
The objective of this section is to present the use of figures and tables.
Text to be replaced to be replaced to be replaced to be replaced to be replaced
to be replaced to be replaced to be replaced to be replaced to be replaced to be
replaced to be replaced to be replaced to be replaced to be replaced to be
replaced to be replaced to be replaced to be replaced to be replaced to be
replaced to be replaced.
Table 2.1 – Summary of UML’s syntax.
Element
Use case
Description
Syntax
A sequence of actions, including variants,
that
a
system
(or
other
entity)
can
perform, interacting with actors of the
system.
-2-
UseCaseName
Actor
A coherent set of roles that users of use
cases play when interacting with these
use cases.
ActorName
System
Represents the boundary between the
boundary
physical
system
and
the
actors
who
interact with the physical system.
Association
The participation of an actor in a use
case.
i.e.,
instance
of
an
actor
and
instances of a use case communicate with
each other.
Text to be replaced to be replaced to be replaced to be replaced to be replaced
to be replaced to be replaced to be replaced to be replaced to be replaced to be
replaced to be replaced to be replaced to be replaced to be replaced to be
replaced to be replaced to be replaced to be replaced to be replaced to be
replaced to be replaced.
Figure 2.1 - Diagram of the XMM-Newton sattelite
Text to be replaced to be replaced to be replaced to be replaced to be replaced
to be replaced to be replaced to be replaced to be replaced to be replaced to be
replaced to be replaced to be replaced to be replaced to be replaced to be
replaced to be replaced to be replaced to be replaced to be replaced to be
replaced to be replaced.
-3-
3
Architecture of the software
solution
This section must present the architecture adopted for the implementation of the
software solution. If there are several practical options for such implementation,
students must justify their election. It is important to restate that if for some
reason any aspect(s) of the architecture is/are not implemented, students must
explain the rationale behind such decision. To the extent possible, students must
highlight
the
use
of
XML
technologies
within
the
framework
of
their
solution/architecture.
At the end of this section, the reader must have a clear idea of the way students
will implement the proposed “application” in a manner that will meet the
requirements previously presented.
3.1
SUB-SECTION 3.1
For each particular aspect, students must create a new sub-section. Whenever
examples are presented, they must be properly explained.
-4-
4
Implementation
This section must present all the most important details of the implemented
solution. Students must attain to defend the project as good as the achievement
of the implementation.
4.1
SUB-SECTION 3.1
For each particular aspect, students must create a new sub-section. Whenever
examples are presented, they must be properly explained.
-5-
5
Conclusions
In this section, students must come up with conclusions by critically analyzing
the design of the solution and its corresponding implementation. Moreover,
students must validate whether the requirements stated in section 2 were met or
not. Finally, students must state succinctly the use of XML technologies within
their work.
-6-
6
Bibliography
Students must use references in the text whenever they cite or use results of
other authors. For example:
The derivative products of fish and meat [2] have been used since the origins of
humankind.
They must be numbered by the order in which they appear in the text. Notice
that references not cited in the text should not be included.
The format must be:
For a book:
[1] D. Patterson e J. Hennessy, Computer Organization and Design: The
Hardware/Software Interface, San Francisco, CA, USA: Morgan Kaufmann
Publishers, 1997.
For a magazine article:
[2] B. Kernighan e S. Lin., An Efficient Heuristic Procedure for Partitioning
Graphs. The Bell System Technical Journal, Vol. 49, No. 2, pp. 291-307,
Fevereiro 1970.
For a conference’s communication:
[3] F. Fallah, S. Devadas, e K. Keutzer. OCCOM: Efficient Computation of
Observability-Based Code Coverage Metrics for Functional Simulation. Em
Proceedings of the Design Automation Conference, pp. 152–157, Junho 1998.
For a dissertation:
[4] D. Cheng. Power Estimation of Digital CMOS Circuits and the Application to
Logic Synthesis for Low Power. PhD thesis, University of California at Santa
Barbara, Dezembro 1995.
For an intern summary:
[5] E. Sentovich et al. SIS: A System for Sequential Circuit Synthesis. University
of California, Berkeley, Abril 1992.
-7-
7
Appendices
7.1
APPENDIX 1 – TITLE OF APPENDIX 2
Text of appendix 2
-8-