 |
7. Die Generierung von Programmdokumentationen (ABAP Programme, BI-Objekte, Coding-Auswertungen)
Der CT-Assist analysiert und bewertet den jeweiligen ABAP™ Source Code (Transaktion, Report, Funktionsbaustein, Klassen, lokale Programmelemente, ...) nach unterschiedlichen Kriterien. Durch Auswertungsprofile legen Sie Art und Umfang der daraus resultierenden Dokumentation fest.
Über einen Auswahldialog werden im CT-Assist mehr als 20 Auswertungsprofile angeboten. Zusätzlich können Sie bestimmen, welche manuell erstellten Informationsobjekte in der Programmdokumentation berücksichtigt werden sollen (Doku-Checklisten, Workflow-Formulare, Info-Objekte, ...).
Über die Menüfunktion '->Doku ->Dokumentation als Historie erstellen' können neben der Programmdokumentation zusätzlich in einem Daten-Container sämtliche Doku-Objekte (Workflow-Formulare, externe Dokumente, Analysen usw.) gespeichert und in einem gesonderten Pfad/Doku-Server oder innerhalb des 'Enterprise Knowledge Management' auf dem SAP-Applikationsserver mit 'Datum-Uhrzeit-Programmname' gesichert werden. Die Ausgabe der Dokumentation kann im Format RTF oder HTML erfolgen.
7.1 Der Screen-Shot zeigt auf Seite 1 im RTF-Format das Ergebnis einer generierten Programmdokumentation...

Die RTF-Dokumentation wird strukturiert durch den Doku-Navigationstree. Durch Doppelklick im Tree erhalten Sie die jeweiligen Detail-Informationen. Über den Zoomregler können Sie die skalierbaren grafischen Darstellungen (CALL-Grafik, UML, ERM, Flow-Logic, BI-Analysen, ...) vergrößern. Das dokumentierte ABAP Programm enthält ca. 1800 Programmzeilen, daraus wurden 194 Seiten ausführliche Dokumentation erzeugt. Den Dokumentationsumfang bestimmen Sie über Auswertungsprofile.
7.2 Der Screen-Shot zeigt aus der Programmdokumentation das Workflow-Formular DSB1 mit der Listausgabe des dokumentierten ABAP Reports ...

Hinweise zu einzelnen Details:
- 1 = Screen-Shot der Druckausgabe des dokumentierten ABAP Programms 'YCT-EX_DOKU99'
- 2 = Das Workflow-Formular DSB1 (mit dem Screen-Shot der Listausgabe) wurde mit dem Source Coding verlinkt (= ermöglicht bidirektionaler Zugriff)
- 3 = Durch Doppelklick im Navigationstree wird die Seite 158 in der Dokumentation angezeigt (DSB1-Workflow),
- ein weiterer Doppelklick auf den Coding-Abschnitt in DSB1 (Ziffer 2) genügt, um historisiert das jeweilige Source Coding mit dem Link zu zeigen,
- ein weiterer Doppelklick auf das Doku-Icon in der verlinkten Codingzeile zeigt das Workflow-Formular im Original an,
- ein weiter Doppelklick auf ein Attachment im Workflow-Formular DSB1 würde ein externes Dokument zeigen (z.B. WORD-Dokument).
|
|
|