How to use the directory

It’s better to read from the work situation, not from the first page to the last. Formulate the decision to make, select the profile material, apply one tool, and go back to the resulting article, and then the theory becomes part of your own workflow.

Why do you need a handbook?

Who’s this section for?

The directory is your tool for quick answers to specific questions, the Start section is for new users or new users, and it’s not a detailed documentation, it’s a collection of the most important information: where to look, how not to drown in complex terms, and where to go next.

When to open the directory

If you’re not sure about the terms, if you want to remember the main scenario, or if you’re looking for a place to start, that’s your first step, like when you first launch a product, or when you encounter unfamiliar interfaces.

How to navigate in the directory

Structure and search

There’s usually a few logical sections in the directory. The Start section is the main input. Here you quickly find key features, answers to frequent questions, a list of terms and links to detailed instructions. A correct structure saves time: you don’t have to go through chaotic notes, the entire knowledge base is collected and accessible by simple categories.

Example: When you first start a product, you just need to open the Start section to understand where the search is, how to create a new task, what the icons on the toolbar mean.

Keyword search

Almost every directory has a search bar, and if you type in a keyword, you quickly go to the article or definition you want, and this is especially important if the section is big, you don’t have to go through hundreds of items manually.

First steps: How to start using

What to do from the very beginning

1. Take a short greeting or onboarding (often built-in).
2. Open the Start section – here are the main links, buttons and short instructions.
3. Learn the term block – learn what new words and product abbreviations mean.
4. Try to follow the basic steps of the step-by-step instructions in this section.

Example: A new user opens a product for teamwork. In the Start directory, he sees instructions on how to add a command, create a first task, where to turn on notifications.

Typical Beginner Mistakes

Many people try to delve into the complex finer settings or go to read the general documentation, and they quickly lose the thread or waste their time, and the best way to go is to go through the Start section and then move to other sections.

Anti-patterns: how not to use the directory

Ignore the Start section

Skipping the start section often leads to confusion, and some people think they can do it without a baseline, which dramatically increases the time to find the information they need.

Example: The user is looking for ways to export data instead of opening a brief instruction at the start, trying to do through third-party services, is wasting a lot of time.

Use the directory as a trash can

Too much unstructured information is often added, and the important thing is not to clog the directory with extra details that are not relevant to the first steps.

Where to find more information

Deeper in the sections and external search

If the Start section is missing details, go to other directory categories, and you’ve already had manuals, specifications, examples.

In parallel, you can check frequently asked questions and product forums – this helps to find solutions for atypical problems.

References to best practices:

1. Atlassian: How to Create Clear Guides
2. Habr Q&A: A Newcomer’s Guide to Navigation
3. Intercom: How to Build an Effective Knowledge Base (https://www.intercom.com/blog/how-to-build-a-knowledge-base/)

FAQ

Why do I need a Start section in the directory?

To quickly find the most necessary instructions and definitions without reading all the documentation.

What to do if you do not find the right answer?

Use the built-in search or go to other sections of the directory. There are often forums for clarification.

Can I skip the Start section?

It is recommended to always start with it – it saves time and helps not to get confused.

How is a book different from full documentation?

A directory is short answers and quick links. Documentation is detailed instructions for advanced users.

How not to get lost in a large directory?

Use search and stick to partition logic. Always start with Start.

What if there are too many terms and nothing is clear?

The Start section usually has a glossary – look there before reading the big texts.