Documentation-driven Development (DDD)

Größe: px

Ab Seite anzeigen:

Download "Documentation-driven Development (DDD)"

Joachim Wolf
vor 10 Jahren
Abrufe

1 Documentation-driven Development (DDD) oder Wie aus Dokumentation Software wird 1

2 Agenda Vorstellung GDV DL und parson communication Warum documentation-driven development (DDD) Technische Umsetzung Die Lehren 2

3 Agenda Vorstellung GDV DL und parson communication Warum documentation-driven development (DDD) Technische Umsetzung Die Lehren 3

4 Die GDV DL Schadenregulierung Notruf Abschleppzentrale Mobiler Notruf Elektronische Versicherungsbestätigung 4

5 Die GDV DL Elektronische Versicherungsbestätigung (evb) Zulassungsbehörden sind gesetzlich verpflichtet, den Versicherungsschutz zugelassener Fahrzeuge sicherzustellen Versicherungsbestätigung bei Zulassung, Ummeldung oder Abmeldung von Fahrzeugen Elektronische Kommunikation zwischen Versicherern und Zulassungsbehörden Nachrichten zwischen Kommunikationspartnern werden in XML ausgetauscht Dokumentation des Verfahrens in FrameMaker/XML 5

oder Abmeldung von Fahrzeugen Elektronische Kommunikation zwischen Versicherern und Zulassungsbehörden

6 parson communication Technische Dokumentation Projektmanagement Schulungen Usability Technologie 6

7 Agenda Vorstellung GDV DL und parson communication Warum documentation-driven development (DDD) Technische Umsetzung Die Lehren 7

8 Warum DDD? Änderung des evb-verfahrens Haftpflichtversicherer Versicherungsmakler Zulassungsbehörden Kraftfahrt-Bundesamt Kundenbetreuung GDV DL Veröffentlichung des Verfahrenshandbuchs 4 Monate VOR Release der neuen Software-Version 8

9 Warum DDD? Aus dem Handbuch Bedingungen für Nachrichten XML-Aufbau der Nachrichten Definition der Wertebereiche für Nachrichtenfelder Software machen Fehlermeldungen im Web- Portal anzeigen Automatisch erzeugtes Schema Automatische Prüfung der Werte, die Benutzer im Web-Portal eingeben Und plötzlich entdeckt man viel, viel mehr! 9

der Wertebereiche für Nachrichtenfelder Software machen Fehlermeldungen im Web-

10 Agenda Vorstellung GDV DL und parson communication Warum documentation-driven development (DDD) Technische Umsetzung Die Lehren 10

11 Technische Umsetzung Eckdaten der FrameMaker-Lösung FrameMaker 9 DITA-basiert mit hoher Spezialisierung PDF- und HTML-Ausgabe Variantenmanagement Änderungsversionen mit XML-Dokumentenvergleich 11

12 Technische Umsetzung Wie wird Dokumentation nutzbar für Softwareentwicklung? XSLT-Skripte extrahieren Daten aus Handbuch SQL-Skripte importieren extrahierte Daten (XML) in Datenbanken Entwicklung Test Betrieb 12

13 Technische Umsetzung Wie wird Dokumentation nutzbar für Softwareentwicklung? Extraktion von Daten ermöglicht durch: 1. Semantische Elemente 2. Auswertung von Attributen 3. Generisches Extraktionskonzept 4. Verfolgung von Querverweisen 13

14 Technische Umsetzung Wie wird Dokumentation nutzbar für Softwareentwicklung? Extraktion von Daten ermöglicht durch: 1. Semantische Elemente 2. Auswertung von Attributen 3. Generisches Extraktionskonzept 4. Verfolgung von Querverweisen 14

15 Technische Umsetzung (1+2) (1+2) Semantische Elemente und Attribute: Druckversion des Handbuchs 15

16 Technische Umsetzung (1+2) (1+2) Semantische Elemente und Attribute: FrameMaker XML-Element erzeugt Autotext in FrameMaker passend zum Datentyp Attribute bestimmen Werte im Autotext Weitere Elemente für Enumerationen, Ziffernfolgen, reguläre Ausdrücke u.a. 16

passend zum Datentyp Attribute bestimmen Werte im Autotext

17 Technische Umsetzung (1+2) (1+2) Semantische Elemente und Attribute: Nach der Extraktion 17

18 Technische Umsetzung (1+2) (1+2) Semantische Elemente und Attribute: Automatisch erzeugter Quellcode 18

19 Technische Umsetzung (1+2) (1+2) Semantische Elemente und Attribute: Automatisch erzeugte Testfall-Vorlage 19

20 Technische Umsetzung (1+2) (1+2) Semantische Elemente und Attribute: Hilfetexte für Benutzeroberfläche (Portal) 20

21 Technische Umsetzung Wie wird Dokumentation nutzbar für Entwicklung? Extraktion von Daten ermöglicht durch: 1. Semantische Elemente 2. Auswertung von Attributen 3. Generisches Extraktionskonzept 4. Verfolgung von Querverweisen 21

22 Technische Umsetzung (3+4) (3+4) Generische Extraktion + Querverweise: Druckversion des Handbuchs 22

23 Technische Umsetzung (3+4) (3+4) Generische Extraktion + Querverweise: FrameMaker Attribut löst Extraktion der Tabelle aus Extraktionsskripte verarbeiten Inhalt der Tabelle und verfolgen Querverweise 23

24 Technische Umsetzung (3+4) (3+4) Generische Extraktion + Querverweise: Nach der Extraktion 24

25 Technische Umsetzung (3+4) (3+4) Generische Extraktion + Querverweise: Automatisch erzeugter Quellcode 1/2 25

26 Technische Umsetzung (3+4) (3+4) Generische Extraktion + Querverweise: Automatisch erzeugter Quellcode 2/2 26

27 Technische Umsetzung (3+4) (3+4) Generische Extraktion + Querverweise: Automatisch erzeugte Testfall-Vorlage 27

28 Technische Umsetzung Wachsendes Konzept - Gesamtübersicht 28

29 Agenda Vorstellung GDV DL und parson communication Warum documentation-driven development (DDD) Technische Umsetzung Die Lehren 29

30 Vorteile durch DDD Mehr Konsistenz Die Lehren Weniger manueller Aufwand Schnellere Einarbeitung Gute Führung der Architekten beim Schreiben Feedback fließt direkt in Dokumentation ein Genauere Dokumentation durch mehrfachen Review Interne Hinweise (Inhouse-Variante) = Zusatznutzen für Entwicklung 30

31 Die Lehren Erkenntnisse aus DDD-Weiterentwicklung In kleinen Iterationen arbeiten synchrone Abhängigkeit vermeiden Rille statt Zäune Redaktionsleitfaden pflegen 31

32 Die Lehren Was bedeutet DDD für Technische Redakteure Hilfetexte und Fehlermeldung in Verantwortung der Redakteure Keine doppelte Pflege für Software und Dokumentation Direkter Einfluss auf Entwicklung = direktes Korrekturlesen 32

33 Fragen? 33

Ähnliche Dokumente

OP-LOG www.op-log.de

Verwendung von Microsoft SQL Server, Seite 1/18 OP-LOG www.op-log.de Anleitung: Verwendung von Microsoft SQL Server 2005 Stand Mai 2010 1 Ich-lese-keine-Anleitungen 'Verwendung von Microsoft SQL Server