Skip to content

How these docs work

Reference3 minFoundation

Every page in these docs does one job, and its type tells you which. Knowing the types saves you from reading a long explanation when you only wanted the steps.

Which page do I need?

Section titled “Which page do I need?”
You want toOpen aWhat it gives you
Get a first winQuickstartA small app, built from start to finish
Learn by buildingTutorialA larger build, with checkpoints
Do one taskHow-toNumbered steps, one action each
Know a screenScreen guideAn annotated screen and what each part does
Understand whyConceptA plain explanation with an example
Look something upReferenceTables of types and names
Fix a problemTroubleshootingA symptom, its cause and the fix
Copy a whole processRecipeA complete build, such as procurement

Every page shows its type and reading time under the title. A Before you start list appears when a page needs another one first, and What’s next at the end names the pages to read after it.

How do I read a page?

Section titled “How do I read a page?”
  • Bold is a label exactly as it appears in the product, for example Save field.
  • Code style is something you type, such as a field name, a token or a file name.
  • A path such as Account settings › Users & Security › Roles means click each item in turn.
  • Screens come from a real workspace. Numbered pins mark parts of a screen, and the legend under the image explains each one.
  • Callouts come in three kinds. A tip is a shortcut from a Beezr Consultant, a “Watch out” marks a step that is easy to get wrong, and “Behind the scenes” explains what Beezr does for you.
  • “Designer” and “App space” are the two sides of Beezr. What is Beezr? explains both.

At the end of most pages, Check yourself asks one to three questions about what you read. The answers explain themselves. “Last checked” at the bottom is the date we confirmed the page against the product.

Can I open the docs from the Designer?

Section titled “Can I open the docs from the Designer?”

Yes. In the Designer, open Help › Documentation. It opens these docs in a new tab. Use the search box on any page to find a topic.

The top right of the Designer, where the Help button sits between Build with Buzz and your account menu.
    Help opens a menu with Getting started, Contact support, Documentation and Jump to anything.

Are the docs available in Arabic?

Section titled “Are the docs available in Arabic?”

The docs are built for English and Arabic, with the same page addresses in both. When a page has not been translated yet, you see the English page with a short notice. Switch language with the language switcher at the top of the page.

Can I get a page as Markdown?

Section titled “Can I get a page as Markdown?”

Each page is written in Markdown, so it reads well as plain text and in AI assistants. Pins, callouts and screens are all described in words, so a copy still gives the whole answer.

Check yourself

You need the exact steps to add a lookup list. Which kind of page do you open?
Show the answer

A how-to. A how-to gives numbered steps for one task. A concept explains why, and a screen guide explains what each part of a screen does.

A page shows Save in bold. What does the bold tell you?
Show the answer

It is a label you will see in the product. Bold is only for labels as they appear in the product. Values you type are set in code style.

What's next

What is Beezr?The mental model in one page. Designer space and App space, and how an application, module, field, record, form, view and workflow fit together.Build your first appBuild an Equipment requests app from an empty workspace in about 15 minutes, with a form and a list, then add your first request in App space.

Last checked