Differences

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

--- dido:02-crusible:99-annexes:annex-b:start [2026/07/15 09:26] – created nick_dido
+++ dido:02-crusible:99-annexes:annex-b:start [2026/07/20 07:07] (current) – ↷ Links adapted because of a move operation nick_dido
@@ Line 5: / Line 5: @@
 Annex B contains the references used by the Crucible documentation, requirements register, architecture descriptions, operational guidance, and supporting artifacts.
-Each reference resides on a separate wiki page with a stable URI so that Crucible pages can cite the source consistently.
+Each reference resides on a separate wiki page with a stable identifier and URI so that Crucible pages can cite the source consistently.
-Reference pages may identify:
+Crucible-specific references use identifiers in the form:
-  * Document title
+  * [C1]
-  * Author or issuing organization
+  * [C2]
-  * Version
+  * [C3]
-  * Revision
-  * Publication date
+The corresponding namespaces use only the stable numeric identifier rather than the document title.
-  * Document status
-  * Citation
+Examples include:
-  * Description
-  * Source location
+  * ''dido:02-crusible:99-annexes:annex-b-references:cr-001:start''
-  * Related Crucible pages
+  * ''dido:02-crusible:99-annexes:annex-b-references:cr-002:start''
-  * Supersession information
+The descriptive document title appears in the reference-page heading and in the References list.
 ===== References =====
-  * [[dido:02-crusible:99-annexes:annex-b-references:crucible-system-requirements-specification:start|Crucible System Requirements Specification]]
+  * [[dido:02-crusible:99-annexes:annex-b:cr-001|[C1] Crucible System Requirements Specification]]
-  * [[dido:02-crusible:99-annexes:annex-b-references:crucible-concept-of-operations:start|Crucible Concept of Operations]]
+  * [[dido:02-crusible:99-annexes:annex-b:cr-002|[C2] Crucible Concept of Operations]]
+===== Citation Use =====
+Crucible pages cite a reference by linking the stable identifier.
+For example:
+<code dokuwiki>
+[[dido:02-crusible:99-annexes:annex-b-references:cr-001:start|[C1]]]
+</code>
+A requirement Source section may use:
+<code dokuwiki>
+===== Source =====
+[[dido:02-crusible:99-annexes:annex-b-references:cr-001:start|[C1]]], Section 2, Mission Objectives, MO-001.
+</code>
 ===== Contents =====
@@ Line 35: / Line 54: @@
 Maintain each reference as a separate linked wiki page with a stable URI.
-Use the reference page as the canonical citation target rather than repeating complete citation information throughout the Crucible documentation.
+Assign each new Crucible-specific reference the next available identifier in the sequence [C1], [C2], [C3], and so forth.
+Use namespaces in the form:
+  * ''cr-001''
+  * ''cr-002''
+  * ''cr-003''
+Do not include the document title in the namespace.
+Use page headings in the form:
+<code dokuwiki>
+====== C1 - Document Title ======
+</code>
+Use the reference page as the canonical citation target rather than repeating the complete citation throughout the Crucible documentation.
 When a new revision supersedes a referenced document, update the applicable reference page with the new version, revision, date, status, and supersession relationship.
@@ Line 41: / Line 76: @@
 Preserve historical references when existing requirements, Evidence, reports, or externally published documents cite an earlier revision.
-Do not rename reference pages once they have been cited externally unless a redirect or move plan is in place.
+Do not renumber or rename reference pages after they have been cited externally unless a redirect or move plan is in place.
 ----