Documentation of riter.co — project management tool

Getting started: registration in Riter as a developer

Developers must be registered on Riter by managers. A manager specifies your first and last name, nickname and email. A new user receives a confirmation link to the email and follows it to get to the system. Here a user should set a password to the account immediately or by the end of the session. If the password is not set during this time, the user will not be able to enter Riter next time. In this case, you need to recover your password through the appropriate form.

Project workspace: getting access to projects

When you sign in to Riter, you'll be taken to one of your projects' page if you have access to any. It contains a list of current project stories and brief data about them. Here you can see all the latest information on the project, tasks states and assigned developers, get to other application pages through the main menu. If you can't see any project opened, contact your team lead and ask for adding you to one.

Main menu includes all necessary items to navigate throughout projects, current and archive stories, time tracking, settings and your profile page. On the left you will find the following options:

• Navigation throughout projects. At the main menu you can see Riter logo which allows you to get to the main page of the last project you have opened. Next to it you will find a drop-down list for navigation throughout all available projects and project groups. Open the list and click on one of its elements to switch to another project. After that, you'll be taken to its main page with a list of existing stories. While browsing some project pages, you are able to get back to the main page by clicking on the project title in the main menu.

1 2 3 4 5 6 7 8 9 10 11

1. Riter logo. Go to the main page of the last open project
2. Current project name. The name of the current open project
3. List of projects. Show all available projects and project groups
4. Project stories. Go to the project main page with a list of stories grouped by sprints
5. Working hours. Hours spent on the project by you and other team members
6. Project settings. Control the current project settings, for instance, manage topics, sprints, and deleted stories
7. Search and filtering. Search for stories in the project by different criteria
8. Profile menu. Go to profile settings and admin panel (for managers)
9. Current stories. Active stories page. Includes current tasks for existing sprints, unscheduled tasks, and tasks from archived sprints which are not approved yet (overdue stories)
10. New story. Create a new story in the project (it will be placed into 'Unscheduled' section)
11. Archive stories. Show stories which are already done and approved

• Stories. Opening a new project you, by default, get on the page with the list of all its stories grouped by sprints. Here you can get all information about the current project workflow, plan future tasks and look through already finished ones.
• Working hours. On this page you can track dirty time spent on the project as a whole. Go to a certain story page to estimate and track clean time spent on particular tasks.
• Settings. This page includes different project settings to adjust Riter for a particular workflow. Here you will find deleted stories, topic management, and sprint management pages.
• Search and filtering. The search bar will help you to find necessary stories by their states, titles, participants and topics. Visit an appropriate page to find out supported filters and their aliases. Note, that the search bar is available only on the main project page.
• Profile menu. A profile menu allows you to get to your account page, switch to management mode (for managers only) or sign out. The profile page contains your account information. Here you can set a new password for your account and manage GraphQL API tokens.
• New story, Current and Archived stories. Use the "New story" menu items to create a new story which will be placed to the unscheduled sprint section. "Current" and "Archived" sections include stories which you are working on and which are already approved.

Project groups

Working simultaneously on several projects, you don't need to switch between them all the time to look through existing tasks, create a new one or track the statistics. You can save a lot of time using project groups instead. They give you the opportunity to unite some projects under one name and display them on the same Riter pages. Note, that you must have access to all projects included into a particular group to have access to it. Such a group can be used to gather all projects of a specific user together or just several related projects. Due to it, you don't need to keep in mind all tasks and connections between them during working process.

Work with project groups

Project groups can be created by managers from the admin panel. So, if you prefer to unite your several projects into a group, ask your manager about this. Everybody who has access to the same projects will then see a new group in the drop-down list of projects in the main menu.

Projects and project groups are visually distinguishable in the list, though principles of work with them are similar to actions that you can perform with each project separately. Such a group looks like a usual project with a unique name. All involved stories are listed together on the main page with short project short names (aliases specified while creating) to let you distinguish tasks from different projects.

When working with a project group, you can find a new kind of filters - by projects - on a statistics page. By default, all of them are included into the report, but you are able to change this, tracking the data you need. Creating a new story, you need to specify which project it should be added to. Also, when creating a new time interval on the "Working hours" page, you may need to choose a particular project from the current project group.

Profile page

On this page, you can manage your profile information: change your first and last name, update the password. You can configure timezone here as well to record time intervals and comments according to your local time. Also, in the "Access tokens" tab you are able to generate personal access tokens for different projects to get access to the Riter GraphQL API. All projects which you have access to will be available with the generated token by default. You need just to select a “Description” and an “Expired at” values to generate a new personal access token. If you later get access to another project and want to manage its data as well via API, you have to generate a new token for all your currently available projects.