Skip to content

Latest commit

 

History

History
207 lines (118 loc) · 9.71 KB

manual.md

File metadata and controls

207 lines (118 loc) · 9.71 KB

PoinZ user manual

This page gives you an overview on the features and most common use cases.

Table of Contents

The Board

The board contains the Backlog (list of stories on the left). The Estimation Area, where we see all users in the room as well as the currently selected story (in the middle). Optionally the Settings menu or the Action Log on the right.

The Board

Joining and leaving rooms

Joining a room

You can join a room in three different ways

  1. Visit the landing page and click the big button "Join new room". You will join a new room with a randomly assigned unique room id.
  2. Visit the landing page, extend the form and enter a custom room name, then hit Enter or click the join button. If the room with this custom name (the room id) already exists, you will join it. Otherwise a new room is created.
  3. Join a room directly by visiting the room url. (e.g. https://poinz.herokuapp.com/test or https://poinz.herokuapp.com/a-random-room-id-here). If the room with this name/id already exists, you will join it. Otherwise a new room is created.

PoinZ will ask you for a username on your first visit. Afterwards your username is stored in the LocalStorage of your browser and reused on subsequent joins.

Join Room Form

Leaving a room

You can leave a room by clicking the leave button in the top right corner. If you close your browser window or tab while you are in a room, other users will see you as "disconnected".

TopBar Quick Menu Disconnected Users

Removing other users from the room

You can remove ("kick") other users from the room:

  1. First click on the avatar of the user
  2. Click on the leave button on the right to kick the user. If you click the cross on the left, you cancel the action and the user stays in the room.

Kick User

The Story Backlog

The story backlog contains all stories added or imported to your room. The story currently selected for estimation is marked with a orange bar on the left.

Adding stories

Simply fill in the form on the top left. The Title is mandatory, the Description is optional. Any url in the description will be rendered as clickable link.

Importing stories

Drag and Drop a csv file with stories (e.g. an export from Jira) on to the backlog. The csv file should contain column headers on the first line.

Example:

key,title,description
ISS-123,The Title, some Description
ISS-554,Another Story, With a description

PoinZ uses papaparse to parse the given csv file.

Editing stories

Hover a story in the backlog (or tap the story on your mobile device), in order to see a button with a pencil icon on the top right. Click on the pencil to enter the edit mode. You can edit the title and the description of the story and save or discard your changes.

Edit Story Edit Story Form

Trashing stories

Hover a story in the backlog (or tap the story on your mobile device), in order to see a button with a trash can icon on the top right. Click on the trash can to move the story to the trash. Switch to the list of trashed stories by clicking on Trash (N) on the top of the Backlog. You can restore a trashed story or delete it permanently!

Estimating

Only a single story can be estimated at a given time.

  1. Click the story you want to estimate in the Backlog and click the blue Estimate button.
  2. The board now shows the selected story. All users see the same story selected on the board. In the backlog, the selected story is marked with an orange border on the left.
  3. Estimate the story by clicking one of the colored cards. By default the cards have the values ?, 1/2, 1, 2, 3, 5, 8, 13, 21, 34, 55, BIG.
  4. By default, the given estimates are revealed as soon as all active users did estimate. This behaviour can be changed in the settings (Auto Reveal).

Settle

In many cases, your team does not "agree" on a value in the first round. You can discuss and then "settle" the estimation: Click on one of the highlighted cards to store that value on the story.

New Round

If you do not want to settle right away, you can start a new estimation round by clicking the blue new Round button. All previously given estimates on the currently selected story are erased, and your team can start estimating again.

new round

Consensus

If all users estimated the same value, consensus is achieved, and the story will display a colored badge.

consensus

Manually reveal estimates

You can reveal the story at any time by clicking the blue Reveal button. Even if not all users in the room did estimate. PoinZ then displays all given estimates for this story (visible for all users).

reveal

Settings

User Settings

These settings will affect your user.

Avatar and Email

Choose an avatar to be displayed in the Estimation Area, visible for all users in the room. If you set an email address that is registered with https://gravatar.com, the gravatar "Icon" will be used. This overrides any selected PoinZ avatar.

Excluded

If you mark yourself as "excluded", you do not take part in estimating stories. If auto reveal is enabled, PoinZ will "ignore you" and reveal the story as soon as all other users did estimate the current story. You can still modify the backlog and settle. This is helpful for Scrum Masters / moderators.

Room Settings

These settings will affect the room and thus all users in the same room.

Auto Reveal

By default, PoinZ will reveal the current story automatically (all given estimation values are shown) as soon as all users in the room did estimate the current story (Excluded and Disconnected users are ignored).

If this flag is removed, Poinz will not auto reveal and you can manually reveal the story.

Password Protection

By default, everybody can join your room. You can optionally set a password in order to protect unauthorized access to your room.

During creation

When creating a new room, extend the "Join" button and set a new password (second input field, "Optional password). Users will then be prompted for the password when they are joining your room.

Existing Room

For an existing room without password protection, the room settings allow you to set a new password. You can also override an existing password. If you click the save button with an empty password field, you remove the password protection of that room.

Custom Cards

If the default set of cards does not meet your needs, you can change it.

  • Label (first column) can be any string
  • Value (second column) must be a number. Make sure that the values are unique
  • Color (thrid column) can be any css valid color string (hex, rgb, named)

You can also use the text editor and edit the json array directly.

Security

By default, everybody that knows the name/ID of your room can join your room, without further authorization.

This means, anonymous people can read, modify and delete your stories as soon as they know the room ID.

This is by design. When we created PoinZ, we wanted a most simple solution, without the hassle of registration and user management.

However, you might want to protect your data in some way. See "Password Protection" for more information.

At any time, you are using PoinZ at your own risk!