dokumentation mit iledocs - rpgnextgen.com€¢ ibm toolbox für java • web services. it-services...
TRANSCRIPT
![Page 1: Dokumentation mit ILEDocs - rpgnextgen.com€¢ IBM Toolbox für Java • Web Services. IT-Services - 4 - Kurzvorstellung Dirk Rossmann GmbH ... In RDi können Snippets benutzt werden](https://reader031.vdocuments.pub/reader031/viewer/2022020214/5b2092527f8b9a066e8b4593/html5/thumbnails/1.jpg)
IT-Services
Dokumentation mit Dokumentation mit ILEDocsILEDocs
Mihael Schmidt
Dirk Rossmann GmbHIT-Services
Anwendungsentwicklung [email protected]
![Page 2: Dokumentation mit ILEDocs - rpgnextgen.com€¢ IBM Toolbox für Java • Web Services. IT-Services - 4 - Kurzvorstellung Dirk Rossmann GmbH ... In RDi können Snippets benutzt werden](https://reader031.vdocuments.pub/reader031/viewer/2022020214/5b2092527f8b9a066e8b4593/html5/thumbnails/2.jpg)
IT-Services
- 2 -
Agenda
• Einführung
• Ausgangssituation
• ILEDocs Features
• Integration in IDE
• Beispiele
• Einbindung in den Entwicklungsprozess
• Open Source
• Wo geht die Reise hin?
![Page 3: Dokumentation mit ILEDocs - rpgnextgen.com€¢ IBM Toolbox für Java • Web Services. IT-Services - 4 - Kurzvorstellung Dirk Rossmann GmbH ... In RDi können Snippets benutzt werden](https://reader031.vdocuments.pub/reader031/viewer/2022020214/5b2092527f8b9a066e8b4593/html5/thumbnails/3.jpg)
IT-Services
- 3 -
Einführung
Mihael Schmidt, seit 2006 Anwendungsentwickler
bei der Dirk Rossmann GmbH
Eingesetzte Technologien
• RPG IV, ILE Konzept, Java 5, XML, …
Bearbeite Projekte
• Kassenschnittstelle
• JSON Implementierung in RPG
• Schnittstelle Java / RPG
• IBM Toolbox für Java
• Web Services
![Page 4: Dokumentation mit ILEDocs - rpgnextgen.com€¢ IBM Toolbox für Java • Web Services. IT-Services - 4 - Kurzvorstellung Dirk Rossmann GmbH ... In RDi können Snippets benutzt werden](https://reader031.vdocuments.pub/reader031/viewer/2022020214/5b2092527f8b9a066e8b4593/html5/thumbnails/4.jpg)
IT-Services
- 4 -
Kurzvorstellung Dirk Rossmann GmbH
• An 3. Stelle der Drogeriekettenin Deutschland
• Gesamtumsatz in 2008 2,9 Mrd. €
• Rossmann gehört zu den Top 30 des dt. Lebensmittelhandels
• 20000 Mitarbeiter, 1500 Filialen in Deutschland
• Sitz Burgwedel bei Hannover
• Logistikstandorte: Landsberg, Burgwedel, Leverkusen, Kiel
• Auslandsgesellschaften in Albanien, Polen, Tschechien, Ungarn mit über 600 Filialen
![Page 5: Dokumentation mit ILEDocs - rpgnextgen.com€¢ IBM Toolbox für Java • Web Services. IT-Services - 4 - Kurzvorstellung Dirk Rossmann GmbH ... In RDi können Snippets benutzt werden](https://reader031.vdocuments.pub/reader031/viewer/2022020214/5b2092527f8b9a066e8b4593/html5/thumbnails/5.jpg)
IT-Services
- 5 -
Ausgangssituation
• Textverarbeitungsprogramme
• Tabellenkalkulationsprogramme
• Bildbearbeitungsprogramme
• Präsentationsprogramme
Wie wurde früher dokumentiert?
![Page 6: Dokumentation mit ILEDocs - rpgnextgen.com€¢ IBM Toolbox für Java • Web Services. IT-Services - 4 - Kurzvorstellung Dirk Rossmann GmbH ... In RDi können Snippets benutzt werden](https://reader031.vdocuments.pub/reader031/viewer/2022020214/5b2092527f8b9a066e8b4593/html5/thumbnails/6.jpg)
IT-Services
- 6 -
Ausgangssituation
• Mehr Aufwand mit der Form der Dokumentation als mit dem Inhalt
• Was ist wichtiger „Inhalt oder Form“
• Wartbarkeit der Dokumentation
• Versionen von Dokumentationen
• Dokumentation pro Umgebung
Immer die selben Problem beim Dokumentieren
Dokumentieren macht keinen Spass!
![Page 7: Dokumentation mit ILEDocs - rpgnextgen.com€¢ IBM Toolbox für Java • Web Services. IT-Services - 4 - Kurzvorstellung Dirk Rossmann GmbH ... In RDi können Snippets benutzt werden](https://reader031.vdocuments.pub/reader031/viewer/2022020214/5b2092527f8b9a066e8b4593/html5/thumbnails/7.jpg)
IT-Services
- 7 -
Ausgangssituation
• Dokumentation in Word / Excel / Powerpoint / Visio
• Verstreut auf Servern und Verzeichnissen
• Mehrfache Versionen einer Dokumentation
• Keine Verbindung zwischen Dokumentation und Quelltext / Programm
• Keine Abgrenzung zwischen technischer und allgemeiner Dokumentation
RPG Dokumentation bei Rossmann
![Page 8: Dokumentation mit ILEDocs - rpgnextgen.com€¢ IBM Toolbox für Java • Web Services. IT-Services - 4 - Kurzvorstellung Dirk Rossmann GmbH ... In RDi können Snippets benutzt werden](https://reader031.vdocuments.pub/reader031/viewer/2022020214/5b2092527f8b9a066e8b4593/html5/thumbnails/8.jpg)
IT-Services
- 8 -
Ausgangssituation
• Steigende Anzahl an exportierten Prozeduren
• Kein Überblick über vorhandene Prozeduren→ doppelte Implementierungen
• Keine Dokumentation, wo diese Prozeduren sind
• Keine Dokumentation, wie diese Prozeduren aufgerufen werden: Parameter, Rückgabewerte, …
Dokumentation von Serviceprogrammen
![Page 9: Dokumentation mit ILEDocs - rpgnextgen.com€¢ IBM Toolbox für Java • Web Services. IT-Services - 4 - Kurzvorstellung Dirk Rossmann GmbH ... In RDi können Snippets benutzt werden](https://reader031.vdocuments.pub/reader031/viewer/2022020214/5b2092527f8b9a066e8b4593/html5/thumbnails/9.jpg)
IT-Services
- 9 -
ILEDocs
• Was wird dokumentiert ?
• Wann wird dokumentiert?
• Wo wird dokumentiert?
• Wie wird dokumentiert?
• Wo ist das Ergebnis?
Projektziel
( Inhalt )
( Zeitpunkt )
( Quelltext )
( Form )
( Dokument )
![Page 10: Dokumentation mit ILEDocs - rpgnextgen.com€¢ IBM Toolbox für Java • Web Services. IT-Services - 4 - Kurzvorstellung Dirk Rossmann GmbH ... In RDi können Snippets benutzt werden](https://reader031.vdocuments.pub/reader031/viewer/2022020214/5b2092527f8b9a066e8b4593/html5/thumbnails/10.jpg)
IT-Services
- 10 -
ILEDocs
• Dokumentationstool
• Vergleichbar mit Javadoc und Doxygen
• Liest speziell gekennzeichnete Kommentare aus
• Unterstützt zur Zeit die Sprachen RPG und CL
• Ausgabe in eine Datenbank
• Web Frontend
Was ist ILEDocs?
![Page 11: Dokumentation mit ILEDocs - rpgnextgen.com€¢ IBM Toolbox für Java • Web Services. IT-Services - 4 - Kurzvorstellung Dirk Rossmann GmbH ... In RDi können Snippets benutzt werden](https://reader031.vdocuments.pub/reader031/viewer/2022020214/5b2092527f8b9a066e8b4593/html5/thumbnails/11.jpg)
IT-Services
- 11 -
ILEDocs
![Page 12: Dokumentation mit ILEDocs - rpgnextgen.com€¢ IBM Toolbox für Java • Web Services. IT-Services - 4 - Kurzvorstellung Dirk Rossmann GmbH ... In RDi können Snippets benutzt werden](https://reader031.vdocuments.pub/reader031/viewer/2022020214/5b2092527f8b9a066e8b4593/html5/thumbnails/12.jpg)
IT-Services
- 12 -
ILEDocs
![Page 13: Dokumentation mit ILEDocs - rpgnextgen.com€¢ IBM Toolbox für Java • Web Services. IT-Services - 4 - Kurzvorstellung Dirk Rossmann GmbH ... In RDi können Snippets benutzt werden](https://reader031.vdocuments.pub/reader031/viewer/2022020214/5b2092527f8b9a066e8b4593/html5/thumbnails/13.jpg)
IT-Services
- 13 -
ILEDocs Features
• \brief Kurzbeschreibung
• \author
• \date
• \link Link auf externe Webseite
• \info
• \warning
• \todo
• \deprecated
• \rev Programmänderungen (wer, wann, was)
• \config Konfigurationzugriffsdaten
ILEDocs Tags
![Page 14: Dokumentation mit ILEDocs - rpgnextgen.com€¢ IBM Toolbox für Java • Web Services. IT-Services - 4 - Kurzvorstellung Dirk Rossmann GmbH ... In RDi können Snippets benutzt werden](https://reader031.vdocuments.pub/reader031/viewer/2022020214/5b2092527f8b9a066e8b4593/html5/thumbnails/14.jpg)
IT-Services
- 14 -
ILEDocs Features
• \param Parameterbeschreibung (Inhalt)
• \return Rückgabewert
• Auslesen der Prozedurschnittstellendefinition (PI)
• Automatisches Kennzeichnen von exportierten Prozeduren
Prozedursignatur
![Page 15: Dokumentation mit ILEDocs - rpgnextgen.com€¢ IBM Toolbox für Java • Web Services. IT-Services - 4 - Kurzvorstellung Dirk Rossmann GmbH ... In RDi können Snippets benutzt werden](https://reader031.vdocuments.pub/reader031/viewer/2022020214/5b2092527f8b9a066e8b4593/html5/thumbnails/15.jpg)
IT-Services
- 15 -
ILEDocs Features
\critical Definiert ein Programm oder eine Prozedurals kritisch.
Weitere Funktionen
![Page 16: Dokumentation mit ILEDocs - rpgnextgen.com€¢ IBM Toolbox für Java • Web Services. IT-Services - 4 - Kurzvorstellung Dirk Rossmann GmbH ... In RDi können Snippets benutzt werden](https://reader031.vdocuments.pub/reader031/viewer/2022020214/5b2092527f8b9a066e8b4593/html5/thumbnails/16.jpg)
IT-Services
- 16 -
Beispiele
![Page 17: Dokumentation mit ILEDocs - rpgnextgen.com€¢ IBM Toolbox für Java • Web Services. IT-Services - 4 - Kurzvorstellung Dirk Rossmann GmbH ... In RDi können Snippets benutzt werden](https://reader031.vdocuments.pub/reader031/viewer/2022020214/5b2092527f8b9a066e8b4593/html5/thumbnails/17.jpg)
IT-Services
- 17 -
Beispiele
![Page 18: Dokumentation mit ILEDocs - rpgnextgen.com€¢ IBM Toolbox für Java • Web Services. IT-Services - 4 - Kurzvorstellung Dirk Rossmann GmbH ... In RDi können Snippets benutzt werden](https://reader031.vdocuments.pub/reader031/viewer/2022020214/5b2092527f8b9a066e8b4593/html5/thumbnails/18.jpg)
IT-Services
- 18 -
Beispiele
![Page 19: Dokumentation mit ILEDocs - rpgnextgen.com€¢ IBM Toolbox für Java • Web Services. IT-Services - 4 - Kurzvorstellung Dirk Rossmann GmbH ... In RDi können Snippets benutzt werden](https://reader031.vdocuments.pub/reader031/viewer/2022020214/5b2092527f8b9a066e8b4593/html5/thumbnails/19.jpg)
IT-Services
- 19 -
Beispiele
![Page 20: Dokumentation mit ILEDocs - rpgnextgen.com€¢ IBM Toolbox für Java • Web Services. IT-Services - 4 - Kurzvorstellung Dirk Rossmann GmbH ... In RDi können Snippets benutzt werden](https://reader031.vdocuments.pub/reader031/viewer/2022020214/5b2092527f8b9a066e8b4593/html5/thumbnails/20.jpg)
IT-Services
- 20 -
Integration in IDE
In RDi können Snippets benutzt werden für das Einfügen
von ILEDocs Kommentarblöcken.
Es gibt keine ILEDocs spezifische Unterstützung in der IDE.
Rational Developer for i
![Page 21: Dokumentation mit ILEDocs - rpgnextgen.com€¢ IBM Toolbox für Java • Web Services. IT-Services - 4 - Kurzvorstellung Dirk Rossmann GmbH ... In RDi können Snippets benutzt werden](https://reader031.vdocuments.pub/reader031/viewer/2022020214/5b2092527f8b9a066e8b4593/html5/thumbnails/21.jpg)
IT-Services
- 21 -
Integration in IDE
![Page 22: Dokumentation mit ILEDocs - rpgnextgen.com€¢ IBM Toolbox für Java • Web Services. IT-Services - 4 - Kurzvorstellung Dirk Rossmann GmbH ... In RDi können Snippets benutzt werden](https://reader031.vdocuments.pub/reader031/viewer/2022020214/5b2092527f8b9a066e8b4593/html5/thumbnails/22.jpg)
IT-Services
- 22 -
Integration in IDE
![Page 23: Dokumentation mit ILEDocs - rpgnextgen.com€¢ IBM Toolbox für Java • Web Services. IT-Services - 4 - Kurzvorstellung Dirk Rossmann GmbH ... In RDi können Snippets benutzt werden](https://reader031.vdocuments.pub/reader031/viewer/2022020214/5b2092527f8b9a066e8b4593/html5/thumbnails/23.jpg)
IT-Services
- 23 -
Integration in IDE
• ILEDocs Kommentarblöcke als Templates
• Zukünftige Unterstützung von Prozeduren, Modulen und dessen Prototypen
RPG Next Gen Editor
![Page 24: Dokumentation mit ILEDocs - rpgnextgen.com€¢ IBM Toolbox für Java • Web Services. IT-Services - 4 - Kurzvorstellung Dirk Rossmann GmbH ... In RDi können Snippets benutzt werden](https://reader031.vdocuments.pub/reader031/viewer/2022020214/5b2092527f8b9a066e8b4593/html5/thumbnails/24.jpg)
IT-Services
- 24 -
Integration in IDE
![Page 25: Dokumentation mit ILEDocs - rpgnextgen.com€¢ IBM Toolbox für Java • Web Services. IT-Services - 4 - Kurzvorstellung Dirk Rossmann GmbH ... In RDi können Snippets benutzt werden](https://reader031.vdocuments.pub/reader031/viewer/2022020214/5b2092527f8b9a066e8b4593/html5/thumbnails/25.jpg)
IT-Services
- 25 -
Integration in IDE
![Page 26: Dokumentation mit ILEDocs - rpgnextgen.com€¢ IBM Toolbox für Java • Web Services. IT-Services - 4 - Kurzvorstellung Dirk Rossmann GmbH ... In RDi können Snippets benutzt werden](https://reader031.vdocuments.pub/reader031/viewer/2022020214/5b2092527f8b9a066e8b4593/html5/thumbnails/26.jpg)
IT-Services
- 26 -
Einbindung in den Entwicklungsprozess
![Page 27: Dokumentation mit ILEDocs - rpgnextgen.com€¢ IBM Toolbox für Java • Web Services. IT-Services - 4 - Kurzvorstellung Dirk Rossmann GmbH ... In RDi können Snippets benutzt werden](https://reader031.vdocuments.pub/reader031/viewer/2022020214/5b2092527f8b9a066e8b4593/html5/thumbnails/27.jpg)
IT-Services
- 27 -
Open Source
• Viele gute Erfahrungen mit Open Source Produkten gesammelt
• Einsatz von verschiedenen Open Source Produkten in Projekten
• Zurückgeben an die Open Source Community
Wieso Open Source?
![Page 28: Dokumentation mit ILEDocs - rpgnextgen.com€¢ IBM Toolbox für Java • Web Services. IT-Services - 4 - Kurzvorstellung Dirk Rossmann GmbH ... In RDi können Snippets benutzt werden](https://reader031.vdocuments.pub/reader031/viewer/2022020214/5b2092527f8b9a066e8b4593/html5/thumbnails/28.jpg)
IT-Services
- 28 -
Wo geht die Reise hin?
• Vervollständigung der RPG Spezifikation
• like / likeds Keywords
• PEP : *ENTRY PLIST / Prototyp
• ILEDocs Kommentarblock für Unterroutinen
Geplante Features
Neue Tags
• \see Verlinkung auf andere ILEDocs Dokumentationen
• \throws Mögliche Abbruchnachrichten
![Page 29: Dokumentation mit ILEDocs - rpgnextgen.com€¢ IBM Toolbox für Java • Web Services. IT-Services - 4 - Kurzvorstellung Dirk Rossmann GmbH ... In RDi können Snippets benutzt werden](https://reader031.vdocuments.pub/reader031/viewer/2022020214/5b2092527f8b9a066e8b4593/html5/thumbnails/29.jpg)
IT-Services
- 29 -
Wo geht die Reise hin?
• HTML dynamisch (eingebunden in IDE)
• HTML statisch
• XML (Docbook)
• HTML statisch
• RTF
• Wiki mit XMLRPC Support
• XWiki
• DokuWiki
• JSPWiki
• Confluence
Weitere Ausgabeformate
![Page 30: Dokumentation mit ILEDocs - rpgnextgen.com€¢ IBM Toolbox für Java • Web Services. IT-Services - 4 - Kurzvorstellung Dirk Rossmann GmbH ... In RDi können Snippets benutzt werden](https://reader031.vdocuments.pub/reader031/viewer/2022020214/5b2092527f8b9a066e8b4593/html5/thumbnails/30.jpg)
IT-Services
- 30 -
Wo geht die Reise hin?
Hosted by Sourceforge.net
• Dynamische HTML Seiten mit DB Backend
• Statische HTML Seiten
• Kandidaten für die zentrale Bibliothek
• HTTPAPI, FTPAPI von Scott Klement
• Basics, LOG4RPG von Thomas Raddatz
• Vector von Dieter Bender
• Linked List von Mihael Schmidt
• …
Aufbau einer Dokumentationsbibliothek
![Page 31: Dokumentation mit ILEDocs - rpgnextgen.com€¢ IBM Toolbox für Java • Web Services. IT-Services - 4 - Kurzvorstellung Dirk Rossmann GmbH ... In RDi können Snippets benutzt werden](https://reader031.vdocuments.pub/reader031/viewer/2022020214/5b2092527f8b9a066e8b4593/html5/thumbnails/31.jpg)
IT-Services
- 31 -
Wo geht die Reise hin?
Zentrale Dokumentationsbibliothek online
![Page 32: Dokumentation mit ILEDocs - rpgnextgen.com€¢ IBM Toolbox für Java • Web Services. IT-Services - 4 - Kurzvorstellung Dirk Rossmann GmbH ... In RDi können Snippets benutzt werden](https://reader031.vdocuments.pub/reader031/viewer/2022020214/5b2092527f8b9a066e8b4593/html5/thumbnails/32.jpg)
IT-Services
- 32 -
Vielen Dank für Ihre Aufmerksamkeit !
http://iledocs.sourceforge.net
http://www.rpgnextgen.com
All brand names, product names, or trademarksbelong to their respective holders.