Document Formatting GuideLines

• In the document, the font type should be selected as 'normal text'.
  

  

• The title names should be formatted as follows:
  (Workflow Name) Workflow - Ex: Steel I Girder Workflow
  Example (Workflow Name) [EX(Example Number) - Workflow Name Abbreviation] - Ex: Example Steel I Girder [EX1 - SIG]

• The subheadings should have the same names as the treeview headings visible in the OpenBrIM data spreadsheet.
  

  

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

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

  

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

• If a page needs to have a screenshot added and there is no need for any edits, the screenshot can be directly added to the page. However, if there is a need to edit the screenshot, it should be edited by going to the provided link and then added to the page.

• If text is required on the edited page, Times New Roman font with a font size of 15pt and bold formatting in red is preferred. Arrows and boxes should be set at a font size of 3pt and can be either red or black in color.
  

  

Example Document Formatting Guidelines

The rules written below should be followed sequentially when creating the document.

1. First, it should be specified where the user needs to navigate to in the data spreadsheet on OpenBrIM.

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.
   

   

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. In the table instructions, any statement that needs to be emphasized should be written in bold. For example: parameter name, parameter value, etc.