From 5651355e39b791fe2994fc5d4be42ef68c9c01d8 Mon Sep 17 00:00:00 2001 From: civilx64 <26513472+civilx64@users.noreply.github.com> Date: Tue, 2 Apr 2024 17:24:27 -0400 Subject: [PATCH] clarify non-normative checks in documentation --- docs/conf.py | 2 ++ docs/user/validation_overview.md | 21 ++++++++++++++------- 2 files changed, 16 insertions(+), 7 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 2773030..90cc0f7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -29,3 +29,5 @@ html_theme = 'sphinx_rtd_theme' html_static_path = ['_static'] + +myst_links_external_new_tab = True diff --git a/docs/user/validation_overview.md b/docs/user/validation_overview.md index a55ee44..f39c10a 100644 --- a/docs/user/validation_overview.md +++ b/docs/user/validation_overview.md @@ -1,11 +1,14 @@ -# Understanding the steps of the validation process +# Understanding the validation process -## Syntax +Given an IFC file, the Validation Service provides a judgement of conformity +against the IFC standard - including schema and specification + +## STEP Syntax The first step in the validation process looks at the uploaded file to confirm that it is a valid STEP Physical File (SPF) in accordance with [ISO 10303-21](https://www.iso.org/standard/63141.html). -## Schema +## IFC Schema Schema validation consists of two parts: @@ -40,7 +43,6 @@ There are two categories of normative checks: 1. Implementer Agreements 2. Informal Propositions -3. Industry Practices ### Implementer Agreements @@ -51,10 +53,15 @@ These are normative checks that have been ratified as official agreements amongs These are normative checks that have not been ratified as implementer agreements, but are still considered mandatory for a file to be considered valid. +## Additional, Non-normative Checks + ### Industry Practices -These series of checks are different than the previous two in that they will only raise a warning and not be considered an error. +This step involves checking the IFC file against common practices and sensible defaults. +None of these checks render the IFC file invalid. +Therefore, any issues identified result in warnings rather than errors. -## bsDD Checks +### buildingSMART Data Dictionary (bSDD) Compliance -These checks verify that all applicable buildingSMART Data Dictionary (bsDD) requirements are met. +This step includes checking whether references to classifications and properties from bSDD +found in an IFC file comply the source definitions in bSDD.