Versions Compared

Key

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

...

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

...

In the section where the parameters to be copied are located, there should be all the input parameters that can be used for copy operation as seen below

...

Quick Tip page explaining how to transfer input parameters to OpenBrIM should be added to the document as seen below.

...

Section 7:

After completing the copy operation, the document should display the following message, indicating to the user the need to verify the correctness of their work in OpenBrIM 3D View/FEA View and Spreadsheet. This instructional text should be added using the Success Panel command.

...

This section should contain screenshots of the completed model and instructions for verifying its completion.
The Model Quick Tip should be added to the document.

...

The OpenBrIM 3D View screenshot should be added to the document as seen below.

...

The FEA Quick Tip should be added to the document as seen below.

...

The OpenBrIM FEA screenshot should be added to the document.

...

The OpenBrIM Spreadsheet View screenshot should be added to the document as seen below.

...

Section 9

The message 'To view the entire procedure explained on this page, please watch the recorded Video below.' should be added to the document. This instructional text should be added using the Success Panel command. Finally, a video demonstrating the implementation of all the information explained in the document should be recorded and added to the document.

...