Namenskonventionen

Auch für die Dokumentation gelten Namenskonventionen. Wenn nicht gesondert beschrieben, gelten folgende Konventionen für alle Namen, die der Ablage der Dokumentation dienen und keine Anzeigenamen sind, also z.B. Dateinamen inklusive Asciidoc- und Bild-Dateien, Verzeichnisnamen, Namen für Antora-Komponenten und -Module und Anchor. Mit Kleinbuchstaben sind Kleinbuchstaben ohne Umlaute und Sonderzeichen gemeint. Ferner sind keine Füllwörter erlaubt (wie z.B. und, oder, für). Die Namen sollten den Inhalt widerspiegeln.

Bei einigen Namen in der IsyFact-Dokumentation ist die Umstellung der Namen gemäß Namenskonvention noch in Arbeit.

Tabelle 1. Namensschema für Dokumentation (keine Anzeigenamen)
Namen in Dokumentation
Schema	`<beliebig: Kleinbuchstaben, Bindestriche, einzelne Ziffern, wenn unbedingt nötig>`
Beispiel	`isyfact-standards`
falsch	`_isyfact, IsyFact, isyfact standards, lösung, standards-und-erweiterungen`

Tabelle 2. Konvention für Dateinamen von Abbildungen aus draw.io
Dateinamen für Abbildungen aus draw.io
Schema	`<name-der-abbildung>.dn.svg`
Beispiel	`beispiel.dn.svg`