Automatische Erstellung von Dokumentationen

[web2perform]

Liebe Sage Developer Partner / Sage-Fachhandelspartner,

wir denken bei web2perform darüber nach ein Tool zu entwickeln, das aus einer hochgeladenen AppDesigner-Lösung automatisch Dokumentationen generiert. Natürlich mit der Einhaltung der DSGVO etc.; erstmal möchte ich prüfen, ob dafür überhaupt ein Nachfragepotenzial besteht.

Der Aufwand manuell eine Dokumentation zu erstellen nimmt oft bis zu 50 % des Entwicklungsaufwands ein und ist somit teuer, häufig wird deshalb auf eine hilfreiche Dokumentation verzichtet. Mit unserem Tool könnten wir einen Fixpreis je automatisch erstellter Dokumentation anbieten, um die Kosten dafür erheblich zu senken.

Gäbe es dafür ein grundlegendes Interesse? Lasst uns gerne darüber diskutieren, vielleicht ergeben sich dabei auch andere Pain Points, die wir lösen können. Unser Ziel ist es, (neue) Standards auf dem Sage-Markt zu etablieren und die Qualität der Erweiterungen zu erhöhen, um sowohl den Fachhändlern, als auch den Endkunden, mehr Wert bieten zu können.

Viele Grüße
Marcel von web2perform

 

[R.Ziemer]

Moin,

grundsätzlich sehe ich hier auch Bedarf. Das ist eins der Dinge, die man als sinnvoll ansieht, aber hier zeitlich bedingt nicht die Prioritäten setzen kann, um sich damit im Detail auseinander zusetzen. Soweit wie es zum Beispiel Doxygen im Bereich DLLs treibt, benötige ich es im AppDesigner aber nicht.

Ich hatte einen Ansatz verfolgt, sämtlich Makroanpassungen und Ereignisse über die Kommentarspalte des Makros zu dokumentieren und hieraus automatisch eine Doku aller in der Lösungen enthaltenen Makros zu erzeugen. Ist aber noch nicht fertig und ausgereift.

Das Inhaltsverzeichnis des AppDesigners hilft hier schon sehr. Das einzige was hier fehlt, ist die Übernahme der Kommentar-Spalte der Elemente. Für den API-Bereich reicht mir der Standard über die Postman-Collection und Swagger .

Wofür verwende ich die meiste Zeit:
Sobald es darum geht es einem Anwender an den Fachbereich angepasst zu erklären sowie Business Prozesse visuell mit Screenshots zu dokumentieren, habe ich bis jetzt keinen guten Ansatz gehabt dies sinnvoll zu schematisieren. Im Moment ist es einfacher ein Handbuch während dem Testing parallel zu erstellen.
So prüft man die Anpassung auch nochmal besonders auf fachliche Korrektheit. Manchmal fallen dabei sogar noch kleine Ungenauigkeiten auf, sobald man das Umgesetzte ausformuliert.

 

[web2perform]

Hallo Rouven,

danke für deinen wertvollen Input und deine Meinung. Dass grundsätzlich Bedarf an der Automatisierung der Dokumentationen besteht, freut mich schon mal zu hören.

Deine Vorgehensweise jedes Makro zu kommentieren halte ich für sinnvoll. Sehe ich es richtig, dass dir der Export der Kommentare in das Inhaltsverzeichnis bereits reichen würde? Einen entsprechenden Beitrag in der Sage Customer Voice würde ich auf jeden Fall unterstützen.
Du sprichst aber nur von Makros, oder kommentierst du auch andere Elemente wie ein Daten-Edit-Element?

Meine Idee war die Erzeugung einer Word-Datei auf Grundlage einer Vorlage, damit daraus eine "vorzeigbare" Dokumentation generiert werden kann. Ich denke aus den Infos einer AppDesigner-Lösung lassen sich zumindest die technische Dokumentation und die Installationsanleitung erstellen. Damit können Einstiegspunkte in DLL-Dateien, Regiezentrumeinträge und viele andere Anpassungen beschrieben werden.

Die Erstellung eines Benutzerhandbuches ist natürlich aufwändiger, ließe sich aber sicher mit KI vereinfachen - was denkst du / denkt ihr?

 

[R.Ziemer]

Deine Vorgehensweise jedes Makro zu kommentieren halte ich für sinnvoll. Sehe ich es richtig, dass dir der Export der Kommentare in das Inhaltsverzeichnis bereits reichen würde? Einen entsprechenden Beitrag in der Sage Customer Voice würde ich auf jeden Fall unterstützen.
Du sprichst aber nur von Makros, oder kommentierst du auch andere Elemente wie ein Daten-Edit-Element?

Genau-- ich meine die Integration der Kommentare (also JA) aus dem Eigenschaftsbereich der einzelnen Elemente in das Inhaltsverzeichnis und ein separater Export (nach Elementen strukturiert) aller Kommentarzeilen aus den Makros, sodass man über das Inhaltsverzeichnis einen strukturellen Überblick hat, aber man auch schnell eine Übersicht hat zu welchen Elementen Makros hinterlegt sind und welche Business Logik hier genau erfolgt.

Wie schon angedeutet, hatte ich mit so einem separaten Export aus den Metadaten für Makros schonmal angefangen, aber dies noch nicht fertig gestellt. Habe dies allerdings mit HTML, CSS und JS umgesetzt, sodass man immer auf eine aktuelle Doku zugreifen kann, welche sich dynamisch anhand der Metadaten rendert.

Meine Idee war die Erzeugung einer Word-Datei auf Grundlage einer Vorlage, damit daraus eine "vorzeigbare" Dokumentation generiert werden kann. Ich denke aus den Infos einer AppDesigner-Lösung lassen sich zumindest die technische Dokumentation und die Installationsanleitung erstellen. Damit können Einstiegspunkte in DLL-Dateien, Regiezentrumeinträge und viele andere Anpassungen beschrieben werden.

Mir reicht hier denke ich das Inhaltsverzeichnis. Automatisierungsbedarf ist bei mir eher bei der Dokumentation der Businesslogik der Anpassung ...

Die Erstellung eines Benutzerhandbuches ist natürlich aufwändiger, ließe sich aber sicher mit KI vereinfachen - was denkst du / denkt ihr?

Da kommt die DSGVO wieder ins Spiel... sehe ich im Moment noch schwierig, solange es hier keine allgemeinen Richtlinien zum Umgang gibt. Wäre aber sicherlich mal ein spannendes Projekt, um sich mit dem Thema näher auseinander zu setzen.