Review documentation

Use the ValidMind Platform to review the documentation provided by developers as part of the formal validation process.

Prerequisites

• You are logged in to ValidMind.
• A developer has submitted documentation for review.¹
• You are a Validator or assigned another role with sufficient permissions to perform the tasks in this guide.²

¹ Submit for approval

² Manage permissions

Key concepts

review

Entails a comprehensive evaluation process covering four key aspects of documentation to ensure thoroughness, compliance, and reliability:

• Conceptual soundness — Examines the foundational elements of the record, including its overview, intended business use, regulatory requirements, and limitations. Ensures that the record’s purpose, scope, and constraints are well-defined and understood by stakeholders.

• Data preparation — Assesses the quality and preparation of the data used for record training. Includes a detailed look at dataset summaries, data quality tests, descriptive statistics, correlations, interactions, and feature engineering. The aim is to verify that the record is built on a robust and relevant dataset.

• Development — Focuses on the record’s development process, including training, evaluation, explainability, interpretability, and diagnosis. Highlights the record’s performance, identifies strengths and weaknesses, and ensures that any potential issues such as overfitting are addressed. Evaluates the assumptions made and examines the qualitative information and judgments to ensure they are conducted appropriately and systematically.

• Monitoring and governance — Evaluates the ongoing strategies for monitoring the record’s performance and ensuring compliance with regulatory and ethical standards. Involves checking the implementation of the monitoring plan and governance strategies to maintain the record’s efficacy over time. Covers reporting outputs to ensure transparency and accuracy in the record’s documented results.

These elements collectively ensure that the documentation is thorough, transparent, and meets all necessary standards and regulatory requirements.

Document Overview

NoneStatic PDF uploads do not include a Document Overview.

Only PDFs converted to editable documents,³ documents generated by the ValidMind Library, or documents created in the ValidMind Platform include a Document Overview.

³ Manage documents

The Document Overview shows a section-by-section outline of your record’s documentation, as well as summaries of:

• Any unresolved conversations⁴
• The number of associated artifacts⁵
• The completion status for your documentation⁶
• Recent activity on your record⁷

⁴ Collaborate with others

⁵ Working with artifacts

⁶ Assign section statuses

⁷ View record activity

To locate your document overview for a record:

1. In the left sidebar, click Inventory.

2. Select a record or find your record by applying a filter or searching for it.⁸

3. In the left sidebar that appears for your record, click Documents and select the Latest or Saved Versions tab.⁹

4. Click on a Development type file.¹⁰

⁸ Working with the inventory

⁹ Work with document versions

¹⁰ Working with documents

Unresolved conversations

Hover over # to see a preview of the unresolved conversation associated with the documentation section.

Resolve conversations directly from this popup, or click to expand the conversation.

Validation issues

Hover over # to see a preview of validation issues associated with the documentation section.

Click to expand the artifact.

Completion status

The #/# Done indicator reflects the completion status of your documentation sections.

Recent activity

At the bottom of the Document Overview page, you will also see quick view of any recent documentation activity.

• Use the top tabs to narrow down the recent activity.
• Click on View All Activity to be taken to the Activity page.