Project title your name here
Project Report Format
(For Second Year ME Programs)
Abstract
1. Introduction
1.1 System Reference
Describe the complete system into which your project fits in. This section should
specify the applications/uses of the complete system. (You may have
added/improvised an already existing system)
1.2 Overall Description
Specify what your project intends to achieve in the larger perspective of the
system. Specify in general the requirements of your work and also in general
solutions provided by your project.
2. General Description
2.1 Product Functions
Name the various functions that your product performs.
2.2 Users
List the intended audience/users of your product.
2.3 General Constraints
Specify the hardware and software framework that your product is dependent on.
2.4 Assumptions
Narrate whether the solution is absolutely general or some assumptions have
been made regarding the problem.
3. Specific Requirements
This chapter should specify only the requirements in simple English. Do not include
solution descriptions.
3.1 Functional Requirements
3.1.1 Functional Requirement 1
3.1.1.1 Introduction
3.1.1.2 Inputs
3.1.1.3 Processing
3.1.1.4 Outputs
Manipal School of Information Sciences, Manipal 1
Project title your name here
3.1.2 Functional Requirement 2
3.1.2.1 Introduction
3.1.2.2 Inputs
3.1.2.3 Processing
3.1.2.4 Outputs
3.1.3 Functional Requirement 3
…
…
3.1.N Functional Requirement N
3.1.N.1 Introduction
3.1.N.2 Inputs
3.1.N.3 Processing
3.1.N.4 Outputs
3.2 External Interface Requirements
3.2.1 User Interfaces
3.2.2 Hardware Interfaces
3.2.3 software Interfaces
3.2.4 Communication Interfaces
3.3 Performance Requirements
This section should list speed, scalability, memory, power, and area
requirements.
3.3.1 Performance Requirement 1
3.3.1.1 Introduction
3.3.1.2 Performance Requirement
3.3.2 Performance Requirement 2
3.3.2.1 Introduction
3.3.2.2 Performance Requirement
…
3.3.N Performance Requirement N
3.3.N.1 Introduction
3.3.N.2 Performance Requirement
Manipal School of Information Sciences, Manipal 2
Project title your name here
3.4 Design Constraints
3.4.1 Standards Compliance
3.4.2 Hardware Limitations
3.4.3 Systems Limitations
3.5 Attributes
3.5.1 Availability
Specify duration for which the services of your product be
available. Is it always available or only when it is executed?
3.5.2 Security/Privacy
3.5.3 Portability
3.5.4 Quality Assurance Requirements
3.5.5 Accuracy Requirements
…
3.6 Other Requirements
3.6.1 Database
3.6.2 Related Documentation
…
4. Behavioral Description
4.1 System States
If your solution is designed to run through well-defined states, show the
state transition diagram. Each state, inputs to the state and the next state
should be clearly shown.
4.2 Events and Actions
Description about events that trigger transition to other states and the
outputs associated with the actions/states.
5. Data Design
5.1 Data Objects or Data Structures
5.2 Files and Database Structures
Manipal School of Information Sciences, Manipal 3
Project title your name here
5.2.1 Logical File Structure
5.2.2 Logical Record Description
5.2.3 Access Methods
5.3 Global Data
6. Procedural Design
For each major module or component
6.1 Module Name
6.2 Processing Narrative
6.3 Algorithm Description
6.4 Modules Used
6.5 Comments/Restrictions/Limitations
7. Interface Design
7.1 User-machine Interfaces
Important screen shots.
7.2 Interfaces to external Programs, Systems or Devices.
8. Test Provision
8.1 Test Guidelines
8.2 Module Testing
For each major module or component
8.2.1 Module Name
8.2.2 Test Case
8.3 Integration Strategy
9. Conclusion and scope for future work.
10. Bibliography
11. Appendices
Manipal School of Information Sciences, Manipal 4