...
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: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.
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.
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 | ||
|---|---|---|
|
Section 2: Link to Parameter Descriptions
...
| Expand | ||
|---|---|---|
| ||
|
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 | ||
|---|---|---|
|
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 | ||
|---|---|---|
|
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 | ||
|---|---|---|
|
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 | ||
|---|---|---|
|
...
For an example, you can visit the following link.