graduation project report guidline what should we include in each of the following report sub...

GRADUATION PROJECT GRADUATION PROJECT REPORT GUIDLINEREPORT GUIDLINE

WHAT SHOULD WE INCLUDE IN EACH OF THE WHAT SHOULD WE INCLUDE IN EACH OF THE FOLLOWING REPORT SUB HEADINGS ?FOLLOWING REPORT SUB HEADINGS ?WHERE AND HOW TO OBTAIN THE INFORMATION ?WHERE AND HOW TO OBTAIN THE INFORMATION ?

ABSTRACT (summary)ABSTRACT (summary)INTRODUCTIONINTRODUCTION CURRENT SYSTEM (EXISTING SYSTEM)CURRENT SYSTEM (EXISTING SYSTEM) PROPOSED NEW SYSTEMPROPOSED NEW SYSTEM APPENDICESAPPENDICES USER GUIDEUSER GUIDE GLOSSORYGLOSSORY

GRADUATION PROJECT REPORT GUIDLINESGRADUATION PROJECT REPORT GUIDLINES

PROJECT ABSTRACT (SUMMARY)PROJECT ABSTRACT (SUMMARY)

• This should not be more than one pageThis should not be more than one page It should contain condensed statements extracted from the It should contain condensed statements extracted from the mainmain body of the report to convey the main theme of the body of the report to convey the main theme of the project project to the readers.to the readers.

ie. very brief descriptions of the project, how the project initiated, what ie. very brief descriptions of the project, how the project initiated, what are the recommended solution and the justification of the are the recommended solution and the justification of the recommended solution by emphasising on the key benefits and recommended solution by emphasising on the key benefits and costscosts of the new System as well as any Operational and technical of the new System as well as any Operational and technical concerns.concerns. HINT :- It is best to leave the Project summary as the last task of the HINT :- It is best to leave the Project summary as the last task of the report writing.report writing.


1.1. INTRODUCTION INTRODUCTION

Introduction is the place for a broad, general view of Introduction is the place for a broad, general view of your material. your material.

a) State your Purpose and a) State your Purpose and TTerms of erms of RReference, and indicate eference, and indicate how far you are able to carry them out. how far you are able to carry them out.

b) Provide Background information, b) Provide Background information, in in which your reader will which your reader will need, and which he may not know or clearly remember. need, and which he may not know or clearly remember.

c) Announce the arrangement of your c) Announce the arrangement of your MMain sections. ain sections.

dd) Define and clarify the technical terms ) Define and clarify the technical terms (Jargons) and (Jargons) and abbriviations abbriviations that you intend to use in a special sense.that you intend to use in a special sense.



1.1 1.1 PROJECT OBJECTIVESPROJECT OBJECTIVES

List of the Objectives of the New System. List of the Objectives of the New System. (these should be (these should be

very brief points) f very brief points) for example:-or example:- • To provide faster and more efficient services to the customersTo provide faster and more efficient services to the customers

• To set-up an environment to facilitate the current and To set-up an environment to facilitate the current and future e-commercefuture e-commerce System requirements etc...System requirements etc...



1.2 PROJECT SCOPE AND CONSTRAINTS1.2 PROJECT SCOPE AND CONSTRAINTS

Project Scope means the range or extent of the Project. It Project Scope means the range or extent of the Project. It helps to establish the boundaries of the Requested Systems helps to establish the boundaries of the Requested Systems since it requires a precise statement of the problem. since it requires a precise statement of the problem.

Project Project Constraint is a condition, restriction orConstraint is a condition, restriction or requirements requirements that the that the System System must satisfy. must satisfy.

A constraint can be in terms ofA constraint can be in terms of Time Time, , MMoney or oney or TTechnical echnical concern.concern. e.g:- e.g:- PProject must be ready on 1st January 2004roject must be ready on 1st January 2004 - The project cost must not exceed $- The project cost must not exceed $10100,0000,000 - The new system must be based on companies existing - The new system must be based on companies existing Hardware platform Hardware platform etc etc....


1.3 1.3 DEVELOPMENT METHODOLOGYDEVELOPMENT METHODOLOGY

This section should contain the tools and techniques that are This section should contain the tools and techniques that are used for the Development and implementation of the used for the Development and implementation of the Proposed System. Proposed System.

You should also give a brief justification of the the You should also give a brief justification of the the MMethod ethod and technique that you chose for this project.and technique that you chose for this project.

1.3.1 Systems Development Methods and techniques such 1.3.1 Systems Development Methods and techniques such as:-as:- * * Structured Systems Analysis and Design Methodology Structured Systems Analysis and Design Methodology * * Rapid Application Development technique (RAD) Rapid Application Development technique (RAD) * * Object-Oriented Delopment Methodology (OODM) Object-Oriented Delopment Methodology (OODM) ****** Preferred Methodology for Graduation Project is OODM.Preferred Methodology for Graduation Project is OODM.


1.3.2 Programming Languages 1.3.2 Programming Languages

- Structured Programming Languages- Structured Programming Languages

- - Object-oriented Programming LanguagesObject-oriented Programming Languages (OOP (OOP)***)*** (Preferred Language is OOP)(Preferred Language is OOP)

1.3.3 System Architecture and Processing Methods, 1.3.3 System Architecture and Processing Methods,

(i.e, Client/Server architecture(i.e, Client/Server architecture. 2. 2 tiers, 3 tiere, tiers, 3 tiere, Web-centric, On-line, Batch processing etc...Web-centric, On-line, Batch processing etc...



1.3 1.3 DEVELOPMENT METHODOLOGY (Justification)DEVELOPMENT METHODOLOGY (Justification)

1.3.4 DATA BASE 1.3.4 DATA BASE ARCHITECTUREARCHITECTURE ie; Distributed Database Architecture such as Single ie; Distributed Database Architecture such as Single Database Server, Replicated Database Server, Database Server, Replicated Database Server, Partitioned Database server etc..) Partitioned Database server etc..)

DATA BASE DATA BASE MANAGEMENT SYSTEMS MANAGEMENT SYSTEMS (DBMS)(DBMS)

- - Relational Data Base Management Systems (RDBMS) Relational Data Base Management Systems (RDBMS) - Object Oriented Database Management Systems (ODBMS) - Object Oriented Database Management Systems (ODBMS) - - (i.e Oracle, SQL-Server, MS- Access(i.e Oracle, SQL-Server, MS- Access etc etc ))

1.3.5 HARDWARE and NETWORK PLATFORMS1.3.5 HARDWARE and NETWORK PLATFORMS i.e: IBM PC, APPLE, HP, SUN SOLARIES, Windows NT i.e: IBM PC, APPLE, HP, SUN SOLARIES, Windows NT Novel Netware etc. Novel Netware etc.

H/W AND NERTWORK CONFIGURATIONS H/W AND NERTWORK CONFIGURATIONS

(Ie. RAM, ROM, MPEC etc, ..)(Ie. RAM, ROM, MPEC etc, ..)


.. INTRODUCTION INTRODUCTION

1.3 1.3 DEVELOPMENT METHODOLOGY (Justification)DEVELOPMENT METHODOLOGY (Justification)



1.4 KEY PROJECT BENEFITS1.4 KEY PROJECT BENEFITS

Emphasise on the key Project Benefits. Emphasise on the key Project Benefits.

This could include both tangible and intangible benefits that This could include both tangible and intangible benefits that

are expected once the system becomes are expected once the system becomes operational. operational. e.g - e.g - Significant savings of up to 20% on Fleet Significant savings of up to 20% on Fleet aadministration dministration

Staff costs Staff costs - - Up to 60% Reduction on telephone and telex costsUp to 60% Reduction on telephone and telex costs

- - Improved Customer relationship Improved Customer relationship which which will have a will have a positive affect on Customers loyalty.positive affect on Customers loyalty. etc…. etc….))



1.5 PROJECT DEVELOPMENT PLAN1.5 PROJECT DEVELOPMENT PLAN

The Project Plan provides an overall framework for The Project Plan provides an overall framework for managing the costs and schedulesmanaging the costs and schedules of the Project. of the Project.

Project planning takes place at theProject planning takes place at the beginning and beginning and at the at the end of end of each each Project Project PhasePhase..

GANTT Chart is a popular project planning and GANTT Chart is a popular project planning and scheduling scheduling tool. tool.

Use Use MS-Project 2000MS-Project 2000 to draw your Project Plan. to draw your Project Plan.


2. 2. CURRENT SYSTEM (EXISTING SYSTEM)CURRENT SYSTEM (EXISTING SYSTEM)

A Brief description about the Current SystemA Brief description about the Current System’s’s Operational Operational Environment and its major problems and shorcomings will have Environment and its major problems and shorcomings will have to be considered under this headingto be considered under this heading..

Sufficient details have to be given in order to enable the reader Sufficient details have to be given in order to enable the reader to appriaciate and justfy the Development of Proposed new to appriaciate and justfy the Development of Proposed new System. System. Every organization (be it a Commercial organization, School or Every organization (be it a Commercial organization, School or Hospital) has an Hospital) has an EExisting System or procedures. xisting System or procedures.

The The Existing Existing System can be System can be a a Paper-based systemPaper-based system otherwise otherwise known known Manual-based SystemManual-based System or a Copmuter Information System. or a Copmuter Information System.



It is necessary to study and analyze the Current System It is necessary to study and analyze the Current System to:to:

- - Understand the shogrtcomings and problems of the current Understand the shogrtcomings and problems of the current

system and generate solutions to solve problemssystem and generate solutions to solve problems

- - Replace the current system with an improved version Replace the current system with an improved version Information about the Current System can be obtained Information about the Current System can be obtained from from several sources by several sources by applying the following Fact Finding applying the following Fact Finding techniques individually or in combinations:- techniques individually or in combinations:-

- - User Interviews User Interviews - - Questionnaires, Questionnaires, - - Observation, Observation, - - Document Review , Document Review , - - Sampling, and Research. Sampling, and Research.



When gathering information about the Current System you When gathering information about the Current System you should focus your attention on the following 5 areas: should focus your attention on the following 5 areas:

- - System Outputs,System Outputs, - - Inputs, Inputs, - - Processes, Processes, - - TimingTimingss - - System Controls. System Controls. It is also necessary to gather statistical information about the It is also necessary to gather statistical information about the Volumes, Sizes and frequencies of the currrent System.Volumes, Sizes and frequencies of the currrent System.


3. 3. PROPOSED SYSTEM (NEW SYSTEM)PROPOSED SYSTEM (NEW SYSTEM)

Propose a feasible “ SOLUTION” system to solve the Existing Propose a feasible “ SOLUTION” system to solve the Existing System’s problems as well as providing new functionality to System’s problems as well as providing new functionality to fulfill new user requirements.fulfill new user requirements.

3.1 LOGICAL MODEL OF PROPOSED SYSTEM 3.1 LOGICAL MODEL OF PROPOSED SYSTEM

3.2 PHYSICAL SYSTEM MODEL3.2 PHYSICAL SYSTEM MODEL



3.1 LOGICAL MODEL OF PROPOSED SYSTEM 3.1 LOGICAL MODEL OF PROPOSED SYSTEM

This section will contain details about the main functionality of the This section will contain details about the main functionality of the Proposed System. Proposed System.

In other word it will contain details of In other word it will contain details of Logical Model of the SystemLogical Model of the System, in , in which it will show “which it will show “what the System must do to satisfy businees what the System must do to satisfy businees information need rather than how it will be accomplished physically”.information need rather than how it will be accomplished physically”.


3. 3. PROPOSED SYSTEM (NEW SYSTEM)PROPOSED SYSTEM (NEW SYSTEM) 3.1 LOGICAL MODEL OF PROPOSED SYSTEM 3.1 LOGICAL MODEL OF PROPOSED SYSTEM

Depending on the Systems Development methodology different set Depending on the Systems Development methodology different set of of CASE CASE tools and techniques will be used for Datatools and techniques will be used for Data,, Process Process and and Object Object ModellingModelling:-:-

• If SSADM is used , Data Flow Diagrams (DFD), Entity Relationship If SSADM is used , Data Flow Diagrams (DFD), Entity Relationship Diagram (E-R Diagram) Decision Table, Decision Tree, Structured Diagram (E-R Diagram) Decision Table, Decision Tree, Structured English will be used to explain the logic of the Functional processes.English will be used to explain the logic of the Functional processes.

• If OODM If OODM used used then Unified Modeling Language (UML) Diagrams will be then Unified Modeling Language (UML) Diagrams will be

used used (Preferred)(Preferred)

. . The required The required UML Diagrams areUML Diagrams are:- :- Use-case DiagramUse-case Diagrams with Use Case Specificationss with Use Case Specifications, , Class Class Diagram, Diagram, Sequence Diagram, Sequence Diagram, and Statechart.and Statechart.• NOTE:- System Prototype may also be developed for demonstration purpose or as a first version of the System for improvement !!!



3.2 PHYSICAL SYSTEM MODEL OF PROPOSED SYSTEM 3.2 PHYSICAL SYSTEM MODEL OF PROPOSED SYSTEM

This section should contain details about the Physical Model of the This section should contain details about the Physical Model of the Information System. The Physical System model must be built on Information System. The Physical System model must be built on on the System’s Logical Model and address the actual methods of on the System’s Logical Model and address the actual methods of I Implementation.mplementation.

• Input Design, Output Design, User InterfacesInput Design, Output Design, User Interfaces , , System System Interfaces and Interfaces and Navigation diagram, Navigation diagram, System SecuritySystem Security and Controls, and Controls, Back-up recovery Back-up recovery ProceduresProcedures Data Design (Normalisation) and Physical Database Data Design (Normalisation) and Physical Database Design Design will have to be addressed. will have to be addressed.


3. 3. PROPOSED SYSTEM (NEW SYSTEM)PROPOSED SYSTEM (NEW SYSTEM)3.2 PHYSICAL SYSTEM MODEL OF PROPOSED SYSTEM 3.2 PHYSICAL SYSTEM MODEL OF PROPOSED SYSTEM

The Physical System Specification should include the followings The Physical System Specification should include the followings according to the Methodology used. according to the Methodology used.

SSADM METHODSSADM METHOD

SStructure Chart, tructure Chart, System Flow chart, System Flow chart, PseudocodePseudocode, Input Screen , Input Screen Designs, Report Layouts etc. Designs, Report Layouts etc.

OODM METHOD OODM METHOD ******

Package Diagrams, Design Class Diagrams and refined version of Package Diagrams, Design Class Diagrams and refined version of the the UML Diagrams UML Diagrams that have been that have been developed for Functional System developed for Functional System have to be have to be incorporate incorporate.. (Preferred)(Preferred)

This section should contain an outline This section should contain an outline System Test Plan. System Test Plan.

The purpose of the Test plan is to demonistrate that the The purpose of the Test plan is to demonistrate that the System is tested according to a plan for every known System is tested according to a plan for every known eventualities and that the test results are keept as proofs.eventualities and that the test results are keept as proofs.

Regardless of how the System was developed, the System testing Regardless of how the System was developed, the System testing has the following objectiveshas the following objectives:-:-

- - Perform a final test of all Programs Perform a final test of all Programs - - Demonistrate that Users can interact with the System SuccessfullyDemonistrate that Users can interact with the System Successfully- - Verify that all System components are integrated properly and that Verify that all System components are integrated properly and that actual processing situation will be handled correctly.actual processing situation will be handled correctly.- - Confirm that the information System can handle predicted volumes Confirm that the information System can handle predicted volumes of data in a timely and efficientlyof data in a timely and efficiently manner. manner.

Hard Copy of The Test results must be included in the Appendicies as Hard Copy of The Test results must be included in the Appendicies as proofproof of the System Testing. of the System Testing.


4. SYSTEM TESTING STRATEGY4. SYSTEM TESTING STRATEGY

Since most of the Since most of the new System replaces an new System replaces an EExisting xisting system either a completely system either a completely MManual system or an anual system or an earlier automated system. earlier automated system.

Normally the Normally the EExisting System is important and needs xisting System is important and needs to be convertred to the format required in the new to be convertred to the format required in the new System.System.

Thus an Thus an an outline Plan an outline Plan is required deal withis required deal with existing existing DATA CONVERSION into new format and loaded on DATA CONVERSION into new format and loaded on new Database structurenew Database structure..

thethe most suitable type of SYSTEM most suitable type of SYSTEM C CHANGEOVER HANGEOVER method method must also be specified for must also be specified for System System Implementation. Implementation.


4. SYSTEM IMPLEMENTATION STRATEGY4. SYSTEM IMPLEMENTATION STRATEGY

DDATA CONVERSIONATA CONVERSION

IIs the activity to convert the s the activity to convert the old old data data into new into new System format.System format.

Data Conversion is often becomes a small project Data Conversion is often becomes a small project on its own and usually carried out in cooperation on its own and usually carried out in cooperation with the users. with the users.

Sometimes Sometimes Old Databases Old Databases,, used by the used by the EExisting xisting SystemsSystems,, are commonly reused in the are commonly reused in the NNew ew Systems, some Systems, some requirements requirements necessitate changes necessitate changes and reloading of Database contents.and reloading of Database contents.



SYSTEM CHANGEOVERSYSTEM CHANGEOVER

IIs the process of putting the new System s the process of putting the new System in actionin action and retiring the and retiring the old System.old System.

THERE ARE FOUR SYSTEMS CHANGEOVER METHODSTHERE ARE FOUR SYSTEMS CHANGEOVER METHODS:-:-

a) a) DIRECT CUTOVERDIRECT CUTOVER

With Direct Cutover, the Old System stops and the New With Direct Cutover, the Old System stops and the New System starts simultaneously. System starts simultaneously. This is the east expensive and most risky method. This is the east expensive and most risky method.

b) b) PARALLEL OPERATIONPARALLEL OPERATION – –

With this method, both the Old With this method, both the Old aand new Systemsnd new Systems are are operated for some period of operated for some period of time.time.

This is the most expensive and least This is the most expensive and least riskyrisky and and safest safest method method



SYSTEM CHANGEOVERSYSTEM CHANGEOVER

c) PILOT OPERTATION – c) PILOT OPERTATION –

A limited part of the organization uses theA limited part of the organization uses the New System for a New System for a period of time while the old system continues to operate for the period of time while the old system continues to operate for the remaining part of organization. remaining part of organization.

A After the System proves successful at the pilot site it is fter the System proves successful at the pilot site it is implemented throughout the organization.implemented throughout the organization.

d) PHASED CHANGEOVER – d) PHASED CHANGEOVER –

One module of the new System at a time isOne module of the new System at a time is implemented implemented throughtout throughtout the organization until the system is entirely the organization until the system is entirely operational. operational.

Pilot and Pilot and Parallel changeover methods represent compromise Parallel changeover methods represent compromise between Direct cutover and Parallel operation and are less risky than between Direct cutover and Parallel operation and are less risky than Direct Cutover and less costly than Parallel operation.Direct Cutover and less costly than Parallel operation.




5.5. MAINTEMANCE AND SUPPORTMAINTEMANCE AND SUPPORT

This section will only be present if you have any special This section will only be present if you have any special Maintenance and Maintenance and SuSupport arangements with the organization pport arangements with the organization

OOr if there are any important r if there are any important MMaintenance issues that you aintenance issues that you have tohave to draw to the attention of the draw to the attention of the reader of the report.reader of the report.


5.5.6 6 OUTSTANDING ISSUESOUTSTANDING ISSUES

This section should contain brief information about the This section should contain brief information about the completion s completion status of the tatus of the Project.Project.

IInformation may be brief explanation about any unfinished nformation may be brief explanation about any unfinished projectproject tasks due to time limitation or any other tasks due to time limitation or any other hindering hindering factors. Any area of the System that requires further factors. Any area of the System that requires further i investigationnvestigation, further work will have to be mentioned , further work will have to be mentioned in this section . in this section .

Also aAlso any concerns and/or Suggestions about the ny concerns and/or Suggestions about the PProjectroject,, as as identified by the identified by the OOriginal riginal PProject development teamroject development team,, may be may be stated in this section as a reference. stated in this section as a reference.

GRADUATION PROJECT REPORT GUIDLINESGRADUATION PROJECT REPORT GUIDLINES. .

7. 7. APPENDICESAPPENDICES

The Report should include an Appendix if you need to attach The Report should include an Appendix if you need to attach supporting information to serve as sources of future supporting information to serve as sources of future reference.reference.

Eg.Eg. Y You might include ou might include Interview Questions and AnswersInterview Questions and Answers.. H Hardcopy of ardcopy of any Screens, Reports, any System any Screens, Reports, any System documentation that documentation that you you collected and analyzed. collected and analyzed. Also any Also any work in work in technical nature such as technical nature such as Data Data NormalizationNormalization, Database Design, , Database Design, Program Listing, Program Listing, System System TTest results est results etc. should be included in this section etc. should be included in this section as a proof. as a proof.

The Appendices section should also be organazed for clarity The Appendices section should also be organazed for clarity and readability. and readability.

GRADUATION PROJECT REPORT GUIDLINESGRADUATION PROJECT REPORT GUIDLINES. .

8. 8. GLOSSORYGLOSSORY

Short definition of any technical terms i.e Jargons Short definition of any technical terms i.e Jargons and abbreviations used in your report. (It should be and abbreviations used in your report. (It should be in alphabetical order) in alphabetical order)

eg. Abbreviation for Eastern Mediterranean eg. Abbreviation for Eastern Mediterranean University is (EMU) University is (EMU)

graduation project report guidline what should we include in each of the following report sub...

Documents

project summary

project objectives list

constraints project

report writing

introduction introduction

following report sub

recommended solution

main body