Versions Compared

Key

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

...

  • Homepage: The homepage content should inform users about the training example's objectives and include general project-related information, including design parameters and loads, relevant to their modeling efforts.

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

  • Instruction page:
    When developing this section for a training example, it is of utmost importance for the writer to emphasize clarity by clearly distinguishing between two distinct aspects:

    1. Workflow instruction pages, which are expected to provide a comprehensive breakdown of all input parameters associated with the described object. These pages should serve as a reference for users to understand the intricacies of the workflow and the role of each parameter.

    2. Training example pages, on the other hand, should primarily focus on guiding users through the process of correctly modeling the project within the user interface. These pages should be designed to be user-friendly and offer step-by-step instructions, ensuring that users can effectively apply the concepts learned in the training.

    Furthermore, it is imperative to recognize that the detailed explanation of parameters and their definitions should be reserved for the dedicated workflow instruction pages. This separation of content ensures that users can access in-depth information when needed while maintaining a streamlined and practical approach on the example pages. This approach maximizes the clarity and effectiveness of the training materials.

    Image RemovedImage Added


What sections should one include on a instruction page?

...

Section 1: Treeview Instruction

...

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

...