Updated Template-05 - Project Report (part-1).docx

FYP Title
Final Year Project
Session 2015-2019 (CHANGE AS PER YOUR SESSION)
A project submitted in partial fulfillment of the degree of
BS in Software Engineering
Department of Software Engineering
Faculty of Computer Science & Information Technology
The Superior University, Lahore
Spring 2021 (CHANGE AS PER YOUR SESSION)

Project Report: < write Project title here>
Faculty of CS&IT, The Superior University Lahore, Pakistan ii
*The candidates confirm that the work submitted is their own and appropriate credit has been
given where reference has been made to work of others
Plagiarism Free Certificate
This is to certify that, I ________ S/D of Muhammad Siddique, group leader of FYP under registration no
______________________________at Software Engineering Department, The Superior College, Lahore. I declare
that my FYP report is checked by my supervisor.
Date: Name of Group Leader: _________________ Signature: _____________
Name of Supervisor: Dr. ABC Co-Supervisor: Mr. XYZ
Designation: Lecturer Designation: Associate Professor
Signature: ________________ Signature: _________________
HoD: Dr. Tehreem Masood
Signature: _______________
Type (Nature of project)
[  ] Development [ ] Research [ ] R&D
Area of specialization
FYP ID
Project Group Members
Sr.# Reg. # Student Name Email ID *Signature
(i)
(ii)
(iii)

Faculty of CS&IT, The Superior University Lahore, Pakistan iii
[Title of Project]
Change Record
Author(s) Version Date Notes Supervisor’s Signature
1.0 <Original Draft>
<Changes Based on
Feedback from
Supervisor>
<Changes Based on
Feedback From Faculty>
<Added Project Plan>
<Changes Based on
Feedback from
Supervisor>

Faculty of CS&IT, The Superior University Lahore, Pakistan iv
APPROVAL
PROJECT SUPERVISOR
Comments: ___________________________________________________________________
_____________________________________________________________________________
Name:______________________________
Date:_______________________________ Signature:__________________________
PROJECT MANAGER
Comments: ___________________________________________________________________
_____________________________________________________________________________
Date:_______________________________ Signature:__________________________
HEAD OF THE DEPARTMENT
Comments: ___________________________________________________________________
_____________________________________________________________________________
Date:_______________________________ Signature:__________________________

Faculty of CS&IT, The Superior University Lahore, Pakistan v
Dedication
This work is dedicated to my . . . . . .

Faculty of CS&IT, The Superior University Lahore, Pakistan vi
Acknowledgements
I am really thankful to my supervisor who has . . . . . . . . . .

Faculty of CS&IT, The Superior University Lahore, Pakistan vii
Executive Summary
[12 pt, Calibri, Justified]
[An executive summary summarizes a longer report or proposal or a group of related reports in such a way that
readers can rapidly become acquainted with a large body of material without having to read it all. This section
summarizes the overall document, and should include the important highlights from the document. It should be
concise. It is NOT an introduction, index or table of contents, it is a summary. The Executive Summary should not
make any reference to other parts of the document. You have to write one page to let reader understand an
overview of the project.]

Faculty of CS&IT, The Superior University Lahore, Pakistan viii
Table of Contents
Dedication........................................................................................................................................v
Acknowledgements.........................................................................................................................vi
Executive Summary........................................................................................................................vii
Table of Contents..........................................................................................................................viii
List of Figures ...................................................................................................................................x
List of Tables ...................................................................................................................................xi
Chapter 1......................................................................................................................................... 1
Introduction .................................................................................................................................... 1
1.1. Background....................................................................................................................... 2
1.2. Motivations and Challenges............................................................................................. 2
1.3. Goals and Objectives........................................................................................................ 2
1.4. Literature Review/Existing Solutions ............................................................................... 2
1.5. Gap Analysis ..................................................................................................................... 2
1.6. Proposed Solution............................................................................................................ 2
1.7. Project Plan ...................................................................................................................... 3
1.7.1. Work Breakdown Structure.......................................................................................... 3
1.7.2. Roles & Responsibility Matrix....................................................................................... 3
1.7.3. Gantt Chart ................................................................................................................... 3
1.8. Report Outline.................................................................................................................. 3
Chapter 2......................................................................................................................................... 4
Software Requirement Specifications ............................................................................................ 4
2.1. Introduction...................................................................................................................... 5
2.1.1. Purpose......................................................................................................................... 5
2.1.2. Document Conventions................................................................................................ 5
2.1.3. Intended Audience and Reading Suggestions .............................................................. 5
2.1.4. Product Scope............................................................................................................... 5
2.1.5. References.................................................................................................................... 6
2.2. Overall Description........................................................................................................... 6
2.2.1. Product Perspective...................................................................................................... 6
2.2.2. Product Functions.......................................................... Error! Bookmark not defined.
2.2.3. User Classes and Characteristics .................................................................................. 6
2.2.4. Operating Environment................................................................................................ 6
2.2.5. Design and Implementation Constraints...................................................................... 7
2.2.6. User Documentation ..................................................... Error! Bookmark not defined.
2.2.7. Assumptions and Dependencies .................................................................................. 7
2.3. External Interface Requirements ..................................................................................... 7
2.3.1. User Interfaces.............................................................................................................. 7
2.3.2. Hardware Interfaces..................................................................................................... 8
2.3.3. Software Interfaces ...................................................................................................... 8
2.3.4. Communications Interfaces.......................................................................................... 8
2.4. System Features............................................................................................................... 8
2.4.1. System Feature 1.......................................................................................................... 9

Faculty of CS&IT, The Superior University Lahore, Pakistan ix
2.4.1.1. Description and Priority............................................................................................ 9
2.4.1.2. Stimulus/Response Sequences ................................................................................. 9
2.4.1.3. Functional Requirements.......................................................................................... 9
2.4.2. System Feature 2........................................................................................................ 10
2.4.2.1. Description and Priority.......................................................................................... 10
2.4.2.2. Stimulus/Response Sequences ............................................................................... 10
2.4.2.3. Functional Requirements........................................................................................ 10
2.4.3. System Feature 3 (and so on)..................................................................................... 10
2.5. Other Nonfunctional Requirements .............................................................................. 11
2.5.1. Performance Requirements ....................................................................................... 11
2.5.2. Safety Requirements .................................................................................................. 11
2.5.3. Security Requirements ............................................................................................... 11
2.5.4. Software Quality Attributes........................................... Error! Bookmark not defined.
2.5.5. Business Rules................................................................ Error! Bookmark not defined.
2.6. Other Requirements....................................................................................................... 12
Chapter 3....................................................................................................................................... 13
Use Case Analysis.......................................................................................................................... 13
3.1. Use Case Model.............................................................................................................. 14
3.2. Fully Dressed Use Cases ................................................................................................. 14
Chapter 4....................................................................................................................................... 15
System Design............................................................................................................................... 15
4.1. Architecture Diagram..................................................................................................... 16
4.2. Domain Model................................................................................................................ 16
4.3. Entity Relationship Diagram with data dictionary ......................................................... 16
4.4. Class Diagram ................................................................................................................. 17
4.5. Sequence / Collaboration Diagram ................................................................................ 17
4.6. Operation contracts ....................................................................................................... 17
4.7. Activity Diagram............................................................................................................. 18
4.8. State Transition Diagram................................................................................................ 18
4.9. Component Diagram...................................................................................................... 18
4.10. Deployment Diagram.................................................................................................. 19
4.11. Data Flow diagram [only if structured approach is used - Level 0 and 1].................. 19
Chapter 5....................................................................................................................................... 20
Implementation ............................................................................................................................ 20
5.1. Important Flow Control/Pseudo codes.......................................................................... 21
5.2. Components, Libraries, Web Services and stubs........................................................... 21
5.3. Deployment Environment.............................................................................................. 21
5.4. Tools and Techniques..................................................................................................... 22
5.5. Best Practices / Coding Standards.................................................................................. 22
5.6. Version Control .............................................................................................................. 22
Appendices.................................................................................................................................... 23
Appendix A: Information / Promotional Material ........................................................................ 24
Reference and Bibliography.......................................................................................................... 27
Index.............................................................................................................................................. 29

Faculty of CS&IT, The Superior University Lahore, Pakistan x
List of Figures
1.1 Caption of first figure of first chapter 6
1.2 Caption of second figure of first chapter 7
2.1 Caption of first figure of second chapter 14
2.2 Caption of second figure of second chapter 22
2.3 Caption of third figure of second chapter 26
5.1 Caption of first figure of fifth chapter 49
5.2 Caption of second figure of fifth chapter 49

Faculty of CS&IT, The Superior University Lahore, Pakistan xi
List of Tables
1.1 label of first table of first chapter 6
1.2 label of second table of first chapter 7
2.1 label of first table of second chapter 14
2.2 label of second table of second chapter 22
2.3 label of third table of second chapter 26
5.1 label of first table of fifth chapter 49
5.2 label of second table of fifth chapter 49

Faculty of CS&IT, The Superior University Lahore, Pakistan 2
Chapter 1: Introduction
[Paragraph Text 12 pt, Calibri, 1.5 Line Spacing, Justified]
[Between 4 to 8 lines describe what is this chapter all about]
1.1. Background
1.2. Motivations and Challenges
1.3. Goals and Objectives
1.4. Literature Review/Existing Solutions
1.5. Gap Analysis
1.6. Proposed Solution

1.7. Project Plan
1.7.1. Work Breakdown Structure
1.7.2. Roles & Responsibility Matrix
1.7.3. Gantt Chart
1.8. Report Outline
1.9. Empathy Map

Chapter 2
Software Requirement
Specifications

Chapter 2: Software Requirement Specifications
2.1. Introduction
2.1.1. Purpose
<Identify the product whose software requirements are specified in this document, including
the revision or release number. Describe the scope of the product that is covered by this SRS,
particularly if this SRS describes only part of the system or a single subsystem.>
2.1.2. Document Conventions
<Describe any standards or typographical conventions that were followed when writing this
SRS, such as fonts or highlighting that have special significance. For example, state whether
priorities for higher-level requirements are assumed to be inherited by detailed requirements,
or whether every requirement statement is to have its own priority.>
2.1.3. Intended Audience and Reading Suggestions
<Describe the different types of reader that the document is intended for, such as developers,
project managers, marketing staff, users, testers, and documentation writers. Describe what
the rest of this SRS contains and how it is organized. Suggest a sequence for reading the
document, beginning with the overview sections and proceeding through the sections that are
most pertinent to each reader type.>
2.1.4. Product Scope
<Provide a short description of the software being specified and its purpose, including relevant
benefits, objectives, and goals. Relate the software to corporate goals or business strategies. If
a separate vision and scope document is available, refer to it rather than duplicating its
contents here.>

2.1.5. References
<List any other documents or Web addresses to which this SRS refers. These may include user
interface style guides, contracts, standards, system requirements specifications, use case
documents, or a vision and scope document. Provide enough information so that the reader
could access a copy of each reference, including title, author, version number, date, and source
or location.>
2.2. Overall Description
2.2.1. Product Perspective
<Describe the context and origin of the product being specified in this SRS. For example, state
whether this product is a follow-on member of a product family, a replacement for certain
existing systems, or a new, self-contained product. If the SRS defines a component of a larger
system, relate the requirements of the larger system to the functionality of this software and
identify interfaces between the two. A simple diagram that shows the major components of the
overall system, subsystem interconnections, and external interfaces can be helpful.>
2.2.2. User Classes and Characteristics
<Identify the various user classes that you anticipate will use this product. User classes may be
differentiated based on frequency of use, subset of product functions used, technical expertise,
security or privilege levels, educational level, or experience. Describe the pertinent
characteristics of each user class. Certain requirements may pertain only to certain user classes.
Distinguish the most important user classes for this product from those who are less important
to satisfy.>
2.2.3. Operating Environment
<Describe the environment in which the software will operate, including the hardware
platform, operating system and versions, and any other software components or applications
with which it must peacefully coexist.>

2.2.4. Design and Implementation Constraints
<Describe any items or issues that will limit the options available to the developers. These
might include: corporate or regulatory policies; hardware limitations (timing requirements,
memory requirements); interfaces to other applications; specific technologies, tools, and
databases to be used; parallel operations; language requirements; communications protocols;
security considerations; design conventions or programming standards (for example, if the
customer’s organization will be responsible for maintaining the delivered software).>
2.2.5. Assumptions and Dependencies
<List any assumed factors (as opposed to known facts) that could affect the requirements
stated in the SRS. These could include third-party or commercial components that you plan to
use, issues around the development or operating environment, or constraints. The project
could be affected if these assumptions are incorrect, are not shared, or change. Also identify
any dependencies the project has on external factors, such as software components that you
intend to reuse from another project, unless they are already documented elsewhere (for
example, in the vision and scope document or the project plan).>
2.3. External Interface Requirements
2.3.1. User Interfaces
<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. Details of the user
interface design should be documented in a separate user interface specification.>

2.3.2. Hardware Interfaces
<Describe the logical and physical characteristics of each interface between the software
product and the hardware components of the system. This may include the supported device
types, the nature of the data and control interactions between the software and the hardware,
and communication protocols to be used.>
2.3.3. Software Interfaces
<Describe the connections between this product and other specific software components
(name and version), including databases, operating systems, tools, libraries, and integrated
commercial components. Identify the data items or messages coming into the system and going
out and describe the purpose of each. Describe the services needed and the nature of
communications. Refer to documents that describe detailed application programming interface
protocols. Identify data that will be shared across software components. If the data sharing
mechanism must be implemented in a specific way (for example, use of a global data area in a
multitasking operating system), specify this as an implementation constraint.>
2.3.4. Communications Interfaces
<Describe the requirements associated with any communications functions required by this
product, including e-mail, web browser, network server communications protocols, electronic
forms, and so on. Define any pertinent message formatting. Identify any communication
standards that will be used, such as FTP or HTTP. Specify any communication security or
encryption issues, data transfer rates, and synchronization mechanisms.>
2.4. System Features
<This template illustrates organizing the functional requirements for the product by system
features, the major services provided by the product. You may prefer to organize this section by

use case, mode of operation, user class, object class, functional hierarchy, or combinations of
these, whatever makes the most logical sense for your product.>
2.4.1. System Feature 1
<Don’t really say “System Feature 1.” State the feature name in just a few words.>
2.4.1.1. Description and Priority
<Provide a short description of the feature and indicate whether it is of High, Medium, or
Low priority. You could also include specific priority component ratings, such as benefit,
penalty, cost, and risk (each rated on a relative scale from a low of 1 to a high of 9).>
2.4.1.2. Stimulus/Response Sequences
<List the sequences of user actions and system responses that stimulate the behavior
defined for this feature. These will correspond to the dialog elements associated with use
cases.>
2.4.1.3. Functional Requirements
<Itemize the detailed functional requirements associated with this feature. These are the
software capabilities that must be present in order for the user to carry out the services
provided by the feature, or to execute the use case. Include how the product should
respond to anticipated error conditions or invalid inputs. Requirements should be
concise, complete, unambiguous, verifiable, and necessary. Use “TBD” as a placeholder
to indicate when necessary information is not yet available.>
<Each requirement should be uniquely identified with a sequence number or a
meaningful tag of some kind.>
REQ-SF1-1: <Write your requirement here>
REQ-SF1-2:
REQ-SF1-3:

2.4.2. System Feature 2
<Don’t really say “System Feature 1.” State the feature name in just a few words.>
2.4.2.1. Description and Priority
<Provide a short description of the feature and indicate whether it is of High, Medium, or
Low priority. You could also include specific priority component ratings, such as benefit,
penalty, cost, and risk (each rated on a relative scale from a low of 1 to a high of 9).>
2.4.2.2. Stimulus/Response Sequences
<List the sequences of user actions and system responses that stimulate the behavior
defined for this feature. These will correspond to the dialog elements associated with use
cases.>
2.4.2.3. Functional Requirements
<Itemize the detailed functional requirements associated with this feature. These are the
software capabilities that must be present in order for the user to carry out the services
provided by the feature, or to execute the use case. Include how the product should
respond to anticipated error conditions or invalid inputs. Requirements should be
concise, complete, unambiguous, verifiable, and necessary. Use “TBD” as a placeholder
to indicate when necessary information is not yet available.>
<Each requirement should be uniquely identified with a sequence number or a
meaningful tag of some kind.>
REQ-SF2-1:
REQ-SF2-2:
REQ-SF2-3:
2.4.3. System Feature 3 (and so on)

2.5. Nonfunctional Requirements
2.5.1. Performance Requirements
<If there are performance requirements for the product under various circumstances, state
them here and explain their rationale, to help the developers understand the intent and make
suitable design choices. Specify the timing relationships for real time systems. Make such
requirements as specific as possible. You may need to state performance requirements for
individual functional requirements or features.>
2.5.2. Safety Requirements
<Specify those requirements that are concerned with possible loss, damage, or harm that could
result from the use of the product. Define any safeguards or actions that must be taken, as well
as actions that must be prevented. Refer to any external policies or regulations that state safety
issues that affect the product’s design or use. Define any safety certifications that must be
satisfied.>
2.5.3. Security Requirements
<Specify any requirements regarding security or privacy issues surrounding use of the product
or protection of the data used or created by the product. Define any user identity
authentication requirements. Refer to any external policies or regulations containing security
issues that affect the product. Define any security or privacy certifications that must be
satisfied.>
2.5.4. Usability Requirements
2.5.5. Reliability Requirements
2.5.6. Maintainability/Supportability Requirements
2.5.7. Portability Requirements

2.5.8. Efficiency Requirements
2.6. Domain Requirements
<Define any other requirements not covered elsewhere in the SRS. This might include database
requirements, internationalization requirements, legal requirements, reuse objectives for the
project, and so on. Add any new sections that are pertinent to the project.>

Chapter 3
Use Case Analysis

Chapter 3: Use Case Analysis
3.1. Use Case Model
3.2. Use Cases Description

Chapter 4
System Design

Chapter 4: System Design
4.1. Architecture Diagram
4.2. Domain Model
4.3. Entity Relationship Diagram with data dictionary

4.4. Class Diagram
4.5. Sequence / Collaboration Diagram
4.6. Operation contracts

4.7. Activity Diagram
4.8. State Transition Diagram
4.9. Component Diagram

4.10. Deployment Diagram
4.11. Data Flow diagram [only if structured approach is used - Level 0 and 1]

Chapter 5
Implementation

Chapter 5: Implementation
5.1. Important Flow Control/Pseudo codes
5.2. Components, Libraries, Web Services and stubs
5.3. Deployment Environment

5.4. Tools and Techniques
5.5. Best Practices / Coding Standards
5.6. Version Control

Appendices

Appendix A: Information / Promotional Material
[Between 4 to 8 lines describe what is this appendix all about]
A.1. Broacher
A.2. Flyer
A.3. Standee
A.4. Banner

A.5. First Level heading [16 pt, Calibri, Bold, Left aligned]
A.5.1. Second level heading [14 pt, Calibri, Bold, Left aligned]
A.1.1.1. Third level heading [12 pt, Calibri, Bold, Left aligned]

Appendix [no.]: Appendix Title
A.1. First Level heading [16 pt, Calibri, Bold, Left aligned]
A.1.1. Second level heading [14 pt, Calibri, Bold, Left aligned]
A.1.1.2. Third level heading [12 pt, Calibri, Bold, Left aligned]

Reference and
Bibliography

Reference and Bibliography
[1] M. Sher, M. Rehman, “Title of the Paper” Conference name/Journal Name, Edition,
Volume, Issue, ISBN/ISSN, PP, Publisher/City-Country, Year.
[2] ……

Index

Index
[A]
[B]
[C]

Updated Template-05 - Project Report (part-1).docx

Recommended

Recommended

More Related Content

Similar to Updated Template-05 - Project Report (part-1).docx

Similar to Updated Template-05 - Project Report (part-1).docx (20)

Recently uploaded

Recently uploaded (20)

Updated Template-05 - Project Report (part-1).docx