ET-DOC-NAV-LINK-001
Navigation and Link Contract#
Navigation#
Kanonische Einstiege werden ausdrücklich benannt. Nummerierte Verzeichnisse definieren Reihenfolge, ersetzen aber keine lokalen README-Einstiege.
Linkauflösung#
- relative Repositorylinks werden gegen die Quelldatei aufgelöst,
- Anker werden innerhalb des Zielartefakts geprüft, sofern das Werkzeug dies unterstützt,
- externe Links werden getrennt von Repositorylinks bewertet,
- Links auf generierte Laufzeitausgaben dürfen keine dauerhafte Quellabhängigkeit bilden.
Findings#
Mindestens unterschieden werden: fehlendes Ziel, unzulässiger Pfad, zyklische Einstiegskette, verwaistes kanonisches GlossarbegriffEin Artefakt ist jede eindeutig identifizierbare fachliche, technische, organisatorische oder reale Einheit, die in der Engineering-Landschaft modelliert wird. Alles Modellierbare wird als Artefakt geführt. Dazu gehören unter anderem Systeme, Beziehungen, Features, Dokumente, ADRs, Tests, UI-Buttons, Menüs, Farben, Icons, Konfigurationen, Diagramme, Runtime-Ressourcen, fachliche Objekte und reale Objekte wie ein Blumentopf, sofern sie modelliert werden. Knowledge ist keine Sonderklasse. UI- und Applikationsartefakte werden fachlich nach demselben Grundmodell behandelt.Glossareintrag vollständig lesen und nicht prüfbarer externer Verweis.
Änderungsregel#
Ein Dokumentationswerkzeug darf Links nicht automatisch auf ein nur ähnlich benanntes Ziel umbiegen. Mehrdeutigkeit ist ein GlossarbegriffTechnical documentation artifact.Glossareintrag vollständig lesen und benötigt eine bewusste Quelländerung.