Differences

This shows you the differences between two versions of the page.

--- dido:03-dido-te:99-annexes:annex-b-references:start [2026/08/07 10:51] – nick_dido
+++ dido:03-dido-te:99-annexes:annex-b-references:start [2026/08/19 18:48] (current) – nick_dido
@@ Line 3: / Line 3: @@
 [[dido:03-dido-te:99-annexes:start|Go to Annexes]]
-Annex B identifies the references used by the DIDO Test Environment (DIDO-TE) documentation, requirements register, architecture descriptions, testing guidance, and supporting artifacts.
+Annex B identifies the references used by the [[dido:99_annexes:annex-b-terms-and-definitions:d:dido-te|Distributed Immutable Data Object Test Environment (DIDO-TE)]].
-Each reference resides on a separate wiki page with a stable identifier and URI. DIDO-TE pages use these stable identifiers to cite source material consistently.
+Each DIDO-TE-specific reference has a stable identifier and URI so requirements, architecture sections, definitions, and other records can cite source material consistently.
-DIDO-TE-specific references use identifiers in the form:
+DIDO-TE-specific references use identifiers in the form ''[DTEn]'', where ''n'' is the assigned reference number.
-  * [DTE1]
+Individual reference pages are leaf pages and use namespaces in the form:
-  * [DTE2]
-  * [DTE3]
-  * [DTE4]
-The corresponding namespaces use the stable numeric identifier rather than the document title.
+<code>
+dte-NNN
-Examples include:
+</code>
-  * ''dido:03-dido-te:99-annexes:annex-b-references:dte-001''
-  * ''dido:03-dido-te:99-annexes:annex-b-references:dte-002''
-  * ''dido:03-dido-te:99-annexes:annex-b-references:dte-003''
-  * ''dido:03-dido-te:99-annexes:annex-b-references:dte-004''
-Reference pages are leaf pages and therefore omit a trailing '':start''.
-The descriptive document or artifact title appears in the reference-page heading and in the References list.
+The reference identifier remains stable throughout the lifecycle of the reference.
 ===== References =====
@@ Line 34: / Line 24: @@
   * [[dido:03-dido-te:99-annexes:annex-b-references:dte-004|[DTE4] DIDO Reference Data Model]]
   * [[dido:03-dido-te:99-annexes:annex-b-references:dte-005|[DTE5] DIDO-TE Requirements Register]]
+  * [[dido:03-dido-te:99-annexes:annex-b-references:dte-006|[DTE6] Structured Information Processing Reference Architecture (SIP-RA)]]
+  * [[dido:03-dido-te:99-annexes:annex-b-references:dte-007|[DTE7] Federated Data Interpretation Systems Reference Architecture (FDIS-RA)]]
+  * [[dido:03-dido-te:99-annexes:annex-b-references:dte-008|[DTE8] Reference Architecture Description]]
+  * [[dido:03-dido-te:99-annexes:annex-b-references:dte-009|[DTE9] Distributed Immutable Data Object Reference Architecture (DIDO-RA)]]
+  * [[dido:03-dido-te:99-annexes:annex-b-references:dte-010|[DTE10] OMG CBDC Working Group Response to the Federal Reserve Discussion Paper]]
 ===== Citation Use =====
-DIDO-TE pages cite a reference by linking its stable identifier.
+Citations use the stable reference identifier followed by the most precise applicable source location.
-For example, a requirement ''Derived From'' section uses:
-<code dokuwiki>
-[[dido:03-dido-te:99-annexes:annex-b-references:dte-001|[DTE1]]], Claim 1.
-</code>
-When a citation refers to a specific location within a textual source, the citation identifies the applicable section, clause, page, paragraph, claim, figure, table, or requirement following the reference link.
 For example:
 <code dokuwiki>
-[[dido:03-dido-te:99-annexes:annex-b-references:dte-002|[DTE2]]], Section 2.1.1, Key Tasks.
+[[dido:03-dido-te:99-annexes:annex-b-references:dte-002|[DTE2]]], Section 2.1.1.
 </code>
-A citation to the DIDO Reference Data Model identifies the applicable diagram, package, model element, datatype, attribute, association, or other model element.
+A citation to a model identifies the applicable package, diagram, model element, datatype, attribute, association, or other relevant model element.
 For example:
-<code dokuwiki>
-[[dido:03-dido-te:99-annexes:annex-b-references:dte-004|[DTE4]]], UML Class Diagram, //Test Environment Package//.
-</code>
-A citation to a specific model element uses:
 <code dokuwiki>
 [[dido:03-dido-te:99-annexes:annex-b-references:dte-004|[DTE4]]], model element //Test Plan//.
 </code>
-A citation to a conceptual datatype uses:
-<code dokuwiki>
-[[dido:03-dido-te:99-annexes:annex-b-references:dte-004|[DTE4]]], conceptual datatype //yes_no_type//.
-</code>
-Exported diagrams derived from the DIDO Reference Data Model serve as documentation figures or model views. They do not constitute separate Annex B references unless an exported diagram has independent authority, provenance, or revision control.
-A caption for an exported diagram identifies [DTE4] as its source.
-For example:
-<code dokuwiki>
-Figure X: Test Environment Package class diagram exported from [[dido:03-dido-te:99-annexes:annex-b-references:dte-004|[DTE4]]].
-</code>
-===== Use of Model Content =====
-[DTE4] records a conceptual model. Its datatypes define semantic meaning and value spaces without prescribing logical or physical representations.
-DIDO-TE documentation preserves the following model hierarchy:
-  * The Conceptual Model defines implementation-independent meaning and semantic distinctions.
-  * A Logical Model maps conceptual elements and datatypes to implementable logical representations.
-  * A Physical Model maps logical representations to concrete platform-specific datatypes, encodings, constraints, and structures.
-Requirements derived from [DTE4] identify the applicable source element and document any normalization applied to its name or expression.
-Corrections to spelling, capitalization, or naming conventions do not alter the historical source. The requirement or model derivation record identifies both the original source name and its normalized name.
-For example:
-^ Source name in [DTE4] ^ Normalized name ^
-| ''Parameter_Diretion_Type'' | ''Parameter Direction Type'' |
-| ''ParameterLlist Type'' | ''Parameter List Type'' |
-| ''Parameter_Definition_Type'' | ''Parameter Definition Type'' |
-An editorial correction preserves the source meaning. A change to a datatype's values, relationships, constraints, or semantics constitutes a model change and requires an explicit rationale and traceable disposition.
 ===== Contents =====
@@ Line 114: / Line 56: @@
 ===== Notes for Editors =====
-Maintain each reference as a separate linked wiki page with a stable URI.
+Assign each new DIDO-TE-specific reference the next available ''DTE'' identifier.
-Assign each new DIDO-TE-specific reference the next available identifier in the sequence [DTE1], [DTE2], [DTE3], and so forth.
+Maintain each reference as a separate leaf page with a stable URI.
-Use leaf namespaces in the form:
+Do not reuse or renumber an assigned reference identifier.
-  * ''dte-001''
+Use the reference page as the canonical citation target.
-  * ''dte-002''
-  * ''dte-003''
-  * ''dte-004''
-Do not include the document title in the namespace.
+Identify the most precise source location available when deriving a requirement or architectural statement from a reference.
-Do not append '':start'' to an individual reference page. The Annex B index page is a non-leaf page and retains '':start'':
+Preserve historical references when existing requirements, evidence, reports, or externally published documents cite an earlier revision.
-<code>
+When a referenced source is superseded, record the supersession relationship on the applicable reference page.
-dido:03-dido-te:99-annexes:annex-b-references:start
-</code>
-Use reference-page headings in the form:
-  * ''====== [DTE1] Document Title ======''
-  * ''====== [DTE2] Document Title ======''
-  * ''====== [DTE3] Document Title ======''
-  * ''====== [DTE4] Artifact Title ======''
-Use the reference page as the canonical citation target rather than repeating the complete bibliographic citation throughout the DIDO-TE documentation.
-Identify the precise source location whenever a requirement derives from a reference. Do not cite only the reference identifier when a more precise section, clause, paragraph, claim, figure, diagram, package, or model element is available.
-Treat a native model file as the source artifact. Treat diagrams exported from the model as views of that source unless an export has independent authority, provenance, or revision control.
-Do not treat historical model content as a current normative requirement without analysis, normalization, traceability, review, and approval.
-Preserve the spelling and terminology found in the historical source when recording provenance. Apply corrected and normalized terminology in current DIDO-TE requirements, definitions, and architecture content.
-Document every correction by recording the original source expression and the normalized expression. Do not classify a semantic change as an editorial correction.
-Preserve the distinction between conceptual, logical, and physical models. Do not add implementation-specific datatypes, encodings, products, or technologies to a conceptual-model requirement.
-When a new revision supersedes a referenced document or model, update the applicable reference page with its version, revision, date, status, and supersession relationship.
-Preserve historical references when existing requirements, evidence, reports, or externally published documents cite an earlier revision.
-Do not renumber or rename reference pages after external citation unless a redirect or move plan is in place.
+Do not rename a reference page after external citation unless a redirect or move plan is in place.
 ----