Guidance Catalog
GuidanceCatalog
Experimental
GuidanceCatalog represents a concerted documentation effort to help bring about an optimal future without foreknowledge of the implementation details
metadata object Required
type GuidanceType Required
type categorizes this document based on the intent of its contents
exemptions array[Exemption]
exemptions provides information about situations where this guidance is not applicable
front-matter string
front-matter provides introductory text for the document to be used during rendering
guidelines array[Guideline]
guidelines is a list of unique guidelines defined by this catalog
GuidanceType
GuidanceType restricts the possible types that a catalog may be listed as
- Type:
string
Guideline
Experimental
Guideline provides explanatory context and recommendations for designing optimal outcomes
group string Required
group provides an id to the group that this guideline belongs to
id string Required
id allows this entry to be referenced by other elements
objective string Required
objective is a unified statement of intent, which may encompass multiple situationally applicable statements
state Lifecycle Required
state is the lifecycle state of this guideline
title string Required
title describes the contents of this guideline
applicability array[string]
applicability specifies the contexts in which this guideline applies
extends EntryMapping
extends is an id for a guideline which this guideline adds to, in this document or elsewhere
principles array[MultiEntryMapping]
principles documents the relationship between this guideline and one or more principles
rationale Rationale
rationale provides the context for this guideline
recommendations array[string]
recommendations is a list of non-binding suggestions to aid in evaluation or enforcement of the guideline
replaced-by EntryMapping
replaced-by references the guideline that supersedes this one when deprecated or retired
see-also array[string]
see-also lists related guideline IDs within the same GuidanceCatalog
statements array[Statement]
statements is a list of structural sub-requirements within a guideline
vectors array[MultiEntryMapping]
vector-mappings documents the relationship between this guideline and one or more vectors
Statement
Experimental
Statement represents a structural sub-requirement within a guideline;
id string Required
id allows this entry to be referenced by other elements
text string Required
text is the body of this statement
recommendations array[string]
recommendations is a list of non-binding suggestions to aid in evaluation or enforcement of the statement
title string
title describes the contents of this statement
Rationale
Experimental
Rationale provides a structured way to communicate a guideline author’s intent
goals array[string] Required
goals is a list of outcomes this guideline seeks to achieve
importance string Required
importance is an explanation of why this guideline matters
Exemption
Experimental
Exemption describes a single scenario where the catalog is not applicable
description string Required
description identifies who or what is exempt from the full guidance
reason string Required
reason explains why the exemption is granted
redirect MultiEntryMapping
redirect points to alternative guidelines or controls that should be followed instead