Many students write excellent code but lose marks because their documentation is weak. In January, you will likely face your 'Zeroth Review' or 'Synopsis Submission'. Here is how to nail it.
1. The SRS (Software Requirements Specification)
Your SRS is the bible of your project. It must contain:
- Functional Requirements: What the system does (e.g., 'User can login', 'Admin can delete posts').
- Non-Functional Requirements: How the system performs (e.g., 'Page load under 2 seconds', 'Data encryption using AES-256').
2. Essential UML Diagrams
You cannot skip these diagrams in your report:
- Use Case Diagram: Shows the actors (users) and their interactions with the system. Keep it simple.
- Class Diagram: The blueprint of your database and code structure. Show relationships like Inheritance and Association clearly.
- Sequence Diagram: Demonstrates the flow of logic for a specific task (like 'Placing an Order').
3. Tools to Use
Stop using MS Paint! Use professional tools like Draw.io, Lucidchart, or StarUML. They provide standard notations that examiners look for.