Scrumble's User Guide

Developers	Email
Bryan Fallin	fallinbryan@ufl.edu
Jesse Martinez	kroronos@ufl.edu
Ryan Feeney	ryanq.feeney@ufl.edu
Stephen Berkner	sberkner@ufl.edu
Kyle Collins	Kcoll196@ufl.edu
Tony Strother	semphy@ufl.edu

Table of Contents

• User Levels

  • Permissions
  • Views

• Work Flow

  • Developer Work Flow
    • Home View
    • Backlog View
      • What's with the colors?
    • Analytics View
  • Scrum Master Work Flow
    • Main View
  • Admin Work Flow

• Hotkeys

• Touble Shooting

  • How do I delete a project?
  • I made a change but it hasn't shown up on the screen yet, what should I do?
  • The application has stalled, what should I do?
  • I found a bug, what should I do? Is there anywhere to report it?

• FAQ

  • I forgot my password, what should I do?
  • What are the differences between a Developer, Scrum Master, and Admin level user?
  • What do all the colors mean?

• Glossary

  • Item
  • Sprint
  • Comment
  • Project
  • Epic

User Levels

Permissions

Each level user has the following permissions:

• Developer

  • Can create and manage items

• Scrum Master

  • All the permissions of a developer
  • Can create and manage sprints

• Admin

  • All the permissions of a Scrum Master
  • Can create and manage users
  • Can create and manage projects

Views

Scrumbles is built to show each user all of what they need and none of what they don’t. Depending on a user’s permission levels what they see on the screen will physically change. The views that are available to each user are as follows:

• Developer

  • Home View
  • Backlog View
  • Analytics View

• Scrum Master

  • Main View
  • Home View
  • Backlog View
  • Analytics View

• Admin

  • Main View
  • Home View
  • Backlog View
  • Analytics View

Work Flow

Developer

The developer work flow is built around the creation and completion of items. As a developer the user is able to see what other members of the team is working on but only able to assign items to themselves then work on them to completion.

To create an item, the user can either click on the create item tab under the edit menu or use the CTRL+I hotkey. The create item dialog will pop up with the following fields/options:

• Item Title
• Item Description
• Item Type
  • User Story
  • Epic
  • Bug
  • Chore
  • Feature
• Number of points the item is worth
• Comment

Home View

When a developer is ready to begin assigning and submitting items for review they should switch to the Home View. From within the Home View users can see the items that are on the backlog and assign themselves items from this list by through a right-click dropdown menu. When an item is selected, its information will be displayed on in the center screen. Users can add and view comments in the same manner as they would in the main view.

Backlog View

The Backlog view allows the user to see which items are on the backlog, the sprints that have been created, and the items that need to be completed during each sprint. The timestamped comments on each item are available on the right side of the screen. Users can view comments using the field on the bottom of the comment box.

Items are color coded to show to their status:

• Red
  • Not assigned to anything
  • Assigned to a sprint but not to a user
  • Assinged to a user but not a spring
• Blue
  • Assinged to user and sprint
• Yellow
  • In Progress
• Orange
  • Submitted
• Violet
  • Item is epic
• Green
  • Complete 

To add an item, use the plus on top of the backlog list while in Backlog view.

Right clicking an item on the lists will yield the following drop down menus:

• My Items
  • As the items assigned to the user under My Items are completed, the progress bar on the top of the list will change accordingly.
  • Begin Work
    • When you are ready to begin working on an item select begin work to let the scrum manager on the project know.
  • Submit for review
    • When you are done working on an item submit it for review so the scrum master on the project can check it.
• Backlog
  • Assign to Me
    • Click this to assign an item to yourself from the backlog.

Analytics View

• The Analytics view provides users with statistics on:
  • Sprints
    • The Sprint tab provides charts with the percentage of tasks completed as a bar graph and a progress bar.
    • Users can select which sprint they want to view using the list box on the left of the screen.

• Users

  • The percent of tasks completed by users will be displayed as a pie chart and a bar graph.
  • There is a text box displaying:
    • The User with the most completed tasks
    • The User who earned the most points
    • The average amount of tasks completed by a user in the project
    • The average amount of points earned by a user in the project.
  • Users can select which user they want to view from the list box on the left of the screen.

• Tasks (aka items)

  • Depending on the type of item selected, the graph displayed will change.
  • Users can select which item they want to view from the listbox on the left of the screen.

Analytics provide valuable information for users of all permission levels, so it's appropriate that everyone be able to access them here.

Scrum Master Work Flow

Technically a Scrum Master can be a developer on a project as well, so their workflows are very similar. While the developer level user focuses on the creation and completion of items, the Scrum Master level user focuses on the organization and flow of items.

While the Scrum Master Main View might seem very similar to the Developer Main View, the difference lies in the drop down menus. Depending on an item's status, the options in the right click drop down will change. The standard options are:

• Assign to User
• Assign to Sprint
• Assign to Epic
• Edit Item
• Delete Item

If an item has been submitted to the Scrum Master for approval, two additional options become available:

• Approve Item
• Reject Item

A Scrum Master can also create sprints with the create sprint dialog available through CTRL+S or Edit > Create Sprint:

Main View

The Main View allows the user to view:

• All the users in the system
• All the users on the current team
• The various items associated with each user and their statuses
• The item description
• Comments on each selected item

Admin Work Flow

Like a Scrum Master, an admin can also be a developer on a project. Technically an admin can also be a Scrum Master as well. Admins have more views and more permissions, so their work flow is a bit more expansive.

Admins have the ability to create users and projects. To create a user you can either use CTRL+U or Edit > Create User.

The user creation dialgoue has the following fields:

• User Name
• User Password
• Re-enter User Password
• User Email Address
• User Role

To create a project you can either user CTRL+P or File > Create New Project.

Hot-Keys

Hot-keys are a great way to get around Scrumbles more quickly and efficiently. Available hot-key combos are:

• Creation Shortcuts

  • Create User
    • CTRL+U
  • Create Item
    • CTRL+I
  • Create Sprint
    • CTRL+S

• View Switching

  • Show Main view
    • CTRL+M
  • Show Home View
    • CTRL+H
  • Show Team view
    • CTRL+T
  • Show Analytics View
    • CTRL+A

Note: Hot key availability is determined by user level.

Trouble Shooting

1. I can't seem to figure out how to delete a project. How do I do it?

   • Unfortunately there is not feature available for deleting projects, but we're working on it! To check out our progress please reference Isuee #314 in our Github Repo.

2. I made a change but it hasn't shown up on the screen yet, what should I do?

   • The database refreshes automatically, but to manually trigger a refresh user either CTRL+R or Help > Refresh Data

3. The application has stalled, what should I do?

   • Restart it! Exiting and restarting Scrumbles will usually fix a stall.

4. I found a bug, what should I do? Is there anywhere to report it?

   • Yes! Feel free to make an issue on our Github repo!

FAQ

1. I forgot my password, what should I do?

   • Please contact your system admin; they are in charge of user passwords and have the ability to change them.

2. What are the differences between a Developer, Scrum Master, and Admin level user?

   • A Developer has the ability to:

     • Create items
     • Edit items
     • Submit items for review to a Scrum Master
     • View analytics

   • A Scrum Master has:

     • All the abilities of a Developer
     • The ability to approve items submitted for review
     • The ability to reject items submitted for review
     • The ability to create sprints

   • An Admin has:

     • All the abilities of a Scrum Master
     • Access to Admin Main View
     • The ability to create users
     • The ability to create projects

3. What do all the colors mean?

   • Please refer to either the "What do all the colors mean?" tab under the Help menu or the colors section of the user guide.

Glossary

The main terms to know in Scrumbles are:

• Item

  • Items are the "meat and potatoes" of scrumbles. Every item appears in the backlog and, once assigned to a sprint, can be worked on by developers.

  • They have the following user editable fields:

    • Name/Title
    • Priority
    • Status
    • Description
    • Creation Date
    • Priority
    • A link to Github

• Sprint

  • Sprints are the organizers of items. They dictate which items should be completed during a certain time period. Each sprint must belong to a certain project.

  • They have the following user editable fields:

    • Name
    • Start Date
    • End Date
    • Assigned Project

• Comment

  • Comments are the method by which user's interact with eachother through the application. Users can leave comments on items as they work on them.

  

• Project

  • Projects are the top level entity in Scrumbles. They contain within them sprints and the sprints contain items.

• Epic

  • Epics are large features, usually containing several sub-features.

    • In Scrumbles this can be thought of as one item with several sub-items.