Versions Compared

Key

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

...

  1. First, it should be specified where the user needs to navigate to in the data spreadsheet on OpenBrIM. This instructional text should be added using the Info Panel command.

  2. To enable the user to check what the object they are defining in the data spreadsheet or its input parameters are, a link to the instructional page should be added.

  3. The document with the provided link should be added using the "expand" command.

  4. To guide the user during modeling, numbered tables should be used.

  5. If the description in the table contains a command for the user, an OpenBrIM emoji should be placed at the beginning of the sentence.

    Image RemovedImage Added

  6. The instructions in the table should be written step by step to help the user create the model accurately. It should be clearly indicated which cell to click on and what value to enter for each parameter.

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

  8. In cases where additional explanation is needed for the user, Quick Tip should be used.

  9. The Quick Tip text should have a general narrative that covers all the projects to be created.

  10. The cell background where the Quick Tip text is placed should be yellow.

  11. The Quick Tip link should be added to the provided page. If necessary, it should be pulled into the document using the excerpt include function.

    Image Added

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

    Image Removed

    .

    Image Added

  13. 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 view of OpenBrIM.' and the corresponding screenshot must be added to the table.

    Image Added

  14. In the final step of the table, the user should be directed to the section where they will copy the input parameters. Additionally, guidance should be provided for the step that follows the copying process.

  15. This instructional text should be added using the Note Panel command.

    Image Added