Use the Rich Text Editor

Step-by-step instructions: Format text, improve it with AI, and strengthen instructions
Updated 1 day ago

TaskTrain's Rich Text Editor is used wherever you write formatted text: a Procedure's or Step's instructions on its Guide tab, a Procedure's Description, a Portfolio's Detail, an Assignment's Description, Trigger descriptions, a Position's Description, Embedded Resources, and Comments. It works the same way everywhere, though some places offer fewer tools.

Write and save

Click in the editor and type. The toolbar appears below the text while you are editing. Press Enter to start a new line. Your text saves when you click outside the editor.

Rich Text Editor on a Step's Guide tab, with its toolbar and a dotted underline under weak wording

In a Comment, Enter posts the Comment and Escape cancels it. See Comment on an Assignment or Task.

Format text

Select text, then press a toolbar button. Hover over a button to see its name.

  • Bold, Italic, Underline, Strikethrough, and Code
  • Numbered List and Bulleted List
  • Outdent, Indent, and Blockquote
  • Insert Monospaced/Code Block, Insert Video…, and Insert Link…
  • Remove formatting

The Embedded Resource editor also offers Style (headings), Font, Subscript, Superscript, Text Color, Highlight Color, and Align.

Write in a larger window

On the Guide tab and on Descriptions and Details, press Expand at the end of the toolbar to open the editor in a dialog, which you can also maximize. Press Collapse or close the dialog to return.

Rich Text Editor expanded into a dialog

Improve text with AI

On organizations with a paid plan, press AI Text Generation on the toolbar and choose Rephrase, Elaborate, Summarize, or Translate (into Arabic, Chinese (Mandarin), English, French, German, Hindi, Italian, Russian, Spanish, or Turkish). It works on the text you selected, or on all of the text if nothing is selected. Review the result, then press Accept to replace the text, Regenerate for another version, or Cancel.

Normative-wording suggestions

Clear instructions say plainly what MUST, SHOULD, or MAY be done. In a Procedure's Description and in a Procedure's or Step's instructions on the Guide tab, TaskTrain puts a dotted underline under wording that weakens an instruction. Hover over the underlined words to see why, and a suggested replacement. For example:

  • "should consider" or "try to": use SHOULD or MAY.
  • "is required to" or "is to be": use MUST, and name who does it.
  • "might" or "could": use MAY.
  • "will" or "shall": prefer MUST.
  • a lowercase "must", "should", or "may": capitalize it to MUST, SHOULD, or MAY.

An orange underline marks wording to reconsider; a yellow one marks a smaller improvement. The suggestions are advice only: edit the words yourself, or leave them if they say what you mean. The underlines are never saved with your text. For more on writing clear instructions, see Procedure Writing Best Practices.

Related Articles

Overview

  1. Procedure Writing Best Practices

Step-by-Step

  1. Update Procedure Step Name or Detail
  2. Update Procedure Info
  3. Add Resources to a Procedure or Step
  4. Comment on an Assignment or Task
  5. Generate a Procedure with SOP Savant
Did this answer your question?