Sprint 1: Planning a Service - Assessment Outline Draft

Value: 10% of the Course Mark

Due: Monday 3rd March (Week 3), 1pm

1. Task

In this sprint, you will be expected to:

1. Within your team, allocate team roles.

2. Convert the initial specification for your assigned service category into a list of requirements.

3. Decide on a stack architecture for your service.

4. Identify any initial constraints that will affect the team’s performance in the project

5. Create an initial API interface design for your service.

6. Plan for the completion of work for the following sprint to complete a MVP of the API.

2. Team Roles

Based on your individual and collective strengths, discuss and as a team allocate the following roles:

• Team Lead / Scrum Master

• Product Owner

• Delivery Manager (Optional)

These roles aren’t formal positions of responsibility within the group - they are simply a means of helping you structure your approach to managing the project by having people responsible for specific aspects of it. You are welcome to change the roles, if you as a team see fit during the term.

In a Confluence page called Team, document your decision-making process and the reasoning behind the team’s decision.

3. Section 1: Requirements Engineering

You will be assigned an API category by your tutor. You will need to define more precisely what your API will be covering:

• The value of the API from a consumer’s perspective

• The expected inputs

• The expected outputs

You may add other information such as non-functional requirements (e.g. access, performance).

Document this in a Confluence page called Requirements in your team workspace.

4. Section 2: Initial Software Architecture Design

As a team, you will need to decide the stack you will use to develop the service. In particular, you will need to decide what frameworks you will use to create each of the following layers of your service:

• Deployment Method

• Server / API Layer

• Application Layer

• Persistence Layer

In your discussions, you should consider factors and constraints including, but not limited to the following:

• Current team member knowledge of frameworks

• Difficulty of frameworks to learn

• How well the framework is documented

• Availability / pricing of platforms

Your software architecture design can change between now and when you implement the service - this is simply an initial draft design.

Document your decisions and reasoning inside a Confluence page called Architecture.

5. Section 3: Initial API Design

Convert your list of requirements into an initial API Interface Design for your chosen service. Your interface design will need to include the following:

• Route names

• Route description

• CRUD method (GET, POST, PUT, DELETE)

• Parameters

• Return values

• Exceptional flows

• Descriptions of composite parameter / return types

We expected documentation to be informal at this stage, perhaps using examples of requests and responses. You will need to create finalised API Design with proper documentation in the next sprints.

Place your design inside a Confluence page called Interface.

6. Section 4: Project Planning

From your requirements analysis and design, plan for the completion of work for a Minimum Viable Product (MVP) of the service.

The breakdown of tasks is up to you as a team, however you should (a) ensure that tasks are broken down at a technical level and not just a product level, and (b) document your logic behind the breakdown of tasks.

Using Jira, you will need to:

• Create a sprint that details all of the work up until the end of Sprint 2;

• Create tickets / work items for each task;

• Appropriately group tickets together under epics;

• Where needed, split tickets down into subtasks;

• Allocate assignees and reporters to each ticket;

• Allocate Story Points to each ticket;

• Allocate Priorities to each ticket;

• Sequence the tickets appropriately in the backlog; and

• Highlight dependencies and prerequisites between tasks as needed.

Document any important reasoning that occurs as part of this process inside a Confluence page called Planning.

7. Marking Criteria

8. Submission

Sprint 1 Submission Guidelines

• Make sure you have a single link to your online documentation website(Confluence) with the 4 sections of Sprint 1 as sub-links

• Place a link to your online documentation website(Comfluence) in the Moodle Sprint 1 submission. Ensure that your tutor has full access.

• The grading tutor will assess the state of your Jira board and Documentation (Confluence) space after the mentoring session as your final submission.

Submission Process:

• Only one member of your team (the Scrum Master) should submit the link in Moodle text box here.

• If the Scrum Master is unable to submit the assessment for any reason, inform your tutor as soon as possible.

⚠ Late submissions will not be accepted.

Applications for Special Consideration and ELS assessment accomodations will not include extensions as this is a group project with no scope for extending deadlines. The course authority will determine an appropriate adjustment in cases where a Special Consideration request is approved or a student has an equitable learning plan. Students in either of these positions should email se2021@cse.unsw.edu.au.

9. Plagiarism

The work you and your group submit must be your own work.

Students are permitted to use generative AI, provided they clearly disclose its use and seek confirmation from their mentor beforehand. This approach ensures transparency and responsible use of generative AI tools. 

Relevant scholarship authorities will be informed if students holding scholarships are involved in an incident of plagiarism or other misconduct.

All work you submit must be your team’s. The use of external contractors to complete the project or your part of the project is not permitted.

During your mentoring sessions, you mentor will be using the opportunity to interview you and ensure you are contributing to the project.