PROJECT DOCUMENTATION
Main page
College certificate
Acknowledgement
Index
1. Introduction
• Overview of your project
• What motivates you for doing this project?
• Limitation in existing system
• What are the problems that your project overcomes?
2. Development environment
a. Development tools (h/w & s/w specification)
• Which software you are using?
• Which framework you are using?
• Which tools, technologies and languages you are
using for frontend and backend development?
• HTML, CSS, ASP.NET, PHP, Node Js, React Js
• What are the minimum h/w requirements for
developing as well as using?
• Processor, RAM, Device to access internet, etc
b. Development strategy (process model)
• Waterfall model
• Incremental model
• Spiral model
3. System analysis
a. Requirement gathering & analysis
• Gather the requirement (Interviews, Questionnaires,
Observations)
• Analyze the requirement
• Improve the quality of requirement
b. Feasibility study (decision is taken whether to proceed
with the project or to cancel)
• Operational Feasibility – to find out whether suitable
for all or not
• Economic Feasibility – to check whether system
makes profit and does not the cost while developing
• Technical feasibility - to find out the technical
requirements (h/w &s/w) are available or not.
c. Scope of the system
• What are goals of your project?
• How it will be useful?
• What are the limitations of your project?
d. Objectives
• Why are you making this project?
• desired outcome of a project
4. Software requirement specification
a. E-R Diagram (Entity Relationship (ER) Diagram)
• how “entities” such as people, objects or concepts
relate to each other within a system.
b. Data Flow Diagram (DFD)
• representing a flow of data through a process or a
system
c. Process specification
• How process is conducted?
d. Data dictionary
• collection of names, definitions, and attributes for
data elements that are being used in a database
• information describing the contents, format, and
structure of a database and the relationship
between its elements
• Eg of data dictionary is given below.
5. Testing
a. Unit Testing - way of testing a unit - the smallest
piece of code
b. User Testing - technique used to evaluate if the
selected web design actually works for your target
audience
c. White box testing - tests internal structures or
workings of an application
d. Black box testing - only considers the external
behavior of the system; the internal workings of the
software is not taken into account
6. User interface (Screenshots of the project)
7. Future scope (if needed)
• What are the future enhancements you can make in the
same project?
8. Bibliography/Webography
• References of books, research papers with Author’s
name
• References of websites used for developing projects
Documentation specification
• Font style- Time new roman
• Content size – 12
• Heading-14 (Bold)
• Alignment – justified
• Line Spacing - 1.5