Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
dido:03-dido-te:99-annexes:annex-b-references:start [2026/08/07 08:06] – [Contents] nick_didodido:03-dido-te:99-annexes:annex-b-references:start [2026/08/23 16:57] (current) nick_dido
Line 3: Line 3:
 [[dido:03-dido-te:99-annexes:start|Go to Annexes]] [[dido:03-dido-te:99-annexes:start|Go to Annexes]]
  
-Annex B contains 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 so that DIDO-TE pages cite the source consistently.+Each DIDO-TE-specific reference has a stable identifier and URI so requirements, architecture sections, definitions, information-model elements, 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]+
  
-The corresponding namespaces use only the stable numeric identifier rather than the document title.+<code> 
 +dte-NNN 
 +</code>
  
-Examples include: +The reference identifier remains stable throughout the lifecycle of the reference.
- +
-  * ''dido:03-dido-te:99-annexes:annex-b-references:dte-001:start'' +
-  * ''dido:03-dido-te:99-annexes:annex-b-references:dte-002:start'' +
-  * ''dido:03-dido-te:99-annexes:annex-b-references:dte-003:start'' +
- +
-The descriptive document title appears in the reference-page heading and in the References list.+
  
 ===== References ===== ===== References =====
  
-<todo>Identify and create the DIDO-TE reference pages.</todo>+{{indexmenu>dido:03-dido-te:99-annexes:annex-b-references#1|js navbar nocookie maxjs#2 id#dido_te_annex_b_references_nav}}
  
 ===== Citation Use ===== ===== Citation Use =====
  
-DIDO-TE pages cite a reference by linking the stable identifier.+Citations use the stable reference identifier followed by the most precise applicable source location.
  
-For example, a requirement ''Source'' section uses:+For example:
  
-[[dido:03-dido-te:99-annexes:annex-b-references:dte-001:start|[DTE1]]], Section 2, Mission Objectives, MO-001.+<code dokuwiki> 
 +[[dido:03-dido-te:99-annexes:annex-b-references:dte-002|[DTE2]]], Section 2.1.1. 
 +</code>
  
-When a citation refers to a specific location within a source, the citation identifies the applicable section, clause, page, figure, table, or requirement following the reference link.+For model-based referencescite [[dido:03-dido-te:99-annexes:annex-b-references:dte-004|[DTE4] DIDO Reference Data Model]] followed by the most precise model location available.
  
-===== References =====+A model citation may identify:
  
-  * [[dido:03-dido-te:99-annexes:annex-b-references:dte-001|[DTE1] U.S. Patent Application US20220237111A1]] +  * a package; 
-  * [[dido:03-dido-te:99-annexes:annex-b-references:dte-002|[DTE2] Non-Traditional Broad Agency Announcement]] +  * a diagram; 
-  * [[dido:03-dido-te:99-annexes:annex-b-references:dte-003|[DTE3] Broad Agency Announcement White Paper]]+  * a model element; 
 +  * a datatype; 
 +  * an attribute; 
 +  * an association; 
 +  * a relationship; 
 +  * a multiplicity; or 
 +  * another identifiable model construct.
  
-{{indexmenu>dido:03-dido-te:99-annexes:annex-b-references#1|js navbar nocookie maxjs#2 id#dido_te_annex_b_references_nav}}+For example: 
 + 
 +<code dokuwiki> 
 +[[dido:03-dido-te:99-annexes:annex-b-references:dte-004|[DTE4]]], model element //Test Plan//. 
 +</code> 
 + 
 +A more precise model citation may include the model path: 
 + 
 +<code dokuwiki> 
 +[[dido:03-dido-te:99-annexes:annex-b-references:dte-004|[DTE4]]], //DIDO - RI::DIDO - Conceptual Model::Community::Testing Package::Test//
 +</code> 
 + 
 +Where a DIDO-TE Information Model page documents a relationship, attribute, multiplicity, or other structure extracted from the DIDO Reference Data Model, the page cites [DTE4] and identifies the applicable source-model location. 
 + 
 +DIDO-TE architectural interpretations, refinements, and extensions are distinguished from structures directly represented by [DTE4].
  
 ---- ----
Line 49: Line 65:
 ===== Notes for Editors ===== ===== 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 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''+
  
-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.
  
-Use page headings in the form:+For model citations, use [DTE4] as the canonical source reference and identify the applicable package, diagram, model element, datatype, attribute, association, multiplicity, or model path.
  
-  * ''====== [DTE1Document Title ======'' +Do not represent a DIDO-TE refinement or extension as though it were present in [DTE4]. Distinguish source-model content from DIDO-TE architectural interpretation.
-  * ''====== [DTE2] Document Title ======'' +
-  * ''====== [DTE3] Document Title ======''+
  
-Use the reference page as the canonical citation target rather than repeating the complete citation throughout the DIDO-TE documentation.+Preserve source-model names, spellings, relationships, and multiplicities when documenting the source model unless an explicit DIDO-TE refinement is identified.
  
-When a new revision supersedes a referenced documentupdate the applicable reference page with the new version, revision, date, status, and supersession relationship.+Preserve historical references when existing requirementsevidencereports, or externally published documents cite an earlier revision.
  
-Preserve historical references when existing requirementsEvidence, reports, or externally published documents cite an earlier revision.+When a referenced source is supersededrecord the supersession relationship on the applicable reference page.
  
-Do not renumber or rename reference pages after external citation unless a redirect or move plan is in place.+Do not rename reference page after external citation unless a redirect or move plan is in place.
  
 ---- ----
  • dido/03-dido-te/99-annexes/annex-b-references/start.1786115217.txt.gz
  • Last modified: 2026/08/07 08:06
  • by nick_dido