Konventionen und Vorgaben Dokumentation
Diese Seite ist ein Teil der IsyFact-Standards.
Alle Inhalte der Seite, insbesondere Texte und Grafiken, sind urheberrechtlich geschützt.
Alle urheberrechtlichen Nutzungs- und Verwertungsrechte liegen beim Bundesverwaltungsamt.
Die Nutzung ist unter den Lizenzbedingungen der Creative Commons Namensnennung 4.0 International gestattet.
1. Konventionen und Vorgaben zur Dokumentation der IsyFact
Die Dokumentation der IsyFact ist über die Säulen bis auf die Ebene darunter strukturiert. Bestimmte Bestandteile der IsyFact teilen dabei gemeinsame Merkmale. Aus diesem Grund können Konventionen und Vorgaben zur Dokumentation von IsyFact-Bestandteilen die strukturell-inhaltliche Einheitlichkeit der Beschreibung gewährleisten.
Folgende Maßnahmen unterstützen die Standardisierung:
- Methodik und Richtlinien für fachliche und technische Modellierung
- Methodik zur Dokumentation von Anwendungen
- Methodik zur Dokumentation der IsyFact
2. Dokumentation der Säulen
Ein allgemeiner Überblick über die IsyFact findet sich im Hauptknoten Einstieg und seinen Unterseiten. Dazu zählen das Tutorial, das Whitepaper und der Migrationsleitfaden zur IsyFact 2.
Die Dokumentation der Blaupausen enthält je ein Detailkonzept pro Blaupause.
Die Dokumentation der Bausteine erfolgt abhängig von ihrer Ausprägung (u.a. Software-Bibliothek, Querschnittsanwendung). In der folgenden Abbildung können die Dokumentationstypen abgelesen werden, mit denen ein Baustein dokumentiert wird.
Die Dokumentation der Plattform enthält für jede von der IsyFact empfohlene oder eingesetzte Technologie zum Betrieb von IT-Systemen (z.B. HTTP- und Applikationsserver, Datenbanken) ein Nutzungskonzept.
Die Dokumentation der Methodik bietet neben der Dokumentation des methodischen Vorgehens Vorlagen für Dokumentationstypen sowie hilfreiche Arbeitsmittel zur Durchführung eines IsyFact-Projektes.
Schließlich umfasst die Dokumentation der Werkzeuge eine Beschreibung pro Werkzeug, welche die Nutzung begründet und Nutzungsvorgaben festlegt.