Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

What sections should one include on a instruction page?

...

Section 1: Treeview Instruction

...

Expand
titleSection 3 Formatting and Style Instructions
  • If the description in the table contains a command that the user needs to perform on their computer, an "OpenBrIM Click" emoji should be placed at the beginning of the sentence as seen below.

  • A screenshot related to the instruction in the table should be placed right next to that instruction

    Image RemovedImage Added
  • The cell background for the Quick Tip text should be yellow, and it should be collapsible.

  • Quick Tips are often reusable across multiple locations, so it's advisable to employ an “excerpt” functionality of Confluence to facilitate this reusability. To ensure this, all Quick Tips should be included on the following page and called from each page with "excerpt" functionality.

  • In the table instructions, any statement that needs to be emphasized should be written in bold. For example: parameter name, parameter value, etc.

    Image RemovedImage Added


Section 4: Verify Model

...