SDGP CW 1 - SRS Template and Guidelines

Deadline
04th of January 2022
on or before 1 PM via
Blackboard and Google Form (https://forms.gle/Vk2Q5WUYWQTc5rR17)

SDGP Module information for the Cover page

Module Name - Software Development Group Project

Module Code - 5COSC021C
Module Leader - Banuka Athuraliya

Topics to be covered

The following topics must be covered in the SRS.

1. Cover Page
2. Declaration Page
3. Abstract + Keywords
4. Acknowledgement
5. Table of Contents
6. List of Figures
7. List of Tables
8. Abbreviations table
9. Chapter 1: Introduction
10. Chapter 2: Literature Review
11. Chapter 3: Methodology
12. Chapter 4: System Requirements Specification (SRS)
13. Chapter 5: Social, Legal, Ethical and Professional Issues
14. Chapter 6: System Architecture & Design
15. References
16. Appendix

Guidelines to be covered

Make sure to include a good cover page with all the important information according to the university
standards. The cover page should not contain a page number. Numbering starts from the declaration page
and it should be numbered using lowercase roman letters.

The main content of the document starts from this point onwards.
The main content should use an indo-arabic numbering system. There is no set page limit, but it is
recommended to limit the complete number of pages of the SRS to 55 (excluding Cover, Declaration,
Abstract + Keywords, Acknowledgement, Table of Contents, List of Figures & tables, Abbreviations
table, References, and Appendix)

You get marks for formatting. Therefore, make sure that the document is well-formatted. The following
are mandatory for every team report,

● The top right of the document should mention what chapter it is. Eg - "Chapter 1 -
Introduction" or "Chapter 2 - Literature Review". It should change from chapter to chapter.
This can be done using Section breaks on Microsoft Word. Watch some tutorials on it if you
don't know how to do it.
● Bottom right you should have the page number
● Bottom left you should have your team name and number (Eg - "IIT - SE-1")
● Use the appropriate font sizes (H1 size 16, H2 size 14, H3 size 12, and Body size 12) - and the
font must be Times New Roman and NOT any other fancy fonts!
● Make sure the text is justified and proper alignment is there.
● Images and tables should have captions and must be linked to the list of figures and tables.
● Don't have blank spacing unnecessarily.

It is a must to have the table of contents, list of figures, and list of tables. (All this must be auto-generated
and NOT typed)

Make sure to use uniform numbering in the document. Chapter 1 numbering should be 1, 1.1, 1.1.1, etc.
Chapter 3 should be 3, 3.1, 3.2, 3.2.1, etc.

Have references to prove your statements or points. It will give credibility to what you say with
references most of the time. Rather than you saying something, it is best to use valid research work to
prove your statements. It is Mandatory to use the Harvard referencing style.

Bonus marks will be given for if the student or team has won any recognized competition.

Make sure everyone contributes to the project report, and it is recommended that you use Google docs to
collaborate with your team (as this will be checked during the viva to see the Individual contribution) and
we recommend you finalize the formatting of the document finally using Microsoft Word.

The report must be written in Third-person, therefore please don't use terms like "We" or "I". Check other
IIT thesis or Sample thesis shared to get an idea.
Chapter 1: Introduction
1.1 Chapter Overview

This is a small introduction to your chapter.

1.2 Problem background

This is the place where you convince the reader why this research must be carried out, the
significance of the research, magnitude of the problem, etc. Use inline citations.
Detailed explanation about the problem identified including stats to justify why it is a problem.
Include Examples in the problem and Describe your problem using example scenarios. Best to mention
Attempted solutions of the Competitors too (eg - feature comparison if there are any commercially
available products). This will be helpful if you apply for competitions in the future.

1.3 Problem Statement

Problem in nutshell just one sentence

1.4 Research Gap

The research gap that you will be addressing in your research.

1.5 Research question/s

https://www.scribbr.com/research-process/research-questions/

1.6 Research Aim

One sentence in italics

Further elaborate on the aim so reader understands and gets a clearer picture

1.7 Project Scope

Include the things you will do & won't do as part of your research

1.7.1 In-scope
1.7.2 Out-scope

1.8 Rich Picture Diagram

Should be very simple and easy to understand.

1.9 Objectives

Include specific objectives to ensure your research project is conducted successfully

1.9.1 Research Objectives

1.9.2 Academic Objectives

1.9.3 Operational Objectives

1.10 Resource requirements

Resources needed to work on the research project

1.10.1 Hardware requirements

1.10.2 Software requirements
1.10.3 Data requirements (optional)

If you are doing a data science project, you may require appropriate datasets to work on
the tasks. You need to identify them and include those requirements here.

1.11 Chapter Summary

This is a small summary of your chapter.

Chapter 2: Literature Review

It is up to you what sub topics you would like to include in this chapter as every research is
different from one another and hence the topics are also different based on the domain you have
selected. But try to stick to the important guidelines given here.

2.1 Chapter Introduction

This is a small introduction to your chapter.

2.2 Existing Work

Add your identified sub topics in whichever way suits your research in this chapter.

Topics ideally include:

● Also include a review on benchmarking or similar if applicable.

● This should ideally include technology/Approaches/Algorithms Review
● Also include a review on testing and evaluation metrics

You will need to discuss the most important 5 to 10 research from which you are deriving the
research gap. The limitations presented in this should be relevant to your research gap In
certain subsections it may help to tabulate your reviews.

2.3 Tools and techniques

This is where you will discuss the techniques that need to be done in your research. For eg: if you are
using a machine learning approach, you may need to talk about the different steps and the best
techniques for them. Similarly you can identify the best tools for your approach here too.

2.4 Chapter Summary

This is a small summary of your chapter.

Chapter 3: Methodology

3.1. Chapter Overview

This is a small introduction to your chapter.

3.2. Research Methodology

Critically evaluate the research methodology you are going to use for the project

3.3. Development Methodology

What is the life cycle model you have selected and why?

3.4 Design methodology

Eg: What design methodology suits your project? SSADM or OOAD or Anything else?

3.5 Evaluation methodology

Eg: What Evaluation metrics are you using to evaluate your research? Are you doing any
benchmarking?

3.5. Project Management Methodology

Critically evaluate the project management methodology you are going to use for the project

3.6 Team Work Breakdown Structure (WBS)

Mention how the work was divided among the team members and what each member has
contributed on

3.7 Usage of Project Management and Collaboration Software In the project

Provide evidence
Eg -
Trello board for Project Management
Scrum
Slack for collaboration with proof screenshots
Weekly team meetings log

3.8 Risks and Mitigation

Discuss the risks you may face during the project and their mitigation plans
Eg:
Risk Item Severity Frequency Mitigation Plan

5 5

5 4

5 1

3.9. Chapter Summary

This is a small summary of your chapter.

Chapter 4: System Requirements Specification (SRS)

4.1 Chapter Overview

This is a small introduction to your chapter.

4.2. Stakeholder Analysis

Identify the stakeholders for your project. Draw the Onion model diagram to depict this as well
add the stakeholder descriptions for clarity.

4.2.1.Onion Model

4.2.2.Stakeholder Descriptions

Stakeholder Viewpoint

Functional beneficiary

Financial beneficiary

Social beneficiary

Operational beneficiary

Negative Stakeholders

Regulatory
 Experts

Neighbouring systems

4.3. Selection of Requirement Elicitation Techniques/Methods

Identify appropriate techniques for your requirement elicitation tasks. Eg: Questionnaires, interviews etc.

4.4. Discussion/ Analysis of Results

For each of the elicitation methods used, discuss and analyse the outcomes.

4.5. Use Case Diagrams

Identify the use cases and draw the use case diagrams.

4.6. Use Case Descriptions

Use the following template for the use case descriptions

Use Case Name

Use Case ID UC-001

Description

Priority

Primary Actor

Supporting Actors

Pre-Conditions

Trigger

Main flow Actors System

 Exception flow Actors System

Alternate flow Actors System

Exclusions

Post Conditions

4.7. Functional Requirements (with prioritization)

Prioritize the functional requirements for your research

4.8. Non-Functional Requirements

All non-functional requirements need to be added here.

4.9. Chapter Summary

This is a small summary of your chapter.

*In this chapter, you may discuss diagrams that are most appropriate to your research and the above is
only an indicative. (Context diagrams, domain model diagrams etc.)
Chapter 5: Social, Legal, Ethical and Professional Issues
5.1. Chapter Overview
This is a small introduction to your chapter.

5.2. SLEP Issues and Mitigation

Discuss in detail using the BCS code of conduct the SLEP issues relevant to your research project and
how it was mitigated. You do not have to state the BCS code of conduct explicitly here however, establish
the relationship with the BCS conduct with the SLEP.

5.3. Chapter Summary

This is a small summary of your chapter.

Chapter 6: System Architecture & Design
6.1. Chapter Overview
This is a small introduction to your chapter.

6.2. System Architecture Design

Depending on your research add the appropriate architecture diagram.( Eg: Layered Architecture/Tiered
Architecture/etc.)

6.3. System Design

Depending on the research, add appropriate design diagrams such as follows:

6.3.1.Class Diagram
6.3.2.Sequence Diagram
6.3.3.UI Design – Use low fidelity wireframes/high fidelity prototype
6.3.4.Process flow chart – either use flow chart or activity diagram to describe system process
flow.

6.4. Chapter Summary

This is a small summary of your chapter.

References
Harvard referencing Westminster style ONLY accepted

For this the page numbering should be Uppercase roman numerals

Appendix
Each section under the appendix should be named “Appendix A”, “Appendix B” etc.
For this the page numbering should be Uppercase roman numerals