Features

Write and format instructions

Use formatting, tables, callouts, snippets, and live links to parts and steps in your manual's instructions.

Some features on this page are paid. They are marked with a notice like this one right under their heading, so you can tell what works on the Hobbyist plan and what needs an upgrade. See Plans and limits for what each plan includes.
  • Audience: Authors writing the text that goes with a step.
  • Before you begin: A step or Text item is selected.
  • Starting point: Step Content is scrolled down to Instructions.
  • End result: Instructions that are easy to read, well organized, and stay correct even when parts and steps get renamed.

The toolbar

The toolbar above the instructions has everything below. If you're ever unsure what a button does, hover over it to see its name.

  • Text style switches between body text and a heading. Bold, Italic, Underline, Strikethrough, Superscript, Subscript, and Inline code apply to the selected text.
  • Text colour and Highlight set a color for the text or the background behind it. You pick one color for light mode and one for dark mode, so the text stays readable in both. Highlights work the same way.
  • Bulleted list, Numbered list, and Checklist build lists. The end user ticks the boxes in a checklist, and you can choose whether each box starts out ticked.
  • Quote, Code block, and Divider add those blocks.
  • Link turns the selected text into a hyperlink. Paste in the address and apply it.
  • Clear formatting strips the formatting from the selection.
  • Undo and Redo step back and forth through your edits in this editor.

Text can also be aligned left, center, or right, or justified so the lines line up at both edges.

Callouts, columns, cards, and spacers

Callout adds a note, tip, or warning block that's already styled for you. Layout adds columns, cards, and spacers:

  • Columns put text side by side. Click into a column to type, and add whatever blocks you need inside it.
  • Card wraps content in a bordered card.
  • Spacer adds blank space. Pick a size when you want the gaps to be consistent.

Tables

Select Insert table and drag across the Table size grid to choose how many rows and columns you want.

While the cursor is inside a table, the same button turns into Table, and its menu has the table actions:

  • Insert or delete a row or column.
  • Turn the header row on or off.
  • Merge selected cells into one. Select two or more cells first.

The table controls only show up while the cursor is inside the table, and there's no right-click menu for them.

Snippets

Saving your own snippets is a paid feature. Requires a Professional or Commercial plan. The built-in templates work on every plan.

A snippet is a block of formatted content you save once and can drop into any step. They're great for text you repeat a lot, like the same safety warning or a settings table that shows up throughout a manual.

  • To insert one, open Snippets and pick a built-in template or one you've saved.
  • To save your own, select the content, give it a name in the Name it field, and save it.
  • When you no longer need a snippet, remove it from the library.

A snippet goes in as ordinary content, so editing the copy in one step won't change the others.

Refer to parts and steps

Typed-out names go out of date as soon as a part or step is renamed. These two tools keep your references correct:

  • Mention a part inserts a live reference to a part from the manual's part list. Rename the part, and the reference updates everywhere.
  • Refer to a step inserts a link to another step by its title. The end user can click it to jump there, and if the step is renamed or moved, the link follows it.

If the part or step gets deleted, the text falls back to the label it had when you inserted it.

Link to 3D Part is a different tool. It ties the selected words to a body in the model, so the end user can click them and see that part in the scene. See 3D steps: visibility, cameras, and moving parts for more.

Show text only for some end users

Show only if wraps a passage so it only appears for end users who picked a certain option, such as one build or the other. It's useful when a single step needs to say "torque to 12 Nm" for one variant and "18 Nm" for another, so you don't have to write two separate steps. It uses the options you set up in Sections and build options.

Internal notes

Every step has an Internal notes field for you and your collaborators. It's never published, so use it for reminders, open questions, or the reason a step is written the way it is.

Preview and language

Before you publish, preview the step at desktop, tablet, and phone widths. Text is saved separately for each language, so use the language selector at the top of the editor to write each translation. See Languages for more.