Ambo University Woliso Campus School of Informatics and Technology Department of Information Systems
Ambo University Woliso Campus School of Informatics and Technology Department of Information Systems
NOTEBOOK
2019/20 AY.
Table of Contents
1. DOCUMENT STYLE AND FORMATTING................................................................ 1
1.1. Language ................................................................................................................................. 1
1.2. Paper Size and Specification ................................................................................................... 1
1.3. Font ......................................................................................................................................... 1
1.4. Spacing .................................................................................................................................... 2
1.5. Tables ...................................................................................................................................... 2
1.6. Figures ..................................................................................................................................... 2
1.7. Margins ................................................................................................................................... 2
1.8. Page Numbers ......................................................................................................................... 2
1.9. References .............................................................................................................................. 3
2. PRESENTATION SLIDE FORMATTING ................................................................... 3
3. PRELIMINARY PAGE .................................................................................................. 4
3.1. Cover Page .............................................................................................................................. 4
3.2. Title Page................................................................................................................................. 4
3.3. Declaration Page ..................................................................................................................... 4
3.4. Approval Page ......................................................................................................................... 4
3.5. Acknowledgement .................................................................................................................. 4
3.6. Table of Contents .................................................................................................................... 4
3.7. List Figures and Tables ............................................................................................................ 5
3.8. List of Abbreviations ............................................................................................................... 5
3.9. Abstract ................................................................................................................................... 6
4. MAIN BODY OF THE PROJECT WORK .......................................................................................... 6
CHAPTER ONE ..................................................................................................................... 7
1. INTRODUCTION .......................................................................................................... 7
1.1. Background of the System ...................................................................................................... 7
1.2. Statement of the Problem ...................................................................................................... 7
1.3. Objectives of the Project......................................................................................................... 7
1.3.1. General Objective ........................................................................................................... 7
1.3.2. Specific Objectives .......................................................................................................... 7
1.4. Scope and Limitation of the Project........................................................................................ 8
1.4.1. Scope of the Project ........................................................................................................ 8
1.4.2. Limitation of the Project ................................................................................................. 8
1.5. Risks, constraints and Assumptions ........................................................................................ 8
1.6. Significance of the Project ...................................................................................................... 8
i
1.6.1. Beneficiary of the Project................................................................................................ 8
1.7. Budget and Time Schedule of the Project .............................................................................. 8
1.7.1. Budget of the Project ...................................................................................................... 8
1.7.2. Time Schedule of the Project .......................................................................................... 8
1.8. Team Composition .................................................................................................................. 8
1.9. Document Organization .......................................................................................................... 8
CHAPTER TWO .................................................................................................................... 9
2. REQUIREMENT ANALYSIS ............................................................................................................ 9
2.1. Overview of Existing System ................................................................................................... 9
2.2. Major Functions of the Existing System .................................................................................. 9
2.3. Business process of existing system supported by tables, forms, documents etc. (if any). ... 9
2.4. Business Rule of existing system............................................................................................. 9
2.5. Business use case modeling .................................................................................................... 9
2.5.1. Actors and use case descriptions ........................................................................................ 9
2.5.2. Use Case Diagram ............................................................................................................. 10
2.5.3. Use case Scenario/narratives ............................................................................................ 10
2.6. Strength, Weakness, opportunity, and threats analysis of the existing system ................... 10
2.6.1. Strength of the existing system ........................................................................................ 10
2.6.2. Weakness of the existing system ...................................................................................... 10
2.6.3. Opportunity of the existing system .................................................................................. 10
2.6.4. Threats of the existing system .......................................................................................... 10
2.7. Problem of the existing system............................................................................................. 10
CHAPTER THREE .............................................................................................................. 11
3. PROPOSED SYSTEM ................................................................................................. 11
3.1. Overview of proposed system .............................................................................................. 11
3.2. The Architecture of the proposed system ............................................................................ 11
3.3. Methodology and Tools of the Projects................................................................................ 11
3.3.1. Data Gathering Methodology ........................................................................................... 11
3.3.2. System Analysis Methodology .......................................................................................... 11
3.3.3. System Development Model............................................................................................. 11
3.3.4. Coding and Implementation Methodology....................................................................... 11
3.3.5. Testing methodology ........................................................................................................ 11
3.3.6. Installation ........................................................................................................................ 11
3.3.7. Documentation ................................................................................................................. 12
3.3.8. User training and support ................................................................................................. 12
ii
3.3.9. Maintenance ..................................................................................................................... 12
3.4. Tools ...................................................................................................................................... 12
3.4.1. Hardware tools.................................................................................................................. 12
3.4.2. Software tools ................................................................................................................... 12
3.5. Requirement specification .................................................................................................... 12
3.5.1. Functional requirements................................................................................................... 12
3.5.2. Non-Functional requirements ........................................................................................... 12
3.5. Feasibility study..................................................................................................................... 13
3.6.1. Technical Feasibility ...................................................................................................... 13
3.6.2. Operational Feasibility .................................................................................................. 14
3.6.3. Economical Feasibility ................................................................................................... 14
3.6.4. Schedule feasibility ....................................................................................................... 14
CHAPTER FOUR ................................................................................................................. 14
4. SYSTEM DESIGN ........................................................................................................... 14
5. REFERENCES ............................................................................................................. 15
6. APPENDICES .............................................................................................................. 15
6.1. Appendix A: Interview and Questionnaires (if any) .............................................................. 15
6.2. Appendix B: Existing System Forms and Reports .................................................................. 15
6.3. Appendix C: Sample Source Code ......................................................................................... 15
iii
1. DOCUMENT STYLE AND FORMATTING
The following guidelines are the minimum documentation preparation format
for the industrial project work, while issues like document content and length are decided by
the group and the advisor. Grammar, punctuation, spelling and other related issues are the sole
responsibilities of the group members.
1.1. Language
• The industrial project document must be prepared in English.
1.2. Paper Size and Specification
• You have to use a standard A4 (8.27" X 11.69") paper size.
1.3. Font
The specifications below should be strictly followed throughout your document. For the title
page(s).
▪ Body:
• Font type: Times New Roman
• Font size: 12
▪ Heading 1:
• Font type: Times New Roman [UPPER CASE]
• Font size: 16 [Bold]
▪ Heading 2:
• Font type: Times New Roman
• Font size:14 [Bold]
▪ Heading 3:
• Font type: Times New Roman
• Font size:12 [Bold]
▪ Heading 4:
• Font type: Times New Roman
• Font size:12 [Bold]
▪ Font Color: Black (Recommended unless and otherwise other colors carry
some sort of message) for all documents.
1
1.4. Spacing
• Document line spacing should be 1.5 with the exceptions of captions, lists, graphs,
charts, items with tables and lists in the appendices.
• The alignment of each paragraph should be justified.
• Lengthy tables may be 1 line spaced.
• Format paragraphs with 6-point spacing after paragraph end. New paragraphs to
start on next line (that is, there is no need of an extra line between paragraphs if
paragraphs are formatted as suggested). No paragraph indents necessary.
• Each chapter must start on a new page. Chapter title should be centered and a
Heading 1.
1.5. Tables
• Tables should be consecutively numbered and labeled. Table numbering should
indicate the chapter where it resides in. The table label should be above the
tables.
1.6. Figures
• Figures should be consecutively numbered and labeled. Figure numbering should
indicate the chapter where it resides in. The figure label should be below the
figures.
1.7. Margins
• Use the custom margins bellow for your document
o Top : 1
o Bottom : 1
o Left : 1.25
o Right : 1
2
1.9. References
Reference numbers should be cited within the text as well as figure/table captions either as
superscripts or enclosed in square brackets. Sources must be cited using any citing standards
(APA, IEEE Chicago etc. also bibliographies accordingly. Uniformly but don’t mix one
References are cited to convey to the reader that the idea, concept, formulation, data, inference
or information being discussed is attributable to the cited literature. All figures/tables, which
are taken from literature, must be acknowledged by citing the reference number or the author
and the year of publication at the end of the caption.
The main reference sources include books/monographs/ handbooks, archived journal papers,
conference papers in published proceedings, institutional technical reports, thesis/ project
documents, dissertations and other archived reports and standards. Internet websites are also
increasingly becoming an important source. However, it should be noted that Internet
references should not form the entire list of references. Allowing URLs as references must not
be misunderstood to mean that all Internet material is acceptable. Internet material may be
transitory, may not be technically reviewed and may have questionable authenticity, that is, it
may not be proper archival material. It may be used as secondary information source to
supplement the main sources.
3
3. PRELIMINARY PAGE
3.1. Cover Page
The cover page should be informative and consist of the names of the university , school name,
department name (the academic degree sought), project title, the name and identification Number
of students, advisor name, the location followed by the month and year are the last items on the
cover page. For more detail information about cover page please refer Appendix I.
3.2. Title Page
The title page of a project must include the following information:
1. The title of the project work is in capitalize each first word font sized 16 and centered 2″
below the top of the page.
2. Project member names, centered 1″ below the title. Do not include titles, degrees, or
identifiers.
3. The following statement, centered, 1″ below your name: “A [project] submitted to [name
of university] in partial fulfillment of the requirements for the degree of [insert degree] in
the [insert department or program name] in the [named school].” End this statement with a
period, for more detail refer sample title page on Appendix II.
3.3. Declaration Page
This page should declare that the project comprises one’s own work. In compliance with
internationally accepted practices, it should acknowledge and refer all materials used in the
work, refer sample declaration page on Appendix III.
3.4. Approval Page
Before submission the project work you should be approved by an advisor, department heads, and
examiners; use Appendix IV.
3.5. Acknowledgement
Acknowledgement is the project work member’s statement of gratitude to and recognition of
the people and institutions that helped in project work.
3.6. Table of Contents
Include a table of contents following these guidelines:
• Include the heading 1 “TABLE OF CONTENTS” in all capital letters, and center it
2″ below the top of the page.
• Include one double-spaced line between the heading and the first entry.
• The table of contents must list all parts of the industrial project work that follow it.
4
• If relevant, be sure to list all appendices and a references section in your table of
contents. Include page numbers for these items but do not assign separate chapter
numbers.
• Page numbers listed in the table of contents must be located just inside the right page
margin with leaders (lines of periods) filling out the space between the end of the entry
and the page number. The last digit of each number must line up on the right margin.
• Information included in the table of contents must match the headings, subheadings,
and numbering used in the body of the industrial project.
• Subdivisions of headings should not exceed four levels.
• The Table of Contents page(s) must be numbered with consecutive lower case Roman
numerals. Refer Appendix V.
3.7. List Figures and Tables
If applicable, include a list of table and list of figures, following these guidelines:
• Include the heading 1 “LIST OF FIGURES” and “LIST OF TABLES” in all capital
letters, centered 1″ below the top of the page.
• Include one double-spaced line between the heading and the first entry.
• Each entry must include a number, title, and page number.
• Page numbers must be located just inside the right page margin with leaders (lines of
periods) filling out the space between the end of the entry and the page number.
• Numbers, titles, and page numbers must each match the corresponding numbers, titles, and
page numbers appearing in the project.
• All Lists of Tables, Figures, and Illustrations page(s) must be numbered with consecutive
lower case Roman numerals. See Appendix VI.
5
3.9. Abstract
Include an abstract page according to the following guidelines:
• Include the heading 1 “ABSTRACT” in all capital letters, and center it 2″ below the
top of the page.
• Your abstract should contain introduction (2-3 lines), statement of the problem (2-4
lines), general objective, methodology of the project (3-5 lines), proposed solutions
(3-6 lines), testing result and discussion (at least 2 lines) and conclusion and
recommendation (2-4 lines).
• The text of your abstract must be similar fonts with the body of the text and aligned
with the document's left margin with the exception of indenting new paragraphs. Do
not center or right-justify the abstract.
• Abstracts cannot exceed one page for a project work.
• Abstract page number should be with the lower case Roman numeral.
• Avoid mathematical formulas, diagrams, references and other illustrative materials in
the abstract.
In the main body of the project work, the group member presents the narrative argument. The
text is divided into major divisions (Chapters), each presenting a main point in the argument.
Each major chapter usually contains subdivisions that will aid the reader in understanding the
given information. Main body of the industrial project work contains(but not limited) seven
chapters with its description you can refer below:
6
CHAPTER ONE
1. INTRODUCTION
Reasons for studying the problem selected should be listed. Project works already done in that
area should be mentioned. Here, you need to discuss about the significance of your focus area.
Besides, the problem area and motivation to the need for your project work is described.
Moreover, if your focus area leans on a specific organization you need to say so about the
organization.
1.1. Background of the System
Here you are expected to describe mission, vision and objective of the organization for
which you are going to develop the new system, organization structure.
1.2. Statement of the Problem
Here you are expected to describe specifically what the problem is and the problem that you
intend to solve. Describe how the existing system functions (manual, semi –automated,
automated) and then list and describe the problems in the existing system.
Test the set of objectives against the problem statement and ask yourself whether the research
objectives address the problem statement.
NOTE: your research objectives are what you have promised to address, so you must make
sure that you fulfill your promises in the completed study
7
1.4. Scope and Limitation of the Project
Here you need to define specific boundaries of your project in terms of what the project
does and what the project doesn’t.
1.4.1. Scope of the Project
Describe specific boundaries of your project in terms of what the project does.
8
CHAPTER TWO
2. REQUIREMENT ANALYSIS
2.1. Overview of Existing System
Describe the excising system how it works in detail step by step.
Use Case: System function and named by verb + Noun (or Noun Phrase).
9
2.5.2. Use Case Diagram
Draw a diagram that shows system boundary, use cases, actors and their relationships by using
<<include>> or <<extend>>. Also, you should have to illustrate the interaction of each actor
with each use case using modelling tools like E-Draw max, Visio, rational rose and others.
10
CHAPTER THREE
3. PROPOSED SYSTEM
In this chapter you are expected to discuss the overall description of your proposed(new)
system in way that it could solve the problems that you have identified in previous chapter(s).
3.3.6. Installation
Installation is a process during which the current system is replaced by the new system. It
consists of the following.
▪ Installation of user guides
▪ Installations and conversion plan
o software and hardware installation schedule
o data conversion plan: how do your new system accept organizations long
time data.
11
3.3.7. Documentation
Here how do you submit your final work to your target office after the project completion.
3.3.9. Maintenance
System won’t be healthy throughout its life. So how do you maintain these unconditional failures?
Also, what if the organization (your client) asks you to extend the functionality of the system?
3.4. Tools
In this section and subsections, you should mention hardware or software tools that you are
going to use. For example, programing languages and its editor, database technologies,
documentation tools, unified modeling language (UML) design tools, hardware tools for
deployment purpose etc. That means describe your tools with their detail specifications and
purposes (like Frontend Technologies, Backend Technologies, Documentation and Modeling Tools,
Deployment Environment) or reasons why you have selected them.
What kind of interface should the system provide? What is the level of expertise of the
users?
• Hardware Consideration
12
Are there hardware compatibility requirements? Will the system interact with other
hardware system?
• Security Issues
Should the system be protected against internal and external intrusions or against an
authorized user? To what level? What security algorithm applied for your system?
• Performance Consideration
How responsive should the system be? How many concurrent users should it support? What
is a typical or extreme load?
• Error Handling and Validation
How should the system handle exceptions? Which exceptions should the system handle?
What is the worse environment in which the system is expected to perform?
• Quality Issues
How reliable/available/robust should the system be? What is the client’s involvement in
assessing the quality of the system or the development process?
How, when and where to take backup? How to recover the system when your system fail?
• Physical Environment
Where will the system be deployed? Are there external factors such as weather conditions
that the system should withstand?
• Resource Issues
• Documentation
What level of document is required? Should only user documentation be provided? Should
there be technical documentation for maintainers? Should the development process be
documented?
13
3.6.2. Operational Feasibility
Operational feasibility is mainly concerned with issues like whether the system will be used if
it is developed and implemented. And also, does management support the project? Are the
users not happy with current business practices? Will it reduce the time (operation)
considerably?
3.6.3. Economical Feasibility
For any system if the expected benefits equal or exceed the expected costs, the system can be judged
to be economically feasible. In economic feasibility, cost benefit analysis is done in which expected
costs and benefits are evaluated. Economic analysis is used for evaluating the effectiveness of the
proposed system. In economic feasibility, the most important is cost-benefit analysis.
CHAPTER FOUR
4. SYSTEM DESIGN
4.1. Overview
3.4.5. Normalizations
14
Remaining chapters will be continued in second semester
CHAPTER FIVE………
CHAPTER N………
----------------------------------------------------------------------------------------------------------------
5. REFERENCES
List all papers, books, book sections, web sites, monographs, URLs of Internet archives or of
permanent information sources, strictly as per the specific format. The references should be
ordered in a convenient way. You should use consistent referencing style such as (IEEE, APA
etc.).
6. APPENDICES
If your industrial project has appendices, they must be prepared following these guidelines:
• Appendices must appear at the end of the document and not the chapter to which they
pertain.
• When there is more than one appendix, assign each appendix a number or a letter heading
(e.g., “APPENDIX 1” or “APPENDIX A”) and a descriptive title. You may number
consecutively throughout the entire work (e.g., 1, 2 or A, B), or you may assign a two-part
Arabic numeral with the first number designating the chapter in which it appears, separated
by a period, followed by a second number or letter to indicate its consecutive placement
(e.g., “APPENDIX 3.2” is the second appendix referred to in Chapter Three).
• Include the chosen headings in all capital letters, and center them 1″ below the top of the
page.
• All appendix headings and titles must be included in the table of contents.
15
Appendix I: Sample Cover page
BY
NAME OF THE STUDENTS IDNO
<<Times New Roman, 12>>
16
Appendix II: Sample Title page
BY
NAME OF THE STUDENTS IDNO
<<Times New Roman, 12>>
17
Appendix III: Sample Declaration page
DECLARATION
This is to declare that this project work which is done under the supervision of <<Your Advisor
Here>> and having the title <<Your Title Here>> is the sole contribution of:
No part of the project work has been reproduced illegally (copy and paste) which can be
considered as Plagiarism. All referenced parts have been used to argue the idea and have been
cited properly. We will be responsible and liable for any consequence if violation of this
declaration is proven.
Date: _____________________
Group Members:
____________________________________ ____________________
____________________________________ ____________________
____________________________________ ____________________
____________________________________ ____________________
____________________________________ ____________________
____________________________________ ____________________
____________________________________ ____________________
18
Appendix IV: Sample Approval Form
Approval Form
This is to confirm that the project report entitled <<Your Project title here>> submitted to
Ambo University Woliso Campus, School of Technology and Informatics, Department of
Information Systems by: <<list group members name here>> is approved for submission.
19
Industrial Project Report
Cover Page
Title Page
Declaration
Approval Form
Acknowledgement
Table of Contents
List of Figures
List of Tables
List of Abbreviations
Abstract
CHAPTER ONE
1.1. INTRODUCTION
1.2. Background of the system
1.3. Statements of the Problem
1.4. Objective of the project
1.4.1. General Objective
1.4.2. Specific Objectives
1.5. Scope and Limitations
1.5.1. Scope of the project
1.5.2. Limitations of the project
1.6. Risks, constraints and Assumptions
1.7. Significance of the project
1.8. Beneficiary of the project
1.9. Document Organization
CHAPTER TWO
2. REQUIREMENT ANALYSIS
2.1. Overview of the Existing system
2.2. Major Functions of the existing System
2.3. Business process of existing system supported by tables, forms, documents etc. (if any)
2.4. Business Rule of existing system
20
2.5. Business use case modeling
2.5.1. Actors and use case descriptions
2.5.2. Use Case Diagram
2.5.3. Use case Scenario
2.6. Strength, Weakness, opportunity, and threats analysis of the existing system
2.7. Problem of the existing system
21
Chapter THREE
3. PROPOSED SYSTEM
3.1. overview
3.3.5. Installation
3.3.6. Documentation
3.3.8. Maintenance
3.5. Tools
3.5.1. Hardware tools
3.5.2. Software tools
3.6. Requirement specification
3.6.1. Functional requirements
3.6.2. Non-Functional requirements
3.7. Feasibility study
3.7.1. Technical Feasibility
3.7.2. Operational Feasibility
3.7.3. Economic Feasibility
3.7.4. Schedule feasibility
22
CHAPTER FOUR
4. SYSTEM DESIGN
4.1. Overview
3.4.5. Normalizations
…………………………………………………………………………………………………………………………………………………………..
➢ REFERENCES
➢ APPENDICES
23