Zum Hauptinhalt springen

Nutzung der Dokumentation

Struktur​

Allgemein​

Die Dokumentation ist entlang der FIM-Bausteine strukturiert.

Wo finde ich was?​

Markierungen​

Neben der textuellen Beschreibung finden Sie in der Dokumentation wiederkehrende Elemente, die Ihnen die das Verständnis verbessern und den Einstieg erleichtern sollen.

SymbolBedeutung
⚠️Besonders wichtige Informationen
✔️Positive Beispiele
❌Negative Beispiele
🆕Neue Elemente in FIM (bspw. im technischen Standard)

Nutzung von Badges​

ab XZuFi 2.3
ab XDF 3
ab XProzess 3

NEU Badges sollten möglichst vor dem Text platziert werden.
Badges können auch im Text SDG verwendet werden, um auf bestimmte Versionen oder Anforderungen hinzuweisen.

Verwendung von Markierungen in Überschriften ⭐​

Werden Markierungen in Überschriften verwendet, werden diese auch in Sidebars angezeigt.

Verwendung von Markierungen in Texten​

:heavy_exclamation_mark: Sollen Markierungen nur am Anfang, nur am Ende oder an beliebiger Stelle in Texten verwendet werden?

Code-Beispiele​

<xzufi:referenzLeiKa listURI="urn:de:fim:leika:leistung" listVersionID="20220301">
  <code>99003057001000</code>
</xzufi:referenzLeiKa>

Infoboxen​

Detailboxen zu bestimmten Themen

Detailboxen enthalten Zusammenfassungen von Themen, welche nur peripher mit dem Abschnitt zusammenhängen.

Admonitions​

Info

Info-Boxen (blau) enthalten allgemeine Informationen.

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus blandit dapibus orci at molestie. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos.

Randnotiz

Randnotiz-Boxen (weiß) enthalten weiterführende Informationen zu den jeweiligen Seiten oder Abschnitten.

Praxis-Tipp

Tipps (grün) sind Hinweise, welche sich in der praktischen Arbeit als hilfreich erwiesen haben.

Merke

Merk-Boxen (gelb) fassen wichtige Informationen kompakt und leicht verständlich zusammen.

Achtung

Achtung-Boxen (rot) sind Hinweise auf mögliche Probleme oder Fehlerquellen in der Arbeit und sollten unbedingt beachtet werden.

Metadaten​

Die Metadaten unterscheiden sich durch ihre Charakteristik. Diese Unterschiede werden auch optisch in den Übersichten deutlich gemacht:

  • Schlüsselattribute*
    • Ein Schlüsselattribut identifiziert das FIM-Element eindeutig.
    • Kennzeichnung: *
    • Alle Schlüsselattribute sind auch Pflichtattribute
  • Pflichtattribute
    • Ein Pflichtattribut muss zu jedem FIM-Element angeben werden
    • Kennzeichnung: fette Schreibweise
  • Optionale Attribute
    • Ein optionales Attribut muss nicht zwangsläufig zu einem FIM-Element angegeben werden bzw. kann im Rahmen einer späteren Nachpflege gefüllt werden.
    • Kennzeichnung: kursive Schreibweise
  • Automatisch befüllte Attribute
    • Diese Attribute sollten direkt vom Software-System nach vorgegebener Logik befüllt werden und nicht durch die Nutzer editierbar sein.
    • Kennzeichnung: unterstrichen

Um die Vielzahl der Metadaten übersichtlicher zu gestalten, werden diese in verschiedene Kategorien gruppiert. Die Kategorien Identifikationsangaben und Zustandsangaben kommen in jedem FIM-Element vor. Darüber hinaus werden aber auch weitere Kategorien hinzugefügt.