dido:03-dido-te:99-annexes:annex-b-references:start

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 09:21] – 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 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, 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] +
-  * [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 ===== ===== References =====
  
-  * [[dido:03-dido-te:99-annexes:annex-b-references:dte-001|[DTE1] U.S. Patent Application US20220237111A1]] +{{indexmenu>dido:03-dido-te:99-annexes:annex-b-references#1|js navbar nocookie maxjs#2 id#dido_te_annex_b_references_nav}}
-  * [[dido:03-dido-te:99-annexes:annex-b-references:dte-002|[DTE2] Non-Traditional BAA Submission]] +
-  * [[dido:03-dido-te:99-annexes:annex-b-references:dte-003|[DTE3] Draft BAA White Paper]] +
-  * [[dido:03-dido-te:99-annexes:annex-b-references:dte-004|[DTE4] DIDO Reference Data Model]]+
  
 ===== Citation Use ===== ===== 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:+For example:
  
 <code dokuwiki> <code dokuwiki>
-[[dido:03-dido-te:99-annexes:annex-b-references:dte-001|[DTE1]]], Claim 1.+[[dido:03-dido-te:99-annexes:annex-b-references:dte-002|[DTE2]]], Section 2.1.1.
 </code> </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 model-based references, cite [[dido:03-dido-te:99-annexes:annex-b-references:dte-004|[DTE4] DIDO Reference Data Model]] followed by the most precise model location available.
  
-For example:+A model citation may identify:
  
-<code dokuwiki> +  * a package; 
-[[dido:03-dido-te:99-annexes:annex-b-references:dte-002|[DTE2]]], Section 2.1.1, Key Tasks. +  * a diagram; 
-</code> +  * a model element; 
- +  * a datatype; 
-A citation to the DIDO Reference Data Model identifies the applicable diagram, package, model element, datatype, attribute, association, or other model element.+  * an attribute; 
 +  * an association; 
 +  * a relationship; 
 +  * a multiplicity; or 
 +  * another identifiable model construct.
  
 For example: 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> <code dokuwiki>
Line 66: Line 51:
 </code> </code>
  
-A citation to a conceptual datatype uses:+A more precise model citation may include the model path:
  
 <code dokuwiki> <code dokuwiki>
-[[dido:03-dido-te:99-annexes:annex-b-references:dte-004|[DTE4]]], conceptual datatype //yes_no_type//.+[[dido:03-dido-te:99-annexes:annex-b-references:dte-004|[DTE4]]], //DIDO - RI::DIDO - Conceptual Model::Community::Testing Package::Test//.
 </code> </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.+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.
  
-A caption for an exported diagram identifies [DTE4] as its source. +DIDO-TE architectural interpretations, refinements, and extensions are distinguished from structures directly represented by [DTE4].
- +
-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 ===== +
- +
-{{indexmenu>dido:03-dido-te:99-annexes:annex-b-references#1|js navbar nocookie maxjs#2 id#dido_te_annex_b_references_nav}}+
  
 ---- ----
Line 113: 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 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'':+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.
  
-<code> +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.
-dido:03-dido-te:99-annexes:annex-b-references:start +
-</code>+
  
-Use reference-page headings in the form:+Preserve source-model names, spellings, relationships, and multiplicities when documenting the source model unless an explicit DIDO-TE refinement is identified.
  
-  * ''====== [DTE1] Document Title ======'' +Preserve historical references when existing requirements, evidence, reports, or externally published documents cite an earlier revision.
-  * ''====== [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. +When a referenced source is superseded, record the supersession relationship on the applicable reference page.
- +
-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.
  
 ---- ----
  • dido/03-dido-te/99-annexes/annex-b-references/start.1786119686.txt.gz
  • Last modified: 2026/08/07 09:21
  • by nick_dido