Versions Compared

Version Old Version 2 New Version 3
Changes made by

Umut Nuhat Sevinc

Umut Nuhat Sevinc

Saved on

Key

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

...

  • Homepage: The content on the homepage should provide information to the user about what they can accomplish with this document. In the example document, this page should also include general information related to the project, such as design parameters, design loads, etc.

  • Subpage: The subpage should detail which instructional pages will follow it and explain the objectives or goals of these subsequent pages.

  • Instruction page:
    - If it is created for a workflow, it should explain all the input parameters present in the described object.
    - If it is created for an example, it should guide the user on correctly modeling the project.

    Image RemovedImage Added


What sections should one include on a instruction page?
(All Section photo)

...

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.

...

Section 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.
The document with the provided link should be added using the "expand" command.

...

Section 3

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

...

Expand
titleSection 3 Formatting and Style Instructions

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

  • 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.

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

    Image Added

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

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

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

    Image Added

  • 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

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

    Image Added

  • Before the user goes to the input copying section, one instance of the object to be defined in the project should be modeled. The object can have the same input parameters. It is sufficient to explain how one of these parameters is defined.

    Image Added


Section 4

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.

...

Section 5

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.
This instructional text should be added using the Note Panel command.

...

Section 6

In the section where the parameters to be copied are located, there should be parameters that will modify the default parameters of the object.

...

Section 7

After the table is added, a message should be shared in the document indicating that the user needs to check the OpenBrIM 3D View. This instructional text should be added using the Success Panel command.

...

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.

...

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.

...