CT-Assist - Screenshot: Die IT-Rules für den IT-Workflow DNR1

SAP® Add-Ons > CT-Assist 7.1

Zurück

Screenshot: Das Ergebnis einer Doku-Checkliste ...

Ganz allgemein gilt: "... jeder versteht unter Dokumentation etwas anderes", hinzu kommen weiter
Einflußfaktoren (Zeitaufwand, Kostenschätzung, Termindruck usw.). Damit ein bestimmtes
Dokumentationsniveau über den gesamten Programmpool erreicht wird, ist auf der Ebene von
Befehlen/Befehlskonstrukten eine allgemeingültige Checklisten-Prüfung des Coding sinnvoll.

Sie können im CT-Assist zu jederzeit während Ihrer aktuellen Programmentwicklung direkt aus
dem Coding eine maschinelle Checklisten-Prüfung durchführen lassen. Die ermittelten dokumentations-
relevanten Codingstellen sind entsprechend dem Dokumentations-Level zu bearbeiten.

Der Dokumentations-Level richtet sich nach der Komplexität der verwendeten Befehlskonstruktion
und wird innerhalb der Dokumentations-Checkliste festgelegt.

Wenn Sie in Ihrem aktuellen Coding z.B. in einem FORM eine einfachere, alternative Befehlskonstruktion
verwenden, können Sie hierdurch den zusätzlichen Dokumentationsaufwand vermeiden
( "... keep it simple, but not too simple ...").

Der nachfolgende Screen-Shot zeigt Ihnen als Beispiel ein Ergebnis aus einer maschinellen Checklisten-Prüfung
als Pop-Up Liste:

Aus der Pop-Up Liste sind folgende Informationen ersichtlich:

Programmelement
Hier wird das geprüfte Programmelement und der jeweilige Name angezeigt. Der Screen-Shot zeigt das
Programmelement 'FORM' mit dem Namen 'TEST'. Die für das Programmelement FORM zugeordnete
Template-Checkliste ist Grundlage für die Codeprüfung von FORM TEST.
Zu dokumentierende Bereiche
Anzahl der ermittelten zu dokumentierenden Bereiche im FORM TEST
Zeilennummer in der Pop-Up Liste (No.)
Check
Ein Haken in dieser Check-Box veranlasst die Generierung des auf die Codingstelle abgestimmen Doku-Formulars.
In der Template-Checkliste kann vorgegeben werden, in welchen Fällen eine Formular-Generierung erwartet wird.
Diese Default-Angabe kann in der Pop-Up Liste überschrieben werden.
Level
Die gefundenen dokurelevanten Codingstellen sind im Check-Template in 3 Kategorieen eingeteilt:
grünes Icon = Hinweis auf eine erforderliche zusätzliche Information.
gelbes Icon = Hier wird vorgeschlagen, dass die entsprechende Codingstelle dokumentiert werden sollte.
rotes Icon = Das jeweilige Coding ist an dieser Stelle zu dokumentieren, die generierten Fragen dazu
sind zu beantworten.
Line
Die jeweilige Zeilennummer im Source Code ist hier wiedergegeben. Durch Doppelklick auf diese Pop-Up Zeile
wird auf die jeweilige Stelle im Coding positioniert (aktuelle Edit-Karteikarte). Hier können Sie sich umfassend
über die dokumentationsrelevante Codingstelle informieren.
Description
Warum eine Dokumentierung der betreffenden Codingstelle als erforderlich klassifiziert wurde,
ist als Kurzkommentar im Check-Template hinterlegt.