10 Dokumentation - Universität Stuttgart

10.3 Systemdokumentation
ST I
Beispielaufbau einer Modulbeschreibung
– Name: Name des Moduls
– Stichwort: Kurze Kennzeichnung der Aufgabe
– Importschnittstelle: Angabe von Name, Typ und Bedeutung aller importierten
Operationen und ihrer Zugehörigkeit zu einem Modul
– Exportschnittstelle: Angabe von Typ und Bedeutung aller exportierten
Operationen
– Aufrufe: Aufrufe sämtlicher exportierter Prozeduren mit Parametern
und Parametertypen, Unterscheidung Eingangs-, Ergebnisund
Übergangsparameter
– Aufgabe: Kurze Beschreibung der Aufgaben eines Moduls
– Datenstrukturen: Eigenschaften der Datenstrukturen aus der Sicht der
Modulbenutzer
– Exportierte und innere Prozeduren:
– Konkrete Datenstruktur:
Beschreibung der Prozeduren / Algorithmen / des Verhaltens
im Fehlerfall, Hinweise auf die Behandlung von Sonderfällen
Konkrete Implementierung von abstrakten Datenstrukturen
– Modulinitialisierung: Beschreibung von Modulvorbedingungen
© 2013 IAS, Universität Stuttgart 473