Documentation Format
Documentation Format
<<<Your Title>>>
A Major Project Submitted to Jawaharlal Nehru Technological University, Kakinada in Partial
fulfillments of Requirements for the Award of the Degree of
BACHELOR OF TECHNOLOGY
IN
COMPUTERSCIENCE&ENGINEERING
SubmittedBy
Name1(Roll No1)
Name2 (Roll No2)
Name3(Roll No3)
Name4(Roll No4)
Designation
DEPARTMENT OF COMPUTERSCIENCE&ENGINEERING
2021-2025
POTTI SRIRAMULU CHALAVADI
MALLIKHARJUNARAOCOLLEGE OF ENGINEERING &
TECHNOLOGYKOTHAPET,VIJAYAWADA-520001.
DEPARTMENTOFCOMPUTERSCIENCE&ENGINEERING
CERTIFICATE
ExternalExaminer
ACKNOWLEDGEMENT
We owe a great many thanks to a great many people who helped and supported and suggested
us in every step. We are glad for having the support of our principal Dr. S.Saravana kumar
who inspired us with his words filled with dedication and discipline towards work. We
express our gratitude towards Dr. D.DURGA PRASAD HOD of CSE for extending his
support through technical and motivation classes which had been the major source to carrying
out our project. We are very much thankful to Guide Name, Designation, Guide of our
project for guiding and correcting various documents of ours with attention and care. He/She
has taken the pain to go through the project and make necessary corrections as and when
needed. Finally, we thank one and all who directly and indirectly helped us to complete our
project successfully.
Project Associates
Name1 (Roll
No1)
DECLARATION
Project Associates
Name1 (Roll
No1)
ABSTRACT
One or Two paragraphs that describes about your problem statement along with project description
Note: A general structure and tips to help you write an effective abstract:
Introduction: Begin by stating the purpose of your research or paper. Provide context for the study,
including the background and significance of the topic.
Methodology/Approach: Briefly describe the methods or approaches used in your research. Include any
relevant information about the study design, data collection, and analysis techniques.
Results/Findings: Summarize the main findings or results of your research. Highlight the most important
outcomes and any significant discoveries or conclusions.
Discussion/Implications: Discuss the implications of your findings and how they contribute to the
existing body of knowledge on the topic. Consider any potential limitations of the study and areas for
future research.
Conclusion: Conclude by emphasizing the significance of your research and its contribution to the field.
Summarize the main points and highlight the key takeaways for the reader.
<<< Don’t Write as points write them as paragraph. Each paragraph should contain minimum 12 lines>>>
CONTENTS
1. Introduction
1.1 BriefOverviewofproject 1
1.1.1 Scope 1
1.1.2 Purpose 1
1.1.3 Objectiveofstudy 2
1.1.4 LiteratureReview 2
1.2 ProblemStatement 5
1.3 ProposedSystem 6
2. SystemAnalysis
2.1 SystemStudy
2.1.1 Feasibility Study 9
2.1.1.1 Operational Feasibility 9
2.1.1.2 Technical Feasibility 9
2.1.1.3 Behavioural Feasibility 10
2.1.1.4 FinancialandEconomicFeasibility 10
2.2 SystemRequirements
2.2.1 FunctionalRequirements 10
2.2.2 Non-FunctionalRequirements 11
2.3 SystemRequirementspecification
2.3.1 HardwareRequirements 12
2.3.2 SoftwareRequirements 12
2.3.3 RequiredLibraries 12
2.4 Methodologies
2.4.1 Components 15
2.4.3 TraditionalApproaches 21
3. SystemDesign
3.1 Aboutsystemdesign 42
3.1.1 Initializedesigndefinition 42
3.1.2 Establishdesigncharacteristics 43
3.1.3 AssessAlternativesforobtaining
Systemelements 43
3.1.4 Managethedesign 43
3.2 SystemArchitecture 43
4. SystemImplementation
4.1 Systemsetup 54
4.2 Code 54
4.3 Results
5. Testing
5.1 PerformanceMetrics 97
Note: Change the Appendix according to the project domain like IoT, Cybersecurity & Blockchain
LISTOFFIGURES
1. INTRODUCTION
1.1 BRIEF OVERVIEWOFTHEPROJECT
Provide a concise introduction to the project, including its purpose and objectives. Explain the context or
background that led to the initiation of the project.
1.1.1 Scope
The scope of a project defines the boundaries within which the project will operate, including its objectives,
deliverables, and constraints. When outlining the scope of a project, it's important to be clear and specific to
avoid ambiguity and ensure that everyone involved understands what is included and excluded from the project.
1.1.2 Purpose
Problem Statement: Identify the specific issue or challenge that the project intends to address. This could be a
need for improvement, a gap in existing processes or services, or an opportunity for innovation.
Objectives: Clearly state the goals and objectives that the project aims to accomplish. Objectives should be
specific, measurable, achievable, relevant, and time-bound (SMART). They provide a clear focus for the
project team and stakeholders.
Benefits: Describe the anticipated benefits or outcomes of the project. How will the project contribute to the
organization's goals or address the identified problem? Articulate the value that the project will deliver to
stakeholders.
1.1.3 Objectiveofthestudy
1.1.4 LiteratureReview:
[1] author name et al description (20 lines)
[2] author name et al description (20 lines)
…….
Write 10 papers in this format
1.2 PROBLEMSTATEMENT
2. SYSTEMANALYSIS
System Analysis is the process of analyzing a system with the potential goal of improving or
modifying the system. Analysis is breaking down the problem into smaller elements of study
and ultimately providing a better solution. During the process of system development,
Analysis is an important aspect. This involves gathering and interpreting facts, diagnosing the
problem and using the information to recommend improvements to the system ultimately, the
goal is to give a computerized solution.
It is wise to think about the feasibility of any problem we take on. Feasibility is the study
ofimpact, happens in the organization by the development of a system. The impact can be
either positive or negative. When the positive dominates the negative, then the system is
considered feasible. Here the feasibility study can be performed in four ways such as
economic feasibility, technical feasibility, operational feasibility, behavioural feasibility.
Proposed system is beneficial if and only if they can be turned in to a system that will meet
the operating requirements. The best feasibility asks if the system if the system will work
when it is developed and installed. The proposed of the operational feasibility study is to
determine whether the new system will be used if it is developed and implemented. The
proposed system will be used frequently since it satisfies all the communication needs, hence
operational feasibility is assured.
People are inherently resistant to change and computer has been known to facilitate changes.
An estimate should be made of how strong the user is likely to move towards the
development of computerized system. These are various levels of users in order to ensure
proper authentication and authorization and security of sensitive data of the organization.
Economic analysis is most frequently used for evaluation of the effectiveness of the system.
More commonly known as cost/benefit analysis the procedure is to determine the benefit and
saving that are expected from a system and compare them with costs, decisions is made to
design and implement the system. This part of feasibility study gives the top management the
economic justification for the new system. A simple economic analysis that gives the actual
comparison of costs and benefits is much more meaningful in such cases. In the system, the
organization is most satisfied by economic feasibility. Because, if the organization
implements this system, it need not require any additional hardware resources as well as it
will be saving lot of time.
2.2 SYSTEM REQUIREMENTS
We are overcoming the tedious manual procedure by this approach involving automatic
report generations and providing with required information.
A functional requirement document defines the functionality of a system or one of its sub
systems. It also depends upon the type of software, expected users and the type of system
where the software is used.
Functional user requirements may be high-level statements of what the system should do
butfunctional system requirements should also describe clearly about the system services
indetail.
2.2.2 Non-FunctionalRequirements
Insystemengineeringandrequirementsengineering,anon-functionalrequirementisarequirement
that specifies criteria that can be used to judge the operation of a system, rather than specific
behaviours.
Usability
This section includes all of those requirements that effect usability. It will be very easy to
use for the naïve user. The software is simple, user-friendly interface so that the user can
save time and confusion.
Reliability
The system is more reliable because ituses the API’s developedby google that workeven
DEPARTMENTOFCSE (IOT & CS incl BCT) Page|10
PROJECT TITLE
in noisy environment. Also, at receiver side python platform is used that makes thecode
morereliable.
Performance
This system exhibits high performance because it is well optimised and is developed by
using high level languages which will give response to end user in a very less amount of
time.
Supportability
This system is designed to be cross platform supportable. The system is supported on a
wide range of hardware and any software platform. This system also uses python and
hence it is highly portable.
Flexibility
If we intend to increase or extend the functionality of the software after it is deployed, it
should be planned from the beginning new modules can be easily integrated to our
system without disturbing the existing modules or modifying the local schema of existing
applications.
2.3 SYSTEM REQUIREMENT SPECIFICATION
System Requirements Specification (SRS) the requirements work product that formally
specifies the system-level requirements of a single system or an application. The System
Requirements Specification identifies, defines and clarifies the requirements, that when
satisfied through development meet the operational/functional need identified in the Project
Concept Proposal, Project Business Case, and Project Charter.
Approval of this document constitutes agreement that the developed system satisfying these
requirements will be accepted.
2.4METHODOLOGIES
2.4.1 Components
2.4.2 Proposed Methodology
3. SYSTEMDESIGN
System design is the process of designing the elements of a system such as the architecture,
modules, components, the different interfaces of those components and the data that goes
through that system.
ThepurposeoftheSystemDesignprocessistoprovidesufficientdetaileddataandinformation about
the system and its system elements to enable the implementation
consistentwitharchitecturalentitiesasdefinedinmodelsandviewsofthesystemarchitecture .
Elements of a System:
Architecture- This is the conceptual model that defines the structure, behavior and more
views of a system. We can use flow charts to represent to illustrate the architecture.
Modules - This are components that handle one specific task in a system. A combination of the
modules makes up the system.
Components - This provides a particular function or group of related functions. They are
made up of modules.
Interfaces -This is the shared boundary across which the components of the system exchange
information and relate.
Planforandidentifythetechnologiesthatwillcomposeandimplementthesystemselementsandth
eirphysicalinterfaces.
Determine which technologies and system elements have a risk to become obsolete, or
evolve during the operation stage of the system. Plan for their potential replacement.
Document the design definition strategy, including the need for and requirements
ofanyenablingsystems,products,orservicestoperformthedesign.
If the decision is made to develop the system element, rest of the design definition
process and the implementation process are used. If the decision is to buy or reuse a
system element, the acquisition process may be used to obtain the system element.
Capture and maintain the rationale for all selections among alternatives and decisions for
the design, architecture characteristics.
Assess and control the evolution of the design characteristics.
3.2 SYSTEMARCHITECTURE
3.3DATAFLOWDIAGRAM
DFD stands for DataFlow Diagram. The flow of data of a system or a process is represented
by DFD. It also gives insight into the inputs and outputs of each entity and the process itself.
DFD does not have control flow and no loops or decision rules are present. Specific
operations depending on the type of data can be explained by a flowchart. DataFlow
Diagram can be represented in several ways. The DFD belongs to structured-analysis
modelling tools. Data Flow diagrams are very popular because they help us to visualize the
major steps and data involved in software-system processes.
Components Of DFDs:
The dataflow diagram has four components. They are:
External Entity
Process
DEPARTMENTOFCSE (IoT & CS incl BCT) Page|14
PROJECT TITLE
DataFlow
Warehouse
External Entity:
An outside process or system that sends or receives data to and from the diagrammed system.
They are also known as sources, terminators, sinks or actors and are represented by squares.
Process:
Input to output transformation in a system takes place because of process function. The
symbols of a process are rectangular with rounded corners, oval, rectangle or a circle. The
process is named a short sentence, in one word or a phrase to express its essence
The process is represented using the following notation:
DataFlow:
Data flow describes the information transferring between different parts of the systems. The
arrow symbol is the symbol of data flow. A relatable name should be given to the flow to
determine the information which is being moved. Data flow also represents material along
with information that is being moved. Material shifts are modeled in systems that are not
merely informative. A given flow should only transfer a single type of information. The
direction of flow is represented by the arrow which can also be bi-directional.
Figure3.4:DataFlowRepresentation
Warehouse:
The data is stored in the warehouse for later use. Two horizontal lines represent the symbol of
the store. The warehouse is simply not restricted to being a data file rather it can be anything
like a folder with documents, an optical disc, a filing cabinet. The data warehouse can be
viewed independent of its implementation. When the data flow from the warehouse itis
considered as data reading and when data flows to the warehouse it is called data entry or
DEPARTMENTOFCSE (IoT & CS incl BCT) Page|15
PROJECT TITLE
data updation.
Figure3.5:Warehouse/DatastoreRepresentation
Levels in DFDs:
In Software engineering DFD can be drawn to represent the system of different levels of
abstraction. Higher-level DFDs are partitioned into low levels-hacking more information and
functional elements. Levels in DFD are numbered 0, 1, 2 or beyond. Here, we will see mainly
3 levels in the data flow diagram, which are: 0-level DFD, 1-level DFD, and 2-levelDFD.
Level-0:
Level-1:
3.4 DATASETS:
4. SYSTEMIMPLEMENTATION
4.1 SYSTEM SETUP:
4.2 CODE:
4.3 RESULTS:
5. TESTING
5.1 PERFORMANCEMETRICS:
6. CONCLUSION
REFERENCES
BIBLIOGRAPHY
DEPARTMENTOFCOMPUTERSCIENCEANDENGINEERING Page|111
APPENDIX
PROJECT TITLE
APPENDIX