Vorlagen
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. Allgemeines
Die Vorlagen unterstützen die Erstellung projektspezifischer Dokumentation wesentlich. Sie enthalten Word-, Excel- oder AsciiDoc-Dateien, die im Projektverlauf gefüllt werden müssen.
Nach Bedarf können für die dauerhafte Ablage aus Word- und AsciiDoc-Vorlagen PDF-Dokumente erzeugt werden. Für Word-Vorlagen wird hierzu die integrierte Funktion von Word genutzt. Für AsciiDoc-Vorlagen kann Asciidoctor PDF verwendet werden.
Word- und Excel-Vorlagen können direkt von dieser Seite als Download bezogen werden. AsciiDoc-Vorlagen können sowohl direkt aufgerufen als auch im ZIP- oder PDF-Format heruntergeladen werden.
2. Dokumentation einer Anwendung
Die Vorlagen zur Dokumentation einer Anwendung beschreiben diese aus den drei aus der Referenzarchitektur bekannten Sichten:
-
Systemspezifikation: fachliche Sicht,
-
Systementwurf: software-technische Sicht,
-
Systemhandbuch: Sicht der technischen Infrastruktur.
Alle Vorlagen enthalten Ausfüllhinweise und Beispiele.
Die Vorlage Systemspezifikation enthält die Gliederung für eine V-Modell-konforme Gesamtsystemspezifikation (Pflichtenheft) eines Softwaresystems (Software-Entwicklungsprojekts).
| Vorlage | Quelldatei (AsciiDoc) |
Downloads (ZIP, PDF, Word) | ||
|---|---|---|---|---|
Systemspezifikation |
||||
Systementwurf |
||||
Systemhandbuch |
||||
3. Fachliche Schnittstellendokumentation
Die Vorlage enthält die Gliederung für eine V-Modell-konforme Schnittstellendokumentation eines Softwaresystems (Software-Entwicklungsprojekts) mitsamt Ausfüllhinweisen und Beispielen.
| Vorlage | Quelldatei (AsciiDoc) | Download (Word) |
|---|---|---|
Schnittstellendokumentation |
4. Datenflussdiagramm
Eine Anwendungslandschaft besteht aus mehreren Anwendungen, die Daten untereinander und mit ihren Anwendern austauschen. Die Anleitung zu Datenflussdiagrammen hilft bei der Erstellung von Datenflussdiagrammen und gibt Best Practices zur strukturierten Beschreibung dieses Datenflusses.
| Vorlage | Quelldatei (AsciiDoc) | Download (Word) |
|---|---|---|
Datenflussdiagramm |
5. Anforderungsliste
Die Anforderungsliste ist ein Instrument, um die Übersicht und die Nachvollziehbarkeit des Umsetzungsstatus aller Anforderungen an ein System im gesamten Projektlebenszyklus zu erhalten. Die Anforderungsliste beschreibt mit jeder Anforderung eine Eigenschaft, die eine Anwendung haben soll. Dies kann eine bestimmte Funktionalität oder auch eine Anforderung in Hinblick auf die Qualität sein, zum Beispiel die maximale Reaktionszeit bei einer Eingabe. Die Anforderungsliste ist bei ihrer Erstellung und bei jeder Versionierung ein Mittel der Kommunikation zwischen Auftraggeber und Auftragnehmer.
| Vorlage | Quelldatei (Excel) |
|---|---|
Anforderungsliste |