Documentation set
| Document | When | Purpose |
|---|---|---|
| Synopsis | Before starting | Topic approval |
| SRS | After approval | Freeze what the system will do |
| Design document | Before coding | Diagrams and database design |
| Test cases | During build | Prove each module works |
| User manual | At the end | How to install and use |
| Report / black book | At the end | Complete record |
| PPT | Each review | Presentation |
| Research paper | Final semester | Publication, where required |
Diagrams by project type
- Software: use case, class, sequence, activity diagrams, DFD level 0 to 2, ER diagram, architecture diagram
- Hardware / IoT: block diagram, circuit diagram, flow chart, PCB layout, pin connection table
- Mechanical: 2D drawings, 3D CAD model, exploded view, process flow
- Civil: site plan, structural drawings, survey data, estimation sheets
- Architecture: site analysis, concept, plans, sections, elevations, views
SRS outline (IEEE 830 style)
- Introduction: purpose, scope, definitions
- Overall description: product perspective, user classes, constraints
- Functional requirements, module-wise
- Non-functional requirements: performance, security, usability
- External interfaces
- Appendices
Test case template
| ID | Test case | Input | Expected | Actual | Status |
|---|---|---|---|---|---|
| TC01 | Login with valid data | Valid email and password | Dashboard opens | Dashboard opened | Pass |
| TC02 | Login with wrong password | Valid email, wrong password | Error message | Error shown | Pass |
FAQs
Which tool is best for drawing project diagrams?
draw.io (diagrams.net) and StarUML are free and widely accepted. Use Proteus or EasyEDA for circuits and AutoCAD or SolidWorks for mechanical drawings.
Is an SRS compulsory?
For software projects in most universities, yes, either as a separate document or as the requirements chapter of the report.
Last reviewed: 2026-10-11. Always follow the format your own department gives you.