Wolkite University

Download as docx, pdf, or txt
Download as docx, pdf, or txt
You are on page 1of 42

WOLKITE UNIVERSITY

COLLEGE OF COMPUTING AND INFORMATICS


Industrial Project Guideline

Prepared by:

 Ermiyas Birhanu (MSc.)


 Worku Muluye (MSc.)
 Zerihun Mulugeta (MSc.)

Wolkite University, Wolkite, Ethiopia

November 6, 2018
Table of Contents
1. Overview of Industrial Project ............................................................................................. 7
1.1. Industrial Project Guideline.............................................................................................. 7
1.2. Minimum Standards ......................................................................................................... 8
1.3. General Instruction to Prepare Document ...................................................................... 9
2. OBJECTIVE ...................................................................................................................... 10
3. DOCUMENT STYLE AND FORMATTING................................................................... 11
3.1. Language ........................................................................................................................ 11
3.2. Paper Size and Specification .......................................................................................... 11
3.3. Font ................................................................................................................................ 11
3.4. Spacing ........................................................................................................................... 12
3.5. Tables ............................................................................................................................. 12
3.6. Figures ............................................................................................................................ 12
3.7. Margins........................................................................................................................... 12
3.8. Page Numbers ................................................................................................................ 12
3.9. References ...................................................................................................................... 13
4. PRESENTATION SLIDE FORMATTING ...................................................................... 14
5. INDUSTRIAL PROJECT EVALUATION CRITERIA ................................................... 15
6. PRELIMINARY PAGE ..................................................................................................... 15
6.1. Cover Page...................................................................................................................... 15
6.2. Title Page ........................................................................................................................ 15
6.3. Declaration Page ............................................................................................................ 15
6.4. Approval Page ................................................................................................................ 15
6.5. Acknowledgement ......................................................................................................... 16
6.6. Table of Contents ........................................................................................................... 16
6.7. List Figures and Tables ................................................................................................... 16
6.8. List of Abbreviations ....................................................................................................... 17
6.9. Abstract .......................................................................................................................... 17
7. MAIN BODY OF THE PROJECT WORK....................................................................... 18
CHAPTER ONE ........................................................................................................................ 19
1. INTRODUCTION ............................................................................................................. 19
1.1. Background of the Organization .................................................................................... 19
1.2. Statement of the Problem.............................................................................................. 19
1.3. Objectives of the Project ................................................................................................ 19
1.3.1. General Objective ................................................................................................... 19
1.3.2. Specific Objectives .................................................................................................. 19
1.4. Feasibility Analysis.......................................................................................................... 20
1.4.1. Technical Feasibility ................................................................................................ 20
1.4.2. Operational Feasibility ............................................................................................ 20
1.4.3. Economical Feasibility ............................................................................................. 20
1.5. Scope and Limitation of the Project ............................................................................... 20
1.5.1. Scope of the Project ................................................................................................ 20
1.5.2. Limitation of the Project ......................................................................................... 20
1.6. Significance of the Project .............................................................................................. 21
1.6.1. Beneficiary of the Project ....................................................................................... 21
1.7. Methodology of the Project ........................................................................................... 21
1.7.1. Data Collection Tools/Techniques .......................................................................... 21
1.7.2. System Analysis and Design .................................................................................... 21
1.7.3. System Development Model .................................................................................. 21
1.7.4. Testing Methodology .............................................................................................. 21
1.7.5. Development Tools and Technologies .................................................................... 21
1.7.5.1. Frontend Technologies .................................................................................... 21
1.7.5.2. Backend Technologies ..................................................................................... 21
1.7.5.3. Documentation and Modeling Tools ............................................................... 21
1.7.5.4. Deployment Environment ............................................................................... 21
1.8. Budget and Time Schedule of the Project...................................................................... 21
1.8.1. Budget of the Project .............................................................................................. 22
1.8.2. Time Schedule of the Project .................................................................................. 22
1.9. Team Composition ......................................................................................................... 22
1.10. Document Organization ............................................................................................. 22
CHAPTER TWO ....................................................................................................................... 23
2. DESCRIPTION OF THE EXISTING SYSTEM .............................................................. 23
2.1. Introduction of Existing System ..................................................................................... 23
2.2. Users of Existing System................................................................................................. 23
2.3. Major Functions of the Existing System ......................................................................... 23
2.4. Forms and Other Documents of the Existing Systems (if any)....................................... 23
2.5. Drawbacks of the Existing System.................................................................................. 23
2.6. Business Rules of the Existing System ............................................................................ 23
CHAPTER THREE ................................................................................................................... 24
3. PROPOSED SYSTEM ...................................................................................................... 24
3.1. Functional Requirements ............................................................................................... 24
3.2. Nonfunctional Requirements ......................................................................................... 24
3.2.1. User Interface and Human Factors ......................................................................... 24
3.2.2. Hardware Consideration ......................................................................................... 24
3.2.3. Security Issues ......................................................................................................... 24
3.2.4. Performance Consideration .................................................................................... 24
3.2.5. Error Handling and Validation ................................................................................ 25
3.2.6. Quality Issues .......................................................................................................... 25
3.2.7. Backup and Recovery .............................................................................................. 25
3.2.8. Physical Environment.............................................................................................. 25
3.2.9. Resource Issues ....................................................................................................... 25
3.2.10. Documentation ....................................................................................................... 25
CHAPTER FOUR ...................................................................................................................... 26
4. SYSTEM ANALYSIS ....................................................................................................... 26
4.1. System Model................................................................................................................. 26
4.1.1. Use Case Model ...................................................................................................... 26
4.1.1.1. Use Case Diagram ............................................................................................ 26
4.1.1.2. Use Case Description ....................................................................................... 26
4.1.1.3. Use case Scenario ............................................................................................ 26
4.2. Object Model .................................................................................................................. 26
4.2.1. Class Diagram .......................................................................................................... 27
4.2.2. Data Dictionary ....................................................................................................... 27
4.3. Dynamic Model .............................................................................................................. 27
4.3.1. Sequence Diagram .................................................................................................. 27
4.3.2. Activity Diagram ...................................................................................................... 27
4.3.3. State Chart Diagram ................................................................................................ 27
CHAPTER FIVE ....................................................................................................................... 28
5. SYSTEM DESIGN ............................................................................................................ 28
5.1. Design Goals ................................................................................................................... 28
5.1.1. Performance ........................................................................................................... 28
5.1.2. Dependability .......................................................................................................... 28
5.1.3. Maintenance ........................................................................................................... 28
5.1.4. End user .................................................................................................................. 28
5.1.5. Priorities of Design Goal ......................................................................................... 28
5.2. Current System Architecture (if any) ............................................................................. 28
5.3. Proposed System Architecture....................................................................................... 28
5.3.1. Subsystem Decomposition and Description ........................................................... 28
5.3.2. Hardware/Software Mapping ................................................................................. 28
5.3.3. Detailed Class Diagram ........................................................................................... 28
5.3.4. Persistent Data Management ................................................................................. 29
5.3.5. Access Control and Security .................................................................................... 29
5.4. Packages ......................................................................................................................... 29
5.5. Algorithm Design ............................................................................................................ 29
5.6. User Interface Design ..................................................................................................... 29
CHAPTER SIX .......................................................................................................................... 30
6. IMPLEMENTATION AND TESTING ............................................................................ 30
6.1. Implementation of the Database ................................................................................... 30
6.2. Implementation of the Class Diagram ........................................................................... 30
6.3. Configuration of the Application Server ........................................................................ 30
6.4. Configuration of Application Security ............................................................................ 31
6.5. Implementation of User Interface ................................................................................. 31
6.6. Testing ............................................................................................................................ 31
6.6.1. Testing Tools and Environment .............................................................................. 31
6.6.2. Unit Testing ............................................................................................................. 31
6.6.3. System Testing ........................................................................................................ 31
6.6.4. Integration Testing .................................................................................................. 31
6.6.5. Acceptance Testing ................................................................................................. 31
CHAPTER SEVEN ................................................................................................................... 32
7. CONCLUSION AND RECOMMENDATION ................................................................. 32
7.1. Conclusion ...................................................................................................................... 32
7.2. Recommendation ........................................................................................................... 32
8. REFERENCES .................................................................................................................. 32
9. APPENDICES ................................................................................................................... 33
9.1. Appendix A: Interview and Questionnaires (if any) ....................................................... 34
9.2. Appendix B: Existing System Forms and Reports ........................................................... 34
9.3. Appendix C: Sample Source Code .................................................................................. 34
1. Overview of Industrial Project

1.1. Industrial Project Guideline


The Industrial Project is intended to be a capstone experience that draws on the previous four years
of course work. The industrial Project should therefore be sufficient in scope and technical content
in order to expose students’ technical competence developed during their education at Wolkite
University. The Project’s specific topic can be in any field of computer Science, Software
Engineering, Information Sciences and Information Technology or similar areas. It is also
expected that the project be carried out by a team of 3-6 senior students under the supervision of
related department instructor (s). The project’s duration is expected to run over two semesters and
graded at the end of each semester.
Industrial Project is an important part of computing discipline at undergraduate level. The main
purpose of these projects is to encourage students to apply the knowledge acquired during their
studies. Students are also expected to show how proficient they are in solving real world problems
with certain constraints for the outcome-based evaluation set by the department of computing
discipline. Consequently, all college of computing and Informatics students are required to
participate in group based industrial projects provided in the first and second semesters of their
final year. The industrial projects involve a significant software development techniques and
principles.
To this end, each department under college of computing and Informatics requires its students to
demonstrate knowledge right from project planning to implementation. This project guideline is
to assist students on the rules and procedures that should be followed in order to plan and execute
a productive and successful industrial project. This guideline is also used as a reference for all
participants in the industrial project: department advisors and the industrial project evaluation
committee members.
This document contains information on how to successfully compile a written industrial project
report for Computing Students. This guideline plays an integral role in your project work, in your
report preparation. The sections and sub sections tries to elaborate the general report structure
including content, formatting style, and referencing style to be used. Students are encouraged to
stick to the guideline as far as possible. Badly formatted and/or nonstandard styled reports are
irritants to reading and distract attention from the main contents of the report (that is, the work
done).

1.2. Minimum Standards


This project guideline tries to put the minimum requirements that your project must include. For
the purpose of this section we classify projects into four broad categories:
1. Web based System Development
2. Mobile Application Development
3. Game Application Development
4. Desktop Application Development
5. Artificial Intelligence
6. Compiler Design
 Web based System Development
Your web based system should be client/server based. The client part should be developed using
HTML/HTML5, CSS, JavaScript, Ajax, JQuery and other similar technologies. The server part
should be developed using server side scripting languages like PHP, Perl, ASP, JSP, JSF, and other
similar technologies. On the server side you need to have implemented your database using
database server such as MySQL, PostgreSQL, Microsoft SQL Server, Oracle, MongoDB and other
relational, object oriented, Document, Spatial or other database technologies.
 Mobile Development
o If you are designing software for mobile devices, your application should meet
requirements of good mobile application development guide lines such as, using screen,
battery, storage, computing and other resources efficiently.
o You can develop standalone application or an application that work in collaboration with
other servers, mobile devices, sensors or websites like Facebook, Google, and Twitter.
o For developing your mobile application, you can use technologies such as Android, IOS,
and Microsoft phone.
 Artificial Intelligence (AI)
Artificial intelligence (AI) is an area of computing that emphasizes the creation of intelligent machines
that work and react like humans. Some of the activities computers with artificial intelligence are
designed for includes: speech recognition, expert systems, handwriting recognition and robotics. Your
artificial intelligence projects can be developed by using prolog, python, java and other similar
technologies.
 Compiler Design
Compiler is a software which converts a program written in high level language (Source Language)
to low level language (Object/Target/Machine Language). Your Compiler Design projects can be
developed by using C, Lex/Yacc, C++, java and other similar technologies.
Other Systems
Any other software system that can solve real world problems can come under this category.
Your software under this category can be an application that follows client/server architecture,
peer-to-peer architecture, or it can be standalone software. You can use C#, Java, Python, Ruby or
any other programming language to develop your software. Use of IDE such as Microsoft Visual
Studio, IntelliJ Idea, Net beans, Eclipse, or any other Software development environment that will
assist you in accomplishing your task is highly recommended.
You are expected to provide setup file or deployment mechanism for your system.
Note: For all of your systems
 Appropriate user interface which apply the major user interface design principles is expected.
 Unit Testing, input validation and exception handling components are expected to be included
 Appropriate login and logout mechanisms must be there.
 In your database there must be at least three related tables
 All your database tables should have appropriate field names, primary key, foreign key and
indexes.
 All relational databases must be normalized at least up to third normal form

1.3. General Instruction to Prepare Document


This document is divided into seven major sections. Section one introduced about the industrial
project and section two describes the objective of this documentation style and formatting and
sections three and four explain about presentation slide formats. Section five discusses about the
evaluation criteria by advisors and examiners. Section six details about the preliminary page
phases that students should pass through to complete their project. Finally, section seven details
about main body of the project work that students should pass through to complete their project.

2. OBJECTIVE
This Industrial project guideline aims to:
 Help students to have a good insight on the rules and procedures that should be followed
in industrial project planning, design and implementation phases.
 Assist students use consistent formatting throughout their documentation.
 Inform Instructors and students about the evaluation and grading policies.
3. DOCUMENT STYLE AND FORMATTING
College of Computing and Informatics sets 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 mechanical issues are the sole
responsibilities of the group members.
3.1. Language
• The industrial project document must be prepared in English.
3.2. Paper Size and Specification
• You have to use a standard A4 (8.27" X 11.69") paper size.
3.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.
3.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.

3.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.

3.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.
3.7. Margins
 Use the custom margins bellow for your document
o Top : 1
o Bottom : 1
o Left : 1.25
o Right : 1

3.8. Page Numbers


 Except for the title page, number all pages which come before the first page of the body
chapters consecutively with lower case roman numerals (i, ii, iii, iv…).
 The first page with Arabic numeral (1, 2, 3, and so on) starts from the page of the
introduction. Put page numbers right aligned.
3.9. References
Reference numbers should be cited within the text as well as figure/table captions either as
superscripts or enclosed in square brackets. In this way of citation, all references should be
numbered (Arabic numerals) in the order in which they are first cited in the report. Another
alternative is citing references using the author’s last name and the year the material published.
Here, all references should be arranged in a chronological ascending order. Strictly avoid citing
references in chapter/section/subsection titles. 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, theses/ 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.
List references at the end of the paper in either numerical order or chronologically ascending order.
Sample references could be as listed below:
 For a book: with one author, book title (bold), publisher, city, year.
Example: [1]. N. Storey, Electronics: a systems approach. 4th ed. Harlow: Pearson, 2009.
For a journal paper: author(s), paper title (bold), journal name, volume number, issue number, page
numbers (inclusive), publisher, year.
Example: [1] S. Mack. “Desperate Optimism.” M.A. thesis, University of Calgary, Canada,
2000.
For website: author, title, URL, accessed date
Example: [1] S. Calmer. Engineering and Art. (2nd edition),
www.enggart.com/examples/students.html [May 21, 2003].
4. PRESENTATION SLIDE FORMATTING
You are expected to defend your project by preparing an attractive presentation. Developing an
outline or structure for your presentation will help you communicate a clear and meaningful
message to your audience.
4.1. Slide Layout
 Your slides should have white background with little or no graphics.
 Your bullet points should be short and quick hits and try to keep the number of bulleted
items around six per slide.
4.2. Font
 Use Times New Roman font type with color black.
 Main body contents should be coined in 20-24 pts.
 Font type, size and style of the main content area on all slides except for the title slide
should be the same.
 Title of your project should be maximum of 36 point-size
 Each content slide should have a title and should solely reflect the comprised content.
 The titles should be brief and descriptive. They should not be full sentences.
 The title of each slide should be 30- point size
4.3. Total Number of Slides
A general rule of thumb is one slide per minute. If you have a 20-minute presentation, you should include
about 20 slides. You don’t want to overwhelm your audience with too much information. Focus on the key
concepts you want your audience to remember. However, for the sake of your defense up to 26 slides are
allowable.
Notice: This is one of the biggest mistakes students make with PowerPoint: They cram too much text onto
their slides. Your text-only slides should be short, quick-hit highlights written as phrases rather than
complete sentences. If your audiences are busy reading your slide, they are not going to be paying attention
to you. Or they may not read the slide at all, which renders your Power Point presentation useless. So, make
sure to leave some white space around the main content on your slide. This helps to focus the reader’s
attention on the key information.
5. INDUSTRIAL PROJECT EVALUATION CRITERIA
This section, contains progress evaluations, semester end evaluations, and advisor evaluation
forms.

6. PRELIMINARY PAGE
6.1. Cover Page
The cover page should be informative and consist of the names of the university (Wolkite University),
college name (College of Computing and Informatics), 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.
6.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 Wolkite
University in partial fulfillment of the requirements for the degree of [insert degree] in the
[insert department or program name] in the [named College].” End this statement with a period,
for more detail refer sample title page on Appendix II.
6.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.
6.4. Approval Page
Before submission the project work you should be approved by an advisor, department heads, and
examiners; use Appendix IV.
6.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.
6.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.
 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.
6.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. Refer Appendix VI.
6.8. List of Abbreviations
 Include the heading “LIST OF ABBREVIATIONS” in all capital letters, and center it 1″
below the top of the page.
 Arrange your abbreviations alphabetically.
 Abbreviations must align with the document's left margin or be indented to the right of the
left page margin using consistent tabs.
 If an entry takes up more than one line, single-space between the two lines.
 The List of Abbreviations page(s) must be numbered with consecutive lower case Roman
numerals centered with a 1/2″ margin from the bottom edge.

6.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.
7. MAIN BODY OF THE PROJECT WORK
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 seven chapters with its description
you can refer below:
CHAPTER ONE
1. INTRODUCTION
Reasons for studying the problem selected should be listed. Project works already done in that area
should be mentioned. In 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 Organization
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.

1.3. Objectives of the Project


General and specific objectives of the project to be achieved by the proposed system should be
discussed. Your objective should be SMART (Specific, Measurable, Achievable, Relevant and
Time bounded).
1.3.1. General Objective
Your general objective should incorporate a sentence that begins with “The general objective of this project
is …”, “The main objective of this project is …” and include the applicable area of your project work. It
should be general.

1.3.2. Specific Objectives


Here you are expected to list a number of activities which has to be done to achieve the general
objective. It should be specific and systematically address the various aspect of the problem as
defined under “Statement of the Problem” and the key factor that are assumed to influence or cause
of the problem.

1.4. Feasibility Analysis


Here you are expected to assess the strengths and weaknesses of a proposed project and present
directions of activities which will improve a project and achieve objectives according to
section 1.4.1 – 1.4.4.
1.4.1. Technical Feasibility
Here you are expected to analysis the project in terms whether the required technology is available
or not, Whether the required resources are available, Manpower- programmers, testers &
debuggers, and Software and hardware.

1.4.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?
1.4.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.
1.5. 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.5.1. Scope of the Project
In this section you need to describe specific boundaries of your project in terms of what the
project does.

1.5.2. Limitation of the Project


In this section you need to define specific boundaries of your project in terms of what the project
doesn’t.
1.6. Significance of the Project
The societal and technological importance of your project should be discussed in this part.
1.6.1. Beneficiary of the Project
Who will benefit from the system?

1.7. Methodology of the Project


State how the requirements are gathered, the tools used for analysis and design, model, implement,
test etc. ….

1.7.1. Data Collection Tools/Techniques


In this section you may or may not include observation, questionnaire, interview and document
analysis etc.
1.7.2. System Analysis and Design
In this section you should include object-oriented system analysis and design(OOSAD).
1.7.3. System Development Model
Here you are expected to mention software development life cycle models like iterative, spiral,
V-model or waterfall etc. and describe why do you select the development model.
1.7.4. Testing Methodology
In this section you should may or may not include unit testing, system testing, acceptance testing,
integration testing etc.
1.7.5. Development Tools and Technologies
In this section and subsections, you should mention programing languages and its editor, database
technologies, documentation tools, unified modeling language(UML) design tools, hardware tools
for deployment purpose etc.

1.7.5.1. Frontend Technologies


1.7.5.2. Backend Technologies
1.7.5.3. Documentation and Modeling Tools
1.7.5.4. Deployment Environment
1.8. Budget and Time Schedule of the Project
This section and its subsections included only in your proposal.
1.8.1. Budget of the Project
Here you are expected to describe all costs (Paper cost, pen, mobile card, transport, laptop or
desktop cost, etc.) by using table.

1.8.2. Time Schedule of the Project


Here you are expected to describe the time schedule of your project by using the Gant chart, pert
chart or any other tool.

1.9. Team Composition


Here mention the responsibility and tasks of each group members by using table. This section included
only in your proposal.

1.10. Document Organization


In this section include the chapters and what it describes about.
CHAPTER TWO

2. DESCRIPTION OF THE EXISTING SYSTEM

2.1. Introduction of Existing System


Describe the excising system how it works in detail step by step.

2.2. Users of Existing System


Here you are expected to describe the users and their responsibilities in the existing system …

2.3. Major Functions of the Existing System


Describe the excising system major functions.

2.4. Forms and Other Documents of the Existing Systems (if any)
Here the includes sample scan image of reports, forms and other related documents that used in
the existing system and the remaining forms and reports should be included in Appendix section.

2.5. Drawbacks of the Existing System


In this section describe the existing system disadvantages and many more difficulties to work
well.

2.6. Business Rules of the Existing System


List any operating principles about the product, such as which individuals or roles can perform
which functions under specific circumstances. These are not functional requirements in
themselves, but they may imply certain functional requirements to enforce the rules.
CHAPTER THREE
3. PROPOSED SYSTEM
In this chapter you are expected to discuss the overall description of your proposed system,
functional requirements, and non-functional requirements.
3.1. Functional Requirements

Here you are expected to mention what your system should do. Functional requirements specify a
function that a system or system component must be able to perform. Mention product features or
functions that developers must implement to enable users to accomplish their tasks.
3.2. Nonfunctional Requirements

In this section describe nonfunctional requirements place constraints on how the system will do
so. Depend on your project the nonfunctional requirement may be vary. So, list all the
nonfunctional requirements which are relevant to your system like:
3.2.1. User Interface and Human Factors

What kind of interface should the system provide? What is the level of expertise of the users?
3.2.2. Hardware Consideration

Are there hardware compatibility requirements? Will the system interact with other hardware
system?
3.2.3. 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?
3.2.4. Performance Consideration

How responsive should the system be? How many concurrent users should it support? What is a
typical or extreme load?
3.2.5. 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?
3.2.6. 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?
3.2.7. Backup and Recovery

How, when and where to take backup? How to recover the system when your system fail?
3.2.8. Physical Environment

Where will the system be deployed? Are there external factors such as weather conditions that the
system should withstand?
3.2.9. Resource Issues

What are the constraints on the resources consumed by the system?


3.2.10. 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?
CHAPTER FOUR
4. SYSTEM ANALYSIS
In this chapter, you should have discussed about use case model, object model and dynamic
models.
4.1. System Model

Here you are expected to mention an overview of system model.


4.1.1. Use Case Model

In this section, you are expected to model comprised use case diagram, use case definitions, and
actor definitions to document the functional requirements of a system. Also, you should have to
identify each actor and use cases of the system based on the functional requirement.
4.1.1.1. Use Case Diagram

Here draws 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 and others.

Actor: Someone interacts with use case (system function), and named by noun.

Use Case: System function, and named by verb + Noun (or Noun Phrase).
4.1.1.2. Use Case Description

Here you are expected to write the description of each use case in tabular form by using narrative
style or action response style.
4.1.1.3. Use case Scenario
Scenarios are an instance (example) of a use case explaining a concrete major set of action.
Scenario or use case realizations are just a sequential narrative description of events or an instance
of a use case.
4.2. Object Model

In this section, discussed an overview of object model.


4.2.1. Class Diagram

In this section you are expected to illustrate (diagrammatically) the conceptual relationship among
objects/classes without including visibility of data and members, association, generalization,
cardinality etc.
4.2.2. Data Dictionary

In this section mention attributes, data type, data size, key constraints and constraints of the
identified entities or classes by using tabular form.
4.3. Dynamic Model

The dynamic model represents the time–dependent aspects of a system. It is concerned with the
temporal changes in the states of the objects in a system. In this section you are expected to
document the behavior of the object model, in terms of sequence, activity and state chart diagrams.
4.3.1. Sequence Diagram

In this section, you should have to illustrate (diagrammatically) a sequential logic, in effect, and
the time ordering of messages. From business process perspective. How the business model is
executed?
4.3.2. Activity Diagram
In this section you are expected to illustrate graphical representations of workflows of stepwise
activities and actions with support for choice, iteration and concurrency.
4.3.3. State Chart Diagram

Here you are expected to define different states of an object during its lifetime and these states are
changed by events.
CHAPTER FIVE
5. SYSTEM DESIGN
In this chapter provide a brief overview of the design goals, current and proposed software
architecture, Hardware/software mapping, Persistent data management and Access control and
security.
5.1. Design Goals
The Design Goals specify the qualities of the system that should be achieved and addressed during
the design of the system like:
5.1.1. Performance
5.1.2. Dependability
5.1.3. Maintenance
5.1.4. End user
5.1.5. Priorities of Design Goal
5.2. Current System Architecture (if any)
Current system architecture describes the architecture of the system being replaced.
5.3. Proposed System Architecture
This section presents a general view of your system architecture and briefly describes the
assignment of functionality to each subsystem.
5.3.1. Subsystem Decomposition and Description
Subsystem decomposition draw and describes the decomposition into subsystems and the
responsibilities of each. This is the main product of system design. Here, use UML component
diagram to diagrammatically illustrate your components.
5.3.2. Hardware/Software Mapping
Hardware/software mapping describes how subsystems are assigned to hardware and customized
components (if any). Here, use UML deployment diagram to diagrammatically illustrate the
hardware/software mapping.
5.3.3. Detailed Class Diagram
In this section show, classes, attributes, methods, attribute data types, visibility ((Public (+), Private
(-), Protected (#)) of attributes and methods), inheritance, association, aggregation, composition,
dependency, and municipality (cardinality and optimality). Here, uses the UML class diagram to
specify attributes and operations with their visibility information.
5.3.4. Persistent Data Management
Persistent data management describes the persistent data stored by the system and the data
management infrastructure required for it. This section typically includes the description of data
schemes, the selection of database, and the description of the encapsulation of the database. Here,
use relational database or Object diagram if you are using object database. In this section, map
class diagram to table.
5.3.5. Access Control and Security
Access control and security describes the user model of the system in terms of an access privilege.
Utilize global access table, describing the access relation between the actors, objects and
operations in the system. You can use tables to show the privilege assigned to each users of the
system. This section also describes security issues, such as the selection of an authentication
mechanism, the use of encryption, and the management of keys.
5.4. Packages
This section describes the decomposition of subsystems into packages and the file organization of
the code. This includes an overview of each package, its dependencies with other packages, and
its expected usage. Here, use UML package diagram to diagrammatically depict your packages.
5.5. Algorithm Design
For the elements found in architectural design define the algorithm required for each element to
accomplish its tasks.
5.6. User Interface Design
Describe the logical characteristics of each interface between the software product and the users.
This may include sample screen images, any GUI standards or product family style guides that are
to be followed, screen layout constraints, standard buttons and functions (e.g., help) that will
appear on every screen, keyboard shortcuts, error message display standards, and so on. Define
the software components for which a user interface is needed.
CHAPTER SIX
6. IMPLEMENTATION AND TESTING
In this chapter, discuss about implementation of database, detailed class diagram, application
server, application security,
6.1. Implementation of the Database
You should choose appropriate database management system, with justified reason and should
perform the following activities:
 All tables which were identified and shown as persistent model in the design document should
be created with their primary keys, foreign keys, check constraints and unique constraints.
 All tables should satisfy at least third normal form
 Whenever you found appropriate, implement the following: Indexes, Views, Triggers, Stored
procedures
 Configure a schedule of database backup.
 Configure database level security
6.2. Implementation of the Class Diagram
Implement all the classes on the design of your class diagram by your target programming
language. Define attributes with the appropriate data type and access visibilities (private, protected,
public) and implement according to the business logic. Define all methods with appropriate return
type, parameters and the corresponding data types and access visibility and implement with
specified logic. Document all your object code with standard comments and implement all the
reports as shown on your design document.
6.3. Configuration of the Application Server
Here uses an appropriate application server for their development and clearly justified the reasons
about their application server selection. Also, perform the following activities:
 Properly start and shutdown the application server.
 Organize folders and files on the server properly.
 Configure the server to work on the same machine: Able to access contents from the same
machine.
 Configure the server to work on from remote machine: Able to access contents from
another/remote machine.
 Separation of application server and database: E.g. Not using web development
environments like WampServer.
 Configure the server to work on different port number.
6.4. Configuration of Application Security
From the security aspect of any system, students should take in to account the following tasks.
 Implement all input validations properly
 Implement encryption/deception
 Roles must be defined clearly
 User accounts must be assigned with necessary access privileges
 Sessions should be implemented.
 All none functional requirements as described in the system feature part must be checked.
6.5. Implementation of User Interface
Regarding to the user interface, students are expected to apply the following.
 The user interface must be user centered design (Place users in control of the interface)
 Reduce users’ memory load
 Make the user interface consistent.
6.6. Testing
In this section and subsections, you are expected to describe which kind of testing technique you
are going to apply and also should mention the test results.
6.6.1. Testing Tools and Environment
6.6.2. Unit Testing
6.6.3. System Testing
6.6.4. Integration Testing
6.6.5. Acceptance Testing
CHAPTER SEVEN

7. CONCLUSION AND RECOMMENDATION


Matching of the conclusions with the objectives framed and fulfillment of the objectives are taking
into consideration in this part. Further scope and further enhancement of the work done also
indicated here.

7.1. Conclusion

7.2. Recommendation

8. 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.).
You are required to list all the references you consulted. Your reference pages must be prepared
following these guidelines:
 Always begin references on a separate page either immediately following at the end of your
entire document.
 Select an appropriate heading for this section based on the style manual you are using
(“REFERENCES”)
 The heading in all capital letters, and center it 1″ below the top of the page.
 References must be single-spaced within each entry.

9. 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.
9.1. Appendix A: Interview and Questionnaires (if any)

9.2. Appendix B: Existing System Forms and Reports

9.3. Appendix C: Sample Source Code

Appendix I: Sample Cover page

WOLKITE UNIVERSITY
COLLEGE OF COMPUTING AND INFORMATICS
DEPARTMENT OF << YOUR DEPARTMENT NAME >>
<<Times New Roman, 18>>
<Title of the Project>
<<Times New Roman, 16 [Bold]>>

BY
NAME OF THE STUDENTS IDNO
<<Times New Roman, 12>>

PROJECT ADVISOR: <ADVISOR’S NAME>


<<Times New Roman, 12>>

Wolkite University, Wolkite, Ethiopia


Month Date, Year
Appendix II: Sample Title page
<<Times New Roman, 12>>

WOLKITE UNIVERSITY
COLLEGE OF COMPUTING AND INFORMATICS
DEPARTMENT OF << YOUR DEPARTMENT NAME >>
<<Times New Roman, 18>>
<Title of the Project>
<<Times New Roman, 16 [Bold]>>
SUBMITED TO DEPARTMENT OF (YOUR DEPARTMENT NAME)
IN PARTIAL FULFILMENT OF THE REQUIREMENT FOR
THE DEGREE OF BACHLER OF SCIENCE IN (YOUR DEPARTMENT
NAME)
<<Times New Roman, 14 >>

BY
NAME OF THE STUDENTS IDNO
<<Times New Roman, 12>>

PROJECT ADVISOR: <ADVISOR’S NAME>


<<Times New Roman, 12>>

Wolkite University, Wolkite, Ethiopia


Month Date, Year
<<Times New Roman, 12>>

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:

<<Group Members Name Here>>

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:

Full Name Signature

_____________________________________ ____________________

_____________________________________ ____________________

_____________________________________ ____________________

_____________________________________ ____________________

_____________________________________ ____________________

_____________________________________ ____________________

_____________________________________ ____________________

Appendix IV: Sample Approval Form

Approval Form
This is to confirm that the project report entitled <<Your Project title here>> submitted to
Wolkite University, College of Computing and Informatics Department of (Your
Department Name) by: <<list group members name here>> is approved for submission.

------------------------------------------------- ------------------------------ ----------------------

Advisor Name Signature Date

------------------------------------------------- ------------------------------ ----------------------


Department Head Name Signature Date

------------------------------------------------- ------------------------------ ----------------------

Examiner 1 Name Signature Date

------------------------------------------------- ------------------------------ ----------------------

Examiner 2 Name Signature Date

------------------------------------------------- ------------------------------ ----------------------

Examiner 3 Name Signature Date

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. INTRODUCTION
1.1. Background of the Organization
1.2. Statement of the Problem
1.3. Objectives of the Project
1.3.1. General Objective
1.3.2. Specific Objectives
1.4. Feasibility Analysis
1.4.1. Technical Feasibility
1.4.2. Operational Feasibility
1.4.3. Economical Feasibility
1.5. Scope and Limitation of the Project
1.5.1. Scope of the Project
1.5.2. Limitation of the Project
1.6. Significance of the Project
1.6.1. Beneficiary of the Project
1.7. Methodology of the Project
1.7.1. Data Collection Tools/Techniques
1.7.2. System Analysis and Design
1.7.3. System Development Model
1.7.4. Testing Methodology
1.7.5. Development Tools and Technologies
1.7.5.1. Frontend Technologies
1.7.5.2. Backend Technologies
1.7.5.3. Documentation and Development Tools
1.7.5.4. Deployment Environments
1.8. Budget and Time Schedule of the Project
1.8.1. Budget of the Project
1.8.2. Time Schedule of the Project
1.9. Team Composition
1.10. Document Organization
CHAPTER TWO
2. DESCRIPTION OF THE EXISTING SYSTEM
2.1. Introduction of Existing System
2.2. Users of Existing System
2.3. Major Functions of the Existing System
2.4. Forms and Other Documents of the Existing Systems (if any)
2.5. Drawbacks of the Existing System
2.6. Business Rules of the Existing System
CHAPTER THREE
3. PROPOSED SYSTEM
3.1. Functional Requirements
3.2. Nonfunctional Requirements
3.2.1. User Interface and Human Factors
3.2.2. Hardware Consideration
3.2.3. Security Issues
3.2.4. Performance Consideration
3.2.5. Error Handling and Validation
3.2.6. Quality Issues
3.2.7. Backup and Recovery
3.2.8. Physical Environment
3.2.9. Resource Issues
3.2.10. Documentation
CHAPTER FOUR
4. SYSTEM ANALYSIS
4.1. System Model
1.1.1. Use Case Model
1.1.1.1. Use Case Diagram
1.1.1.2. Use Case Description
1.1.1.3. Use Case Scenario
4.2. Object Model
4.2.1. Class Diagram
4.2.2. Data Dictionary
4.3. Dynamic Model
4.3.1. Sequence Diagram
4.3.2. Activity Diagram
4.3.3. State Chart Diagram
CHAPTER FIVE
5. SYSTEM DESIGN
5.1. Design Goals
5.1.1. Performance
5.1.2. Dependability
5.1.3. Maintenance
5.1.4. End user
5.1.5. Priorities of Design Goal
5.2. Current System Architecture (if any)
5.3. Proposed System Architecture
5.3.1. Subsystem Decomposition and Description
5.3.2. Hardware/Software Mapping
5.3.3. Detailed Class Diagram
5.3.4. Persistent Data Management
5.3.5. Access Control and Security
5.4. Packages
5.5. Algorithm Design
5.6. User Interface Design
CHAPTER SIX
6. IMPLEMENTATION AND TESTING
6.1. Implementation of the Database
6.2. Implementation of the Class Diagram
6.3. Configuration of the Application Server
6.4. Configuration of Application Security
6.5. Implementation of User Interface
6.6. Testing
6.6.1. Testing Tools and Environment
6.6.2. Unit Testing
6.6.3. System Testing
6.6.4. Integration Testing
6.6.5. Acceptance Testing
CHAPTER SEVEN
7. CONCLUSION AND RECOMMENDATION
7.1. Conclusion
7.2. Recommendation
REFERENCES
APPENDICES

You might also like