Versions Compared

Version Old Version 5 New Version Current
Changes made by

Cagin Yakar

Umut Nuhat Sevinc

Saved on

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

First, it should be specified where the user needs to navigate in the data spreadsheet within OpenBrIM. This instructional text should be added using the Info Panel command, as shown below. The text in the panel on every page should be the same, except for the navigation location in the treeview.

...

...

Section 1: Treeview Instruction

Code Block
After clicking on '...> ... > ...' in the navigation treeview, follow the steps to define the ..... You can use the collapsed documentation page below for more information on the explanations of each parameter.

Section 2: Link to Parameter Descriptions

...

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

Before proceeding to the data copying step, the statement 'When the steps are completed, the shared screenshot displayed in the adjacent cell should be visible in the 3D(or FEA) view of OpenBrIM.' and the corresponding screenshot must be added to the table. This step will provide the user with an understanding of whether they have executed it correctly up to this point.

...

Section 5: Verify Model

Code Block
When the steps are completed, the shared screenshot displayed in the adjacent cell should be visible in the 3D view of OpenBrIM.

Section 5: Copy Instruction

After the instruction numbered table, the user should be directed to the section where they will copy the input parameters. Additionally, guidance should be provided as seen below for the step that follows the copying process. This instructional text should be added using the Note Panel command as seen below.

...

Section 5: Copy Instruction

Code Block
To model all the .... , copy the data below and paste the parameters into the first cell in OpenBrIM spreadsheet. Refer to the quick tip for an easy guide on how to perform the copy operation. After completing the copy, proceed to the next step to verify the model.

Section 6: Copy Data

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.

...

Section 7

Code Block
The completed .... are illustrated below. Please verify that you have the same model on your end by examining each view provided here. For more information on how to perform visual checks, refer to the quick tips.

Section 8

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.

...

Section 9

Code Block
To view the entire procedure explained on this page, please watch the recorded Video below.

...

  • For an example, you can visit the following link.