Documentation

Purpose

Generate Markdown documentation based on notes in the design metadata.

Motivation

Provide an overview of all details captured in the design process.

Applicability

• All design metadata

Design Pattern

N/A

Schema Type

N/A

Output Type

• Markdown

Implementation guidelines

This template covers all design metadata.

Considerations and consequences

N/A.

Extensions

N/A.

Code

<h1>Project documentation</h1>

<h2>Data Objects</h2>

The overview of data object definitions. These are files or tables that act as data stores.

{{!-- Source objects --}}
{{#each dataObjects}}
{{~#if @first}}<h3>Operational system data sets (sources)</h3>

> [!NOTE]
> This section covers all data objects that have the 'Source' classification.{{/if}}{{#hasClassification classifications "Source"}}

**{{name}}**
* Data Definition code location: .\Databases\\{{../../conventions.sourceObjectLocation}}\Tables\\{{name}}.sql
{{#if notes}}* {{notes}}{{~/if}}{{/hasClassification~}}
{{/each}}
{{!-- Spacer --}}
{{#if false}}

{{else}}


{{/if}}
{{!-- Landing objects --}}
{{#each dataObjects~}}

{{#if @first}}<h3>Landing area objects</h3>

> [!NOTE]
> The landing/staging objects that act to initially copy the data (or data delta) from the source objects.
> These are the data objects with the 'Landing' classification.{{/if}}{{#hasClassification classifications "Landing"}}

**{{name}}**
* Data Definition code location: .\Databases\\{{../../conventions.landingAreaObjectLocation}}\Tables\\{{name}}.sql
{{#if notes}}* {{notes}}{{~/if}}{{/hasClassification~}}
{{~/each}}
{{!-- Spacer --}}
{{#if false}}

{{else}}

{{/if}}
{{!-- Persistent Staging objects --}}
{{#each dataObjects~}}

{{#if @first}}<h3>Persistent Staging Area (PSA) objects</h3>

> [!NOTE]
> The historized and timestamped archive of transactions collected from the source objects over time.
> These are the data objects with the 'Persistent Staging' classification.{{/if}}{{#hasClassification classifications "Persistent Staging"}}

**{{name}}**
* Data Definition code location: .\Databases\\{{../../conventions.persistentStagingAreaObjectLocation}}\Tables\\{{name}}.sql
{{#if notes}}* {{notes}}{{~/if}}{{/hasClassification~}}
{{~/each}}
{{!-- Spacer --}}
{{#if false}}

{{else}}

{{/if}}
<h2>Data Logistics Processes</h2>

{{!-- Landing mappings --}}
{{#each dataObjectMappings}}
{{~#if @first}}<h3>Landing area data logistics processes</h3>
{{/if}}{{#hasClassification classifications "Landing"}}
**{{name}}**
* Code location: .\Databases\\{{../../conventions.landingAreaObjectLocation}}\Stored Procedures\\{{name}}.sql
{{#if notes}}* {{notes}}{{~/if}}{{/hasClassification~}}
{{/each}}
{{!-- Spacer --}}
{{#if false}}

{{else}}

{{/if}}
{{!-- Persistent Staging objects --}}
{{#each dataObjectMappings}}
{{~#if @first}}<h3>Persistent Staging data logistics processes</h3>
{{/if}}{{#hasClassification classifications "Persistent Staging"}}
**{{name}}**
* Code location .\Databases\\{{../../conventions.persistentStagingAreaObjectLocation}}\Stored Procedures\\{{name}}.sql
{{#if notes}}* {{notes}}{{~/if}}{{/hasClassification~}}
{{/each}}