Dokumentation mit ILEDocs - rpgnextgen.com€¢ IBM Toolbox für Java • Web Services. IT-Services...

IT-Services

Dokumentation mit Dokumentation mit ILEDocsILEDocs

Mihael Schmidt

Dirk Rossmann GmbHIT-Services

Anwendungsentwicklung RPGMihael.Schmidt@rossmann.de

IT-Services

- 2 -

Agenda

• Einführung

• Ausgangssituation

• ILEDocs Features

• Integration in IDE

• Beispiele

• Einbindung in den Entwicklungsprozess

• Open Source

• Wo geht die Reise hin?

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

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

IT-Services

- 5 -

Ausgangssituation

• Textverarbeitungsprogramme

• Tabellenkalkulationsprogramme

• Bildbearbeitungsprogramme

• Präsentationsprogramme

Wie wurde früher dokumentiert?

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!

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

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

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 )

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?

IT-Services

- 11 -

ILEDocs

IT-Services

- 12 -

ILEDocs

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

IT-Services

- 14 -

ILEDocs Features

• \param Parameterbeschreibung (Inhalt)

• \return Rückgabewert

• Auslesen der Prozedurschnittstellendefinition (PI)

• Automatisches Kennzeichnen von exportierten Prozeduren

Prozedursignatur

IT-Services

- 15 -

ILEDocs Features

\critical Definiert ein Programm oder eine Prozedurals kritisch.

Weitere Funktionen

IT-Services

- 16 -

Beispiele

IT-Services

- 17 -

Beispiele

IT-Services

- 18 -

Beispiele

IT-Services

- 19 -

Beispiele

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

IT-Services

- 21 -

Integration in IDE

IT-Services

- 22 -

Integration in IDE

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

IT-Services

- 24 -

Integration in IDE

IT-Services

- 25 -

Integration in IDE

IT-Services

- 26 -

Einbindung in den Entwicklungsprozess

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?

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

IT-Services

- 29 -

Wo geht die Reise hin?

• HTML dynamisch (eingebunden in IDE)

• HTML statisch

• XML (Docbook)

• HTML statisch

• PDF

• RTF

• Wiki mit XMLRPC Support

• XWiki

• DokuWiki

• JSPWiki

• Confluence

Weitere Ausgabeformate

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

IT-Services

- 31 -

Wo geht die Reise hin?

Zentrale Dokumentationsbibliothek online

IT-Services

- 32 -

Vielen Dank für Ihre Aufmerksamkeit !

Mihael.Schmidt@rossmann.de

http://iledocs.sourceforge.net

http://www.rpgnextgen.com

All brand names, product names, or trademarksbelong to their respective holders.