Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 16 additions & 4 deletions site/guide/model-documentation/_check-model-documents.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,10 @@ a. Review questions that require attention. Each question includes a(n):

Use the feedback provided by the {{< var validmind.checker >}} to review the appropriate sections of your document and decide what revisions should be made.

### 4. (Optional) Export results

To export the results of the {{< var vm.checker >}} to a `.pdf` (Portable Document Format) file for usage outside of the {{< var validmind.platform >}}, click **{{< fa download >}} Export All**.

::::


Expand All @@ -93,7 +97,7 @@ Use the feedback provided by the {{< var validmind.checker >}} to review the app

::: {.panel-tabset}

#### 1. Select a regulation
#### 1. Select regulation

a. In the {{< var vm.checker >}} modal, select a **[regulation]{.smallcaps}** and an associated **[assessment]{.smallcaps}** from the drop-down menus to check your document against:

Expand All @@ -105,7 +109,7 @@ a. Scroll to the bottom and click **Check Document**.

The {{< var validmind.checker >}} analyzes your documentation, identifies gaps, and generates recommendations for specific questions that you review in the next step.

#### 2. Review the observations
#### 2. Review observations

a. After the {{< var vm.checker >}} has completed its analysis, expand individual questions or click **Expand All** to look through the observations:

Expand All @@ -122,6 +126,10 @@ b. Review questions that require attention. Each question includes:

Use the feedback provided by the {{< var validmind.checker >}} to review the appropriate sections of your documentation and decide what revisions should be made. Or, if you have run the {{< var vm.checker >}} before and were just checking that all documentation issues have been addressed, submit your model for validation.

#### 3. (Optional) Export results

To export the results of the {{< var vm.checker >}} to a `.pdf` (Portable Document Format) file for usage outside of the {{< var validmind.platform >}}, click **{{< fa download >}} Export All**.

:::

::::
Expand All @@ -143,7 +151,7 @@ Use the feedback provided by the {{< var validmind.checker >}} to review the app

::: {.panel-tabset}

#### 1. Select a regulation
#### 1. Select regulation

a. In the {{< var vm.checker >}} modal, select a **[regulation]{.smallcaps}** and an associated **[assessment]{.smallcaps}** from the drop-down menus to check your document against:

Expand All @@ -155,7 +163,7 @@ a. Scroll to the bottom and click **Check Validation Document**.

The {{< var validmind.checker >}} analyzes your report, identifies gaps, and generates recommendations for specific questions that you review in the next step.

#### 2. Review the observations
#### 2. Review observations

a. After the {{< var vm.checker >}} has completed its analysis, expand individual questions or click **Expand All** to look through the observations:

Expand All @@ -172,6 +180,10 @@ b. Review questions that require attention. Each question includes:

Use the feedback provided by the {{< var validmind.checker >}} to review the appropriate sections of your report and decide what revisions should be made. Or, if you have run the {{< var vm.checker >}} before and were just checking that all report issues have been addressed, submit your report for review.

#### 3. (Optional) Export results

To export the results of the {{< var vm.checker >}} to a `.pdf` (Portable Document Format) file for usage outside of the {{< var validmind.platform >}}, click **{{< fa download >}} Export All**.

:::

::::
Expand Down
Loading