Format/template for Software
Engineering
PROJECT TITLE (All Caps, 18pt, bold, centered)
Company Name(18pt, bold, centered)
COURSE NAME
(All Caps, 14pt, bold, centered)
Date (12pt, bold, centered)
GROUP MEMBERS
(All Caps, 14pt, bold, centered)
Name Registration No. (12pt, bold, centered)
COURSE INSTRUCTOR (All
Caps, 14pt, bold, centered)
Instructor Name
(12pt, bold, centered)
University or Institution (14 pt, bold, centered)
Page 1
-------------------------------------------------------------------------------------------------------------
PROJECT TITLE (All caps, 14 pt, bold, centered)
Members (12pt, bold, centered)
ABSTRACT /
Executive Summary
The executive summary should contain a brief statement of
the problem and discuss the importance of the problem. The summary should also present some of the
solutions that were considered, the solution that was selected, a brief
evaluation of the solution, and suggestions for further work.
Page 2
--------------------------------------------------------------------------------------------------------------
Table of Contents
Should be generated
by MS Word
Goto Insert -> reference -> Index and Tables
Page 3
--------------------------------------------------------------------------------------------------------------
LIST OF FIGURES
|
Figure No.
|
Description
|
Page No.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Page 4
-------------------------------------------------------------------------------------------------------------
LIST OF TABLES
|
Table No.
|
Description
|
Page No.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Page 5
--------------------------------------------------------------------------------------------------------------
This page should consist of the acknowledgements to the
people, companies and institutions that have been helpful to the author in
compiling the reports. It is normal practice to thank the Head of Institute for
the use of facilities with which the project was carried out, the supervisor
for his/her suggestions and guidance and any other member of the academic and
technical support staff who have made a significant contribution to the success
of the project.
Page 6
--------------------------------------------------------------------------------------------------------------
PROJECT TITLE (All caps, 14 pt, bold, centered)
Members (12pt,
bold, centered)
Introduction and Overview
This section should introduce the
project topic and provide a brief overview of all of your work on the
project. Nominally, this section should
contain briefly about Organization, a comprehensive description of the research
problem that was addressed, a discussion of the importance of the problem,
issues that the analysis problem raises, and a discussion of alternatives that
were considered. The section should also
discuss the general approach taken to solving the problem, and a short review
of the solution that was developed.
Page 7
-------------------------------------------------------------------------------------------------------------
Background
This section should provide an extensive review of the
existing system and previous work that is related to your project. Thoroughly discuss all previous attempts to
solve the problem and why they were not successful. A comprehensive review of all of the relevant
work is essential. Also explain what
were flaws in previous system.
Page 8
The aim of the project should be clearly stated with
sufficient explanation to make these easily understandable. Write succinct
definition of the problem. Defines and limits the‘Scope’ of the effort. Clearly describe how you tackled the
problem. Provide enough information for knowledgeable person where difficulty
or lack of time has caused a change in the aims of the project. The nature of
any changes in aims and the reasons for these changes should be explicitly
stated within this section.
Page 9
------------------------------------------------------------------------------------------------------------
METHODS, ASSUMPTIONS, and PROCEDURES
Present a brief discussion of the
methodology that was used to analyze and design the project. Discuss alternative methodologies that were
considered as well as their strengths and weaknesses. (Structured, Information
Engineering, Object Oriented)
Page 10
AVAILABLE RELEVANT Solutions and Evaluation
Present a comprehensive discussion
of available solutions to the problem.
Fully evaluate the alternatives and provide their references and design
layouts. You may discuss here reference material provided by your subject
teacher (provide only design Diagram(s)
Page 11
------------------------------------------------------------------------------------------------------------
Feasibility Report
Present a thorough discussion of the proposed solution, its
strengths and weaknesses, with respect to four tests of feasibility
(Operational, technical, schedule and economic).
Note: Update Schedule feasibility according to Object
Oriented analysis and Design
Page 12
------------------------------------------------------------------------------------------------------------
Analysis AND DESIGN
Thoroughly support and defend the solution that is
proposed. Discuss technique that was
used in analysis and design. First provide a summary that what is covered in
analysis and design section, and is the purpose of each activity that is
implemented or documented. A brief discussion on sequence of activities, with
their deliverables and documentation. All diagrams should follow UML notations
and must be developed in any UML case tool.
Note: you have to
organize deliverables listed below
Context Diagram
Business process workflow
Business document workflow
Object diagram
Actor usecase diagram
Actor usecase table
For j = 1 to no. of use cases
Analysis Use case
documentation (A)
Design Use case Documentation (D)
Partial Object diagram (A)
Sequence Diagram (D)
Collaboration Diagram (D)
Robustness Diagram (D)
Input Design Prototype (D)
Output Design Prototype (D)
Next
Class Diagram (with all attributes and behaviors)
Database Diagram
Page 13
Implementation
In this chapter you have to add actual form and report
layouts, component diagram, and
deployment diagram.
Page 14
------------------------------------------------------------------------------------------------------------
Support
In this chapter you have to attach system support contract
Page 15
-------------------------------------------------------------------------------------------------------------
Conclusions and Suggestions for Future Work
Present a thorough review of the work accomplished in the
project and the conclusions that were reached as a result of the project. Conclude the section with suggestions for
follow-on work and further development and research in the overall topical area
addressed in the project.
Page 16
-------------------------------------------------------------------------------------------------------------
References
References should be numbered consecutively, listed
alphabetically, and fully justified.
Each entry should be led by the first author’s last name and the year of
publication all within brackets. For a
conference listing, present the list of authors, last name first, year of
publication, publication title, conference title, conference location,
conference data, and pages in the proceedings where the publication appears. For a journal publication, present the list
of authors, last name first, year of publication, publication title, journal
title, journal volume and number, data, and pages of publication. For a book, present the list of authors, last
name first, year of publication, publication title, publisher, publication
city. For website reference, present the website name, title of page, URL of
that page, a brief description.
Conference example
1. [Bec93] Becket, W. and Badler, N.I. (1993)
“Integrated Behavioral Agent Architecture,” Proceedings
of the 3rd Conference on Computer Generated Forces and Behavioral
Representation, Orlando, FL,
17-19 March, pp. 57-68.
Journal example
2. [Hat98] Hatton, L. (1998) "Does OO Sync with
How we Think?," IEEE Software,
vol. 15, no. 3, May/June, pp. 46-54.
Book example
3. [Mee91] Meeus, J. (1991) Astronomical Algorithms.
Willmann-Bell: Richmond, VA.
Website Reference
4. [http://www.alplaweb.com],
“How OO world works”, http://www.alphaweb.com/OO/researchpapers/technical/ooworks.htm
.
General information on format methods, as well as technical
papers on Object Oriented technologies.
Page 17
-------------------------------------------------------------------------------------------------------------
APPENDICES SHOULD APPEAR AFTER THE LIST OF REFERENCES
Appendices are identified alphabetically and follow the same
format instructions as given for the body of the report. In this section you
will attach all main source/business documents that were collected form
organization during analysis phase, summary of Progress reports, Questionnaire
that was developed for first meeting.
Page 18
-------------------------------------------------------------------------------------------------------------
Help manual
Help manual will provide all Input and Output Screen snaps,
and description of how to conduct the business
operations
Page 19
-------------------------------------------------------------------------------------------------------------
LIST OF SYMBOLS
List of UML notation that are used in object oriented
analysis and design.
Page20
-------------------------------------------------------------------------------------------------------------
GLOSSARY
List of object oriented keywords with technical description
that are used in the project
Page21
-------------------------------------------------------------------------------------------------------------
INDEX
It should be generated by MS Word.
Go to insert -> reference -> index and tables
Page22
-------------------------------------------------------------------------------------------------------------Additional Formatting Instructions
The report should be written in 12 point Times or Times New
Roman, single spaced, with a .5” lead-in for each paragraph. Paragraphs should be fully justified. The report should have 1” margins on the top,
bottom, left, and right sides. Page
numbers should appear at the bottom of each page, centered on the page. Do not place a number on the cover or title
page. Sections should be numbered
consecutively; subsections are numbered consecutively within each section. Section numbers and subsection numbers are
left justified and in bold. Diagrams and
figures should be in imported JPEG format.
Diagrams and figures should be numbered consecutively throughout the
report. Tables should be centered on the
page and use a 9 – 14 point type size.
Page23
-------------------------------------------------------------------------------------------------------------