-
Notifications
You must be signed in to change notification settings - Fork 80
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #75 from hellomuthu23/add-guide
feat: add guide and example pages
- Loading branch information
Showing
6 changed files
with
218 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,125 @@ | ||
| import { Grid, Slide, Typography } from '@material-ui/core'; | ||
| import React from 'react'; | ||
|
|
||
| import '../HomePage/HomePage.css'; | ||
|
|
||
| export const ExamplesPage = () => { | ||
| return ( | ||
| <> | ||
| <Grid container direction='column' justify='center' alignItems='center'> | ||
| <ExamplesContent /> | ||
| </Grid> | ||
| </> | ||
| ); | ||
| }; | ||
|
|
||
| export const ExamplesContent = () => { | ||
| return ( | ||
| <Grid container item sm={12} lg={9} justify='center' alignItems='center'> | ||
| <Slide in={true} direction='up' timeout={2000}> | ||
| <div className='HomePageContainer'> | ||
| <Typography variant='h5'>Examples of User Story Estimation</Typography> | ||
| <br /> | ||
| <Typography variant='body1'> | ||
| User Story: As a user, I want to be able to log in to the application using my email and password. | ||
| <br /> <br /> | ||
| Estimation: 3 story points (Fibonacci sequence) | ||
| <br /> <br /> | ||
| Rationale: The team considers this user story to have medium complexity compared to other user stories. It | ||
| involves implementing authentication logic, verifying credentials, and providing appropriate error handling. | ||
| The team's collective experience and judgment led to the consensus estimation of 3 story points. | ||
| <br /> <br /> | ||
| <hr></hr> | ||
| <br /> | ||
| User Story: As a user, I want to search for products based on various filters (e.g., price, category, | ||
| brand). | ||
| <br /> <br /> | ||
| Estimation: 5 story points (Fibonacci sequence) | ||
| <br /> <br /> | ||
| Rationale: The team considers this user story to be more complex compared to simpler user stories. | ||
| Implementing the search functionality involves handling multiple filter options, integrating with the | ||
| database, and ensuring efficient search performance. The team estimates it to be a moderate-sized task. | ||
| <br /> <br /> | ||
| <hr></hr> | ||
| <br /> | ||
| User Story: As an administrator, I want to be able to generate monthly reports on user activity and sales | ||
| performance. | ||
| <br /> <br /> | ||
| Estimation: 8 story points (Fibonacci sequence) | ||
| <br /> <br /> | ||
| Rationale: The team identifies this user story as a larger and more involved task. It requires designing and | ||
| implementing reporting functionalities, gathering and aggregating data from multiple sources, and generating | ||
| meaningful insights. The complexity and effort involved lead to a higher estimation. | ||
| <br /> <br /> | ||
| <hr></hr> | ||
| <br /> | ||
| User Story: As a user, I want to be able to reset my password if I forget it. | ||
| <br /> <br /> | ||
| Estimation: 2 story points (Fibonacci sequence) | ||
| <br /> <br /> | ||
| Rationale: The team considers this user story relatively simple and straightforward. Implementing a password | ||
| reset functionality typically involves providing an email verification mechanism and updating the user's | ||
| password in the database. The team estimates it to be a smaller task compared to others. | ||
| <br /> <br /> | ||
| <hr></hr> | ||
| <br /> | ||
| User Story: As a user, I want to be able to add products to my shopping cart and proceed to checkout. | ||
| <br /> <br /> | ||
| Estimation: Medium (T-shirt size) | ||
| <br /> <br /> | ||
| Rationale: The team uses T-shirt sizes for estimation. Adding products to a shopping cart and enabling the | ||
| checkout process involves handling user interactions, managing cart state, updating inventory, and | ||
| integrating with payment gateways. The team estimates it to be of medium size in terms of effort and | ||
| complexity. | ||
| <br /> <br /> | ||
| <hr></hr> | ||
| <br /> | ||
| User Story: As a user, I want to be able to upload and attach files to my project tasks. | ||
| <br /> <br /> | ||
| Estimation: 3 story points (Fibonacci sequence) | ||
| <br /> <br /> | ||
| Rationale: The team considers this user story to be of moderate complexity. Implementing file upload | ||
| functionality involves handling file storage, validation, and linking files to specific tasks or projects. | ||
| The team estimates it to be a medium-sized task. | ||
| <br /> <br /> | ||
| <hr></hr> | ||
| <br /> | ||
| User Story: As an administrator, I want to be able to create and manage user roles and permissions. | ||
| <br /> <br /> | ||
| Estimation: 5 story points (Fibonacci sequence) | ||
| <br /> <br /> | ||
| Rationale: The team identifies this user story as a larger and more complex task. Implementing role-based | ||
| access control requires designing a flexible permission system, defining roles, managing user permissions, | ||
| and ensuring proper security measures. The effort and complexity involved lead to a higher estimation. | ||
| <br /> <br /> | ||
| <hr></hr> | ||
| <br /> | ||
| User Story: As a user, I want to receive email notifications for important updates and events. | ||
| <br /> <br /> | ||
| Estimation: 2 story points (Fibonacci sequence) | ||
| <br /> <br /> | ||
| Rationale: The team considers this user story relatively straightforward. Implementing email notifications | ||
| involves integrating with an email service provider, setting up templates, and triggering emails based on | ||
| specific events or triggers. The team estimates it to be a smaller task compared to others. | ||
| <br /> <br /> | ||
| <hr></hr> | ||
| <br /> | ||
| User Story: As a user, I want to be able to filter and sort search results based on different criteria. | ||
| <br /> <br /> | ||
| Estimation: 3 story points (Fibonacci sequence) | ||
| <br /> <br /> | ||
| Rationale: The team identifies this user story as a moderate-sized task. Implementing filtering and sorting | ||
| functionality requires handling user preferences, building flexible search queries, and presenting sorted | ||
| and filtered results. The team estimates it to be of medium complexity and effort. | ||
| <br /> <br /> | ||
| <hr></hr> | ||
| <br /> | ||
| Remember, these estimations are based on hypothetical scenarios, and actual estimations may vary based on | ||
| project-specific factors, team dynamics, and technology considerations. The primary aim is to establish a | ||
| relative understanding of effort or complexity to aid in prioritization and planning. | ||
| </Typography> | ||
| </div> | ||
| </Slide> | ||
| </Grid> | ||
| ); | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| import { Grid, Slide, Typography } from '@material-ui/core'; | ||
| import React from 'react'; | ||
|
|
||
| import '../HomePage/HomePage.css'; | ||
|
|
||
| export const GuidePage = () => { | ||
| return ( | ||
| <> | ||
| <Grid container direction='column' justify='center' alignItems='center'> | ||
| <GuideContent /> | ||
| </Grid> | ||
| </> | ||
| ); | ||
| }; | ||
|
|
||
| export const GuideContent = () => { | ||
| return ( | ||
| <> | ||
| <Grid container item sm={12} lg={9} justify='center' alignItems='center'> | ||
| <Slide in={true} direction='up' timeout={2000}> | ||
| <div className='HomePageContainer'> | ||
| <Typography variant='h5'>Guidelines on estimating user stories in Agile</Typography> | ||
| <br /> | ||
| <Typography variant='body1'> | ||
| 1. <b>Understand the User Story</b>:<br></br> | ||
| Before estimating, ensure that the team has a clear understanding of the user story. The product owner or | ||
| the person responsible for defining the user story should provide sufficient context and answer any | ||
| questions from the team. The team should have a shared understanding of the user story's purpose, | ||
| functionality, and expected outcomes. | ||
| <br /> <br /> | ||
| 2. <b>Determine Estimation Scale</b>:<br></br> Choose an estimation scale that suits your team's needs. | ||
| The most common scales used in Agile are Fibonacci sequence (1, 2, 3, 5, 8, 13, 21, etc.), T-shirt sizes | ||
| (XS, S, M, L, XL), or linear scale (1-10). Select a scale that allows for enough differentiation between | ||
| estimations and avoids spending excessive time on fine-grained estimates. | ||
| <br /> <br /> | ||
| 3. <b>Relative Sizing</b>:<br></br>Agile estimation focuses on relative sizing, where the team compares | ||
| the effort or complexity of one user story with another. This approach helps avoid the pitfalls of trying | ||
| to estimate absolute time. Relative sizing allows for a more straightforward and faster estimation | ||
| process. | ||
| <br /> <br /> | ||
| 4. <b>Use Reference User Stories</b>:<br></br> Create a set of reference user stories that the team | ||
| collectively agrees on. These reference stories serve as benchmarks against which other user stories can | ||
| be compared. The team can assign a standard estimation value to each reference story based on its | ||
| complexity, effort, or size. | ||
| <br /> <br /> | ||
| 5. <b>Conduct Estimation Sessions</b>:<br></br> Organize estimation sessions with the entire team present. | ||
| The team members responsible for implementing the user stories should be actively involved in the | ||
| estimation process. Use techniques such as Planning Poker, where team members privately select estimation | ||
| values, and then reveal them simultaneously, allowing for discussion and convergence. | ||
| <br /> <br /> | ||
| 6. <b>Discuss and Resolve Differences</b>:<br></br> Encourage open discussion during estimation sessions. | ||
| If team members provide different estimations, have them share their reasoning and insights. This | ||
| discussion helps to uncover assumptions, identify risks or dependencies, and clarify any | ||
| misunderstandings. The goal is to reach a consensus estimation. | ||
| <br /> <br /> | ||
| 7. <b>Update and Refine Estimations</b>:<br></br> After the estimation session, update the user story | ||
| estimates in the product backlog or Agile management tool. As the project progresses, continue to refine | ||
| the estimates based on actual effort or complexity experienced during implementation. This continuous | ||
| refinement improves the accuracy of future estimations. | ||
| </Typography> | ||
| </div> | ||
| </Slide> | ||
| </Grid> | ||
| </> | ||
| ); | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters