How to use this manual
This page explains how the manual is organized and how to read its descriptions. Read it once.
Four parts of the manual
- Getting started. General information: what Assist is, core concepts, a quick start, the interface layout, sign-in and roles.
- Processes. End-to-end instructions. Each answers the question “How do I do X?” and contains numbered steps, the expected result, and typical mistakes. Processes link to the screens where each step is performed.
- Cabinet screens. A reference description of each cabinet page. Read it when you need to understand what is on the screen.
- Reference. The glossary, permission tables, stages, fields, limits, error messages, FAQ.
How a screen description is organized
The description of each screen is built the same way. The sections go in one order, so the information you need is easy to find.
| Section | What is in it |
|---|---|
| Purpose | What the screen is for, which task it solves |
| Who sees it | Which roles and permissions are needed to access the screen |
| How to open | The path through the menu and the page address |
| What is on the screen | A screenshot with red numbers and a numbered list of elements: what each is and what happens on action |
| What you can do | Step-by-step instructions for each action available on the screen, form fields, rules and limits |
| Frequently asked questions and error tables | The cabinet's message texts, the cause, and how to fix it |
| See also | Where to go next |
If a screen has no corresponding information (for example, no forms or messages), the section is not given.
Red numbers on screenshots
On screenshots, individual elements are outlined with a red frame with a number. The number matches the number of the item in the “What is on the screen” list under the screenshot. This way you can find any described element on the picture and, conversely, understand the purpose of any outlined element.
To see a screenshot in more detail, click it: it opens full screen. Clicking again closes the view.
Conventions
| Notation | Meaning | Example |
|---|---|---|
| Bold text | The caption of a button, tab, menu item, or field as it is written in the cabinet | Click Create task |
| “Text in quotes” | A cabinet message or a value to enter or choose | The cabinet shows “Profile updated” |
Monospaced text | A service value: a key, an address, a stage name, code | /projects/20/scope |
| Menu → Item | A path through the left menu | Work → Projects |
| Red digits on a screenshot | References to the items of the list under the screenshot | See the figure, element 3 |
Special blocks inside the text:
An additional explanation. You can skip it, but it helps to understand how the system works.
A way to do the work faster or more conveniently.
The action is irreversible or affects other people. Read the block before performing the steps.
Interface captions and languages
The cabinet has two interface languages: Russian and English. The EN / RU switch is in the cabinet header, and the choice is remembered in the browser. The Russian version of the manual uses the captions of the Russian interface. The English version uses the captions of the English interface and English screenshots. The language switch of the manual is in the upper-right corner of the site.
The names of projects, tasks, people, and field values are not translated: they are your data, not the interface. In the English screenshots of this manual, the demo data (project and task names, stage names) is shown in English. Some captions of the current English interface are not translated yet and appear in Russian in the live cabinet; in the screenshots of this manual they are replaced with their English equivalents.
Page addresses
A page address is given relative to your cabinet address. For example, the address /tasks means the “Tasks” page at https://<cabinet address>/tasks. Addresses are needed to send a colleague a link to a page and to find a page by a browser bookmark.
Access permissions
The menu and tabs of the cabinet depend on the role. For each screen, the manual states which permission is needed for access. If the needed item is not in your menu, your role does not have such a permission. More: “Roles and access” and the permission matrix.
How to look for information
- You need to do something specific. Open the “Processes” section and find the instruction by the task name.
- You need to understand an unfamiliar screen. Open the “Cabinet screens” section and find the page in the site's side menu or in the menu map.
- You met an unfamiliar word. Find it in the glossary.
- The cabinet showed a message. Find the text in the list of messages.
- Site search. Use the browser search (Ctrl+F or ⌘+F) on the page of the needed section.