Software Engineering Project: Three Musketeers Group Report

This project aimed to develop a digital TV guide application that can record and play back television programs, with a focus on improving the EPG (Electronic Programme Guide) functionality. The application had limitations on the number of programs it could record concurrently, requiring planning and scheduling to avoid conflicts. Client consultations and feedback were crucial in shaping the development process, from introducing the project concept to discussing source code, documentation, and UI designs. The team also evaluated, tested, and profiled their work to ensure quality and efficiency.

4121COMP: Software Engineering Workshop
Table of Contents
Project and Team Management
 Team effectiveness
 Group Working Agreement
 Meetings Catalogue
 Collaboration Tools
 Project management / SDLC effectiveness
 Individual group reflection
Analysis
 Functional and non-functional requirements
 Brief User Stories
 Use Cases and Descriptions
 Client Consultations / response to feedback
Design
 Data Design (Class Diagram)
 Basic UI Designs / Storyboarding
 Behaviour Design (Object Sequence Diagrams)
Evaluation, Testing and Profiling
 Evidence of test-driven development
 Evidence of profiling
4/7/2017
Three Musketeers: Group Report
[Document subtitle]
Pinto, Leslie / Mhareb, Omar / Rizk, Ziad
Liverpool John Moores University

Three Musketeers: Project and Team Management
Team effectiveness
To work effectively in our group, we have used a series of options to efficiently complete this
project. This includes creating a Group Working Agreement and following the rules we set in it (apart
from making changes that are agreed upon by all members). Furthermore, we have made use of the
online collaboration service “Trello” for assignment management, ad-hoc messaging via Google
Gmail and Google Drive for data storage.
As part of the actual development structure, we used systemic software development practices, and
worked to keep as much communication as we could.
Group Working Agreement
Team name: Three Musketeers
Team members: Leslie Pinto, Omar Mhareb, and Ziad Rizk
Strengths and Weaknesses
Leslie: I have studied and used HTML & CSS for designing websites, utilizing “WordPress”
CMS, and XAMPP (FileZilla FTP, Apache server). I am trained to CCNA standards, including
routing, switching, and working with each layer of the OSI & TCP / IP model. I have
experience with using JAVASCRIPT for making android applications, compiling firmware
from source using terminals programs, and experience using java and eclipse to make java
applications. I have a good understanding of programming languages and theory but I am
not very proficient in any give one.
Omar: I have a good knowledge of java and eclipse. I’m good with report writing and
diagrams making. I’m good in coding java but a very skilled.
Ziad: I’ve got a good background in SE principles (Diagrams) and problem solving. I can do a
report and I’m good in planning for the work. Eclipse is the only programming language that
I used, I can use it but I’m not very good in it.
Meetings Section
Availability: Each member will make their best efforts to attend scheduled meetings and
group sessions. If unable to, then the appropriate actions should be taken to inform each
other member, and to plan for rescheduling.
Meetings: Each meeting will be scheduled in consideration of each members’ availability.
Initially this will be for a fixed time slot, for which every member attends.
Ad-hoc: Each member will make use of collaborations tools (Trello, Google Drive) and
communication tools (Slack & Facebook) to keep each other aware of all relevant activity.
1

Quoracy: if one member can’t make it to a meeting, the rest of the team will continue
current tasks and will have the right to make primary decisions until that member returns.
Agenda: All details to be discussed in each meeting will be recorded into a suitable
document, and referred to on the start of the meeting. Any changes to this document will
be discussed with each member before the meeting commences.
Absences Section:
Each member from the group is expected to alert other members of being absent, prior to
attending scheduled meetings. In the event a member is absent, the remaining members
should update that member with status reports of any progress made, and future tasks to
focus on.
Changing the agreement/ Conflict resolution
If a member of the group would like to make any alterations to this agreement, a vote will
be done between all members. If a given member is not present, the remaining members
will make the final decision and consult the third member with details of the change.
Criticism and reviewing others’ work
Each team member is entitled to their own point of view, which will be respected and
appreciated. Any decisions or actions taken will be in accordance to the Group Working
Agreement.
Bullying and misconduct
Each member will follow social conduct and provide a safe atmosphere that encourages
group members to work with one another. This includes no form of harassment, bullying,
judgement and respecting other members’ contributions and opinions.
Meetings Catalogue
Sprint Meeting Log
Number Location Date Start Time End Time Members
Present
1 Avery Library 30/01/17 11:30 am 12:30 pm All
2 Avery Library 07/02/17 11:30 am 12:30 pm All
3 Avery Library 23/02/17 11:00 am 12:00 pm All
4 James Parsons
Building
06/03/17 11:00 am 12:00 pm All
5 James Parsons
Building
23/03/17 11:30 am 12:30 pm All
6 James Parsons
Building
29/03/17 11:10 am 12:10 pm All
2

Consultation Meetings Log
(Omar and Ziad - Add details)
Number Location Date Start Time End Time Members
Present
1 James Parsons
Building
06/02 10:00 10:15 Omar and Ziad
2 James Parsons
Building
10/02/2017 1:00 1:30 Leslie and Omar
3 James Parsons
Building
24/03/2017 1:30 2:00 Leslie and Omar
4 James Parsons
Building
03/04/2017 10:30 11:00 All members
present
5 James Parsons
Building
Scrum Meeting Log
(Omar and Ziad - Add details)
Numbe
r
Location Date Start
Time
End
Time
Members
Present
Notes
89+51 James Parsons
Building
30/01/201
7
12:15 12:30 All members
2 James Parsons
Building
31/01/201
7
3:30 3:45 All members
3 James Parsons
Building
02/02/201
7
12:30 12:40 All members
4 James Parsons
Building
03/02/201
7
11:30 11:45 All members
5 James Parsons
Building
06/02/201
7
11:45 12:00 All members
6 James Parsons
Building
10/02/201
7
11:45 12:00 All members
7 James Parsons
Building
13/02/201
7
11:15 11:35 All members
8 James Parsons
Building
14/02/201
7
3:30 3:50 Omar and
Leslie
9 James Parsons
Building
15/02/201
7
11:40 12:00 All members
10 James Parsons
Building
16/02/201
7
12:15 12:35 All members
11 James Parsons
Building
17/02/201
7
2:20 2:40 All members
12 James Parsons
Building
27/02/201
7
11:10 11:25 Omar and
Ziad
3

13 James Parsons
Building
28/02/201
7
3:40 3:55 All members
14 James Parsons
Building
02/03/201
7
12:25 12:40 All members
15 James Parsons
Building
08/03/201
7
11:20 11:40 All members
16 James Parsons
Building
10/03/201
7
12:40 1:00 All members
17 James Parsons
Building
14/03/201
7
3:40 3:55 Omar and
Leslie
18 James Parsons
Building
17/03/201
7
12:10 12:30 All members
19 James Parsons
Building
20/03/201
7
11:45 12:00 All members
20 James Parsons
Building
21/03/201
7
3:30 3:50 Ziad and
Leslie
21 James Parsons
Building
22/03/201
7
11:20 11:40 All members
22 James Parsons
Building
27/03/201
7
1:15 1:30 All members
23 James Parsons
Building
24 James Parsons
Building
25 James Parsons
Building
Project management / SDLC effectiveness
Sprint Planning
For each Sprint meeting, each user would take on the role of either: Scrum master, Product
Owner and the Scrum team member. For the following meeting, we worked in accordance
with the below product backlog for half way into the project development, but our agile
development team was not fully structure as much. This was due to a difference in
capabilities in some aspects of the project.
Product Backlog
ID Story Estimation Priority
2 As a user, I want to be able to scroll to the next title. 1 1
3 As a user, I want to be able to scroll to the previous title. 1 2
4 As a user, I want to be able to scroll through all channels in
the up direction.
1 3
4

5 As a user, I want to be able to scroll through all channels in
the down direction.
1 4
7 As a user, I want to be able to search for a specific title, and
see its channel id, description, start time and end time.
2 5
6 As a user, I want to be able to search for all matches to a
specific title, and see its channel id, description, start time
and end time.
2 6
10 As a user, I want to be able to schedule a title I find through
a search to a schedule list.
3 7
11 As a user, I want a scheduled title to be tagged to show its
status of being scheduled for future recording.
4 8
8 As a user, I want to see if a given title is a part of a series. 3 9
9 As a user, I want to see what time the next episode of a
title in a series will start.
4 10
1 As a user, I want all titles in the viewpoint to be displayed
in a grid.
1 11
Sprint Meeting 1: Schedule
Date of meeting: 30/01/17 - All group members present.
Start time: 11:30 am / End time: 12:30pm
Overview
Choose and plan the product development system
It has been decided that an agile development method will be used for this project. We will
utilize the Scrum Master practice of the agile process, and switch roles each week to adhere
to the project specification.
Create Sprint sessions
Sprints meetings will be held every Wednesday with all team members present to proceed.
The time slots agreed by each use will be kept up to date via the timetable excel document.
 Revisions to schedule
Sprint no.2 will be rescheduled from 08/ 02/ 2017 to take place on 07/ 02/ 2017.
Assign each member to a role
 Leslie will be the scrum master for the first week of development.
 Omar will handle Timetable for week 1, including status reports via agreed methods.
 Ziad will be a developer.
Assign each member their task until next Sprint
As a group, we suggested that Ziad should focus on studying Java tutorials, since he stated
he does not feel skilled in coding. I will start the initial source code and Omar will start
writing the initial documentation. We will all work towards completing the basic criteria of
the application initially, and then progress development then onwards.
5

Sprint Meeting 2: Schedule
Date of meeting: 07/02/17- All group members present
Start time: 11:30 am / End time: 12:30pm
Overview
Assign new roles for next Sprint
Leslie will be the product owner for this week, Omar with be the Scrum Master, and Ziad
will be a developer.
Arrange first meeting with Project Client (Dr David Lamb)
We will ask the client if an appointment on 14 /02/17 is acceptable for our first meeting.
This will be arranged to discuss the initial development of our project’s deliverables.
Each members’ progress
Leslie has completed the functional requirements documentation. Omar has started
designed the Class UML diagram.
 Revisions to time table
No revisions to the time table.
Sprint Meeting 3: Schedule
Date of meeting: 23/02/17 - All group members present
Start time: 11:00 am / End time: 12:00pm
Overview
Status report
Leslie: The Source code has been updated considerably. Improvements include code
optimization and new methods that need to be reflected in the class diagram. Also, I have
added comments for each section which should help making the sequence diagrams easier.
Things accomplished by members
Leslie and Omar completed half of Class Diagram, half of documenting meetings, and the
Group Licence Agreement document.
6

Leslie completed the basic criteria, half of intermediate criteria, completed half the steps to
access our SVN repository, and the Functional / non-functional requirements.
Future tasks to do before next Sprint
Leslie
Continue working on source code development
Speak to client in third appointment to gain feedback on our work.
Complete setup of repository access.
Ziad
Use cases and descriptions / Brief User Stories.
Omar
Contact other members regarding meetings and sharing documents.
Leslie and Omar
Catalogue all meetings (Scrum, Sprint, Consultation) meetings into a complete document.
Ziad and Omar
Finish Class diagrams, Basic UI Designs / Storyboarding and Object Sequence diagrams.
All members
Reflect on the progress of the project via individual group reflection.
Focus on studying existing source code to aid with project development
Assign roles on return for university.
Tasks that the group will not do
Due to the complexity of the advanced criteria and the deadline/ hand-in date for the
project, our group should focus on completing intermediate criteria only.
Sprint Meeting 4: Schedule
Date of meeting: 06/03/17 - All group members present
Start Time: 11:00 am / End Time: 12:00 pm
Overview
The progress of work
Leslie stated that he completed half of the intermediate criteria. Omar and Ziad stated some
documentation deliverables where completed and they will complete more soon.
Group member opinions regarding other members
7

Leslie stated that he feels he has done most of the project deliverables, specifically writing
all the source code. He is dissatisfied with the level of work he has had to do, and has asked
for additional help from the team members. Omar and Ziad agreed to contribute more to
the project in response to this, and have set deadlines to keep to their agreements. Omar
and Ziad stated they had no opinions they would like to discuss.
Assigning tasks for each group member
Leslie will continue to work on the source code, Omar and Ziad will continue to work on the
documentation aspects of the project and to express their concerns more openly.
Group attendance
The group decided that the overall group attendance to the point of this meeting was
acceptable.
Sprint Meeting 5: Schedule
Date of meeting: 23/03/17 – All group members present.
Start time: 11:30 am / End time: 12:30pm
Overview
Each members’ progress
Leslie: Completed the Series Link and Schedule functionality of the EPG Menu, as part of the
intermediate criteria.
Omar: Presented the sequence diagram documentation to each team member, which has
covered 70% of the required information.
Ziad: Presented his progress on the design of use case diagrams and descriptions to each
member of the group.
Assign tasks to each team member
Leslie: Leslie will continue with completing the EPG menu functionality to intermediate
criteria, and will arrange testing (JUnit) on the application. No deadline will be set due to the
complexity of the tasks and its nature.
Omar: Will design another diagram which will represent the series functionality of the EPG
menu, and will be shown to the group in the Scrum meeting on 27/03/2017 at 1:15pm.
Furthermore, Omar was given the task of cataloguing all meetings (Sprint, Scrum, Reflection
and Client) into a full document. Omar has been assigned deadlines for his tasks.
Ziad: Will show complete User Case diagram / descriptions and a complete Storyboard. He
will discuss with the Client the guidelines on completing both tasks. Ziad will then discuss
with other members about suitable deadlines for each task.
Future tasks before next Sprint
8

Leslie will present new source code developments during the Scrum meeting on 27/03/2017
at 1:15pm. The group agreed to have two more client meetings.
Sprint Meeting 6: Schedule
Date of meeting: 29/03/17 - All group members present
Start time: 11:10am / End time: 12:20 pm
Overview
Each members’ tasks progress
Leslie: Checked the documents that Ziad and Omar were working on. Completed the
product backlog, revised and completed group work agreement, amended user brief stories,
amended sequence diagram and meetings document.
Omar: Currently working on scrum meeting documents and sequence diagrams.
Ziad: Has completed Use Case diagram and almost done with descriptions. He’ll be waiting
for Leslie to finish the code to finalise the class diagram.
Concerns to discuss
Leslie: Would like to discuss with client how to best optimize the code and to make sure its
structure is appropriate, and meeting code smelling criteria.
Ziad: Would like to discuss with the client the storyboard structure.
Omar: Since Omar was unable to complete his assigned tasks by the agreed deadline, all
members will attend a sprint meeting with the client. This will be to find out why the
deadline was missed, and to get advice on how to complete the task and prevent missing
future deadlines.
Future tasks before next Sprint:
Leslie: Will continue working on source code, and will prepare Junit testing, profiling and
other aspects of optimizing the EPG menu.
Ziad: Will continue working on the Use Case descriptions and post the completed
documentation on google drive. Will also get all the scrum meetings and client feedback
from Omar and add it to the meeting catalogue.
Omar: Will complete sequence diagrams.
All team members: Complete Peer assessment.
Collaboration Tools
9

Introduction
Through the duration of the project, our group has made use of several collaboration tools
to make working together more efficient.
Trello
We made use of the service offered by “Trello” to keep a record of the tasks we would each
be working on.
“Each members’ current task at a given time”
Using this tool helped our group with several functions: It aided us with allocating tasks to
each member. It made seeing progress of our work easier, and we could see what we will
and won’t do at a given time. The extra features such as labels to signify status, due dates
for deadlines, and the commenting function was very useful.
10

“Overview of all tasks in the project.”
Google Drive
Introduction:
Google drive is a tool that allows us as a group to upload all the files so everyone can see
them and edit them.
Screenshots:
11

This tool helped the group to keep the documents organized. It also helped to
update current source codes with the new version. Everyone had access to the drive with
the permission of editing posting and deleting.
Google Gmail
Introduction:
Google Gmail was the way to communicate if any changes needed to be done
to a certain task. In addition, we used it to send the important notices
regarding sprints, scrums and client meetings. Furthermore, the Gmail is
sometimes used to send diagrams and code.
12

This tool was a very helpful tool that was needed for sending documents and
communicating with each other.
13

Individual Group Reflection
Introduction
Through the duration of the project, there have been some successes and failures. As a
group, we had difficulty with some of the criteria of the specification.
Leslie
There was some delay with meeting the intermediate criteria aspects, specifically the grid
display and the series link function. For the latter, this was because the source of data we
had used (bleb.org) did not provide a constant identifier in each title to use to indicate if a
title as part of s series.
Ziad
As a reflection I am happy with what I did and my teammates did, but I would’ve been happier from
my performance. Even though, I did what was required but I might have put more effort than I did
but it was a really good experience for me and I learned a lot of things. Like how to work in a group
on coding, how to divide the work between us and I discovered new applications that help us to
work in a group such as Trello, Slack and Google drive. It’s not easy to work with people for the first
time as a group but we quickly matched and put all of our efforts and work together to do a good
coursework.
At the end of the day, this coursework was really useful for me from my educational side and social
side as well, because as we finish and submit the coursework my teammates and I will still be friends
and talk.
Omar
The most challenging part was doing the sequence diagrams. It needed to be on a high level
so the code is well presented in design. Moreover, the group had excellent communication
with each other. Due to the small number of members, we had more stuff to do per person.
Keep the documents up to date was the main issue as if the code is enhanced the
documents should directly be changed.
14

Three Musketeers: Analysis
Brief User Stories
Overview
To gain information on what the Customer want in the EPG menu, the current product
owner will manage this task. Each member will take the role of the Product Owner, on a
rota basis. These are the functions that the client has stated are desired:
Display: As a user, I want the available channel lists in the EPG menu to be displayed in a
grid view.
 Scrolling: As a user, I want to be able to scroll through the next and previous titles
with no overlap of titles outside the grid view. In addition, I want to be able to scroll
through all channels in a up and down process.
 Search: As a user, I want to be able to search for a specific title, and have its
broadcasting channel id, its description, its start time and its end time displayed.
 Scheduler: As a user, I want to be able to schedule a title I find through a search to a
schedule list. I then want that specific title to be tagged to show its status of being
scheduled for future recording.
 Series link: As a user, I want to see if a given title is a part of a series, and to see what
time the next episode of that series will start.
Functional / Non- Functional Requirements
Overview
Based on the deliverables stated by the Client, the following requirements will be added to
the EPG menu.
Functional requirements
 Next and previous
The application will allow the user to move forward and backwards through the titles
displayed on the viewpoint of the menu.
 Up and Down
The application will allow the user to move through channels up and down the
listings displayed on the viewpoint of the menu.
 EPG Data Persistence
The EPG’s source of channel listings will be persistently gathered and sourced to
ensure the listings on the menu are up to date and retrievable.
15

 Series Link
The programmes in the EPG will utilize series identifiers to indicate they are part of a
series. They will display a sequence number that shows their place in the series (e.g.
1 of 4). Lastly. they will display the amount of time for the next programme in their
sequence to start.
 Schedule
The menu will allow the user to add a search title into a schedule list file. The title
will be tagged as scheduled, and will store the title’s channel id, description, start
time and end time.
 Alternate Showings
The programmes in the EPG will indicate the time/date in the schedule and channel
of any future showings of the same programme.
Non-functional requirements
 Data source rules of use
The author of the XML files: http://www.bleb.org, has stated regulations to using his
files. The following rules will place limits on the EPG menu:
o A gap of at least 2 seconds must separate each file fetch.
o The user agent of the script downloading the data should contain, at a
minimum, the application name and author email address. Alternatively, if
the user agent cannot be changed, appending a query string to the XML
fetches containing the application name is sufficient. In this case then please
notify me of your application name so I've got an email address to contact in
case of problem.
o A link back to bleb.org crediting it as the data source would be appreciated,
but is not mandatory.
 Data Catching:
Since there is a 2 seconds’ delay retrieval, a form of catching will need to be
implemented into the menu.
 Digital Tuner:
If attempting the advanced criteria, the menu will have to deal with a limited
number of digital tuners limiting the number of programmes it can record
concurrently. The application will plan its recording schedule to avoid conflicting
programme times, and alter its schedule to maximise the recorded programmes.
16

Use Cases and Descriptions
Introduction
(Add introduction)
(Add diagram)
(Add descriptions)
17

Client consolations and feedback
Introduction
Over the course of the project development, we had up to 5 opportunities to schedule
consultation meetings with the client (Dr David Lamb). These are the meetings we arranged.
Consultation 1: Schedule:
Date of consultation: (06/02/2017) - Omar and Ziad are present
Start time: (10:00) / End time: (10:25)
Overview
This meeting was an introductory meeting.
Subjects discussed:
 The Group name and members in the group
 Type of work will be done
 A brief plan about how the group will start doing the basic criteria and build
on it.
 Discussed with the client the software in little more details
 Discussed the roles of the Scrum Master and product owner with the tutor
Consultation 2: Schedule:
Date of consultation: 10/02/2017 – Leslie and Omar are present
Start time: 1:00pm / End time: 1:30 pm
Overview
Subject discussed with Leslie:
Leslie presented to the client the source code he created, and discussed its accuracy to the
project specification and grading criteria. He also discussed with the client the numbers of
channels that the EPG should show and how many files to use in the source code.
Client feedback for Leslie:
The client told Leslie that the progress of the source code is going in the right direction, and
to continue the progression. He also stated the terms of use for EPG menu TV listings
18

(bleb.org) has a series of rules that need to be adhered to, and to consider implementing
solutions.
Subject discussed with Omar:
Omar discussed with the Client details of documentation to be started at the current stage
of development. Omar stated he will finish a draft copy of the class diagram on 13/02/2017.
Client feedback for Omar:
Omar was told to start the initial documentation of the storyboard, use case diagrams, and
user stories / requirements in the initial stages of the product development. Each member
will continue working in following documents each week until complete.
Consultation 3: Schedule:
Date of consultation: 24/03/2017 - Leslie and Omar are present
Start time: 1:30pm / End time: 2:00 pm
Overview
Subject discussed with Leslie:
Leslie discussed the changes in source code to the client, including the completion of the
basic criteria, most of the intermediate criteria, and presented a demonstration of the
current EPG menu. He also expressed his dissatisfaction with the level of help from the
other team members regarding assistance with code development.
Client feedback for Leslie:
The client stated the current EPG menu functionality was impressive and its development
was going in the right direction. He also said he was impressed with its use of functionality
not included in the specification: A fixed schedule storage limit and clearing the Eclipse
console display to make the illusion of a new page during EPG menu interaction. The client
stated he was surprised how the function utilizes the Java “Robot.awt” class, and a custom
Java method that uses keyboard keycodes to automate the “reset” console eclipse
command.
Subject discussed with Omar:
Omar discussed the amount of documentation he has completed; particularly the sequence
diagrams. He also expressed his level of proficiency with the Java programming language.
Client feedback for Omar:
It was suggested by the client that Omar make more sequences diagrams to match the
amount of use cases, to document all meetings up to this point into a structured document.
Consultation 4: Schedule:
19

Date of consultation: 03/04/2017 – Leslie and Omar
Start time: 10:30am / End time: 11:00 am
Overview
Subject discussed with Leslie:
Leslie discussed the status of the EPG menu’s functionality (implementing a grid layout.
refactoring the source code). This includes presenting to the client the attempted source
code revision that could provide a solution.
Client feedback for Leslie:
The client told Leslie to work on his refactoring techniques and to show him the results
afterwards to see if more refactoring could / should be done. The feedback received has
given Leslie an idea of how to refactorize the source code.
Subject discussed with Omar:
Omar presented his sequence diagrams and meeting logs documentation to the Client. He
also discussed hat action is taken when a team member misses a task deadline. He
explained that he missed the deadline for his agreed-on task.
Client feedback for Omar:
The client told Omar that the sequence diagrams he has made need to reflect the amount of
use cases there on in the EPG menu. He also described the process of completing the
storyboard, and to make updates to the documentation as development continues.
Three Musketeers: Design
Data Design (Class Diagram)
(Omar and Ziad - Add details)
20

Basic UI Designs / Storyboarding
(Omar and Ziad - Add details)
21

Behaviour Design (Object Sequence Diagrams)
(Omar and Ziad - Add details)
22

Three Musketeers: Evaluation, Testing and Profiling
Evidence of test-driven development
(Omar and Ziad - Add details)
23