Situation
Bereitstellung von war ein vierjähriges europäisches FP7-Programm mit dem Ziel, durch den Einsatz formaler Engineering-Methoden wesentliche Fortschritte in den Engineering-Methoden für zuverlässige Systeme zu erzielen. Die Fortentwicklung und Verbesserung der professionellen Entwicklungsumgebung, die auf der Eclipse-basierten Rodin-Umgebung aufbaut, sowie die Ermöglichung der Nutzung der Plattform durch industrielle Anwender waren zentrale Ziele.
Herausforderung
Während Rodin bereits ausgereifte Software war, als Bereitstellung von begann im Jahr 2008, war seine Dokumentation noch unzureichend. Sie bestand aus einem Wiki mit redundanten und veralteten Informationen, wobei mehrere Teile der Software gar nicht dokumentiert waren. Weiterhin existierten weitere Inhalte in Form von verlinkten PDFs, die nicht vom Suchmechanismus des Wikis abgedeckt wurden.
Die Bereitstellung von Das Projektmanagement schaffte es nicht, Personal für die Verbesserung der Dokumentation zu rekrutieren: Weder die akademischen noch die industriellen Partner waren bereit, Ressourcen für diese Aufgabe bereitzustellen, die, obwohl wichtig, als alltäglich und weniger spannend als die Arbeit an neuen Technologien empfunden wurde.
Lösung
Formal Mind hat sich freiwillig gemeldet, diese Aufgabe zu übernehmen. Bevor sie auch nur einen Satz schrieben, machten sie eine Problem analyse (ein offensichtlicher erster Schritt, da sie Experten für Anforderungen sind). Von Anfang an wurde die Rodin-Community eingeladen und ermutigt, Feedback zu geben. Diese Problemanalyse führte zu einer Lösung, die aus einem zentralen Dokumentationsrepository und einem Build-Prozess bestand, der drei verschiedene Arten von Dokumentation generierte: PDF, HTML und Eclipse Help.
Die eigentliche Schreibarbeit erfolgte in vier Iterationen, die jeweils etwa acht Wochen dauerten. Auch dies ermöglichte es der Rodin-Community, Feedback zu geben und Formal Mind, die Ziele der kommenden Iterationen entsprechend anzupassen. Aber um sicherzugehen, führte Formal Mind während der dritten Iteration einen Test durch. Dieser Test erforderte, dass die Benutzer mithilfe des Handbuchs eine formale Spezifikation in Event-B erstellten, obwohl sie weder Event-B kannten noch Rodin zuvor benutzt hatten. Die Ergebnisse dieses Tests führten zu Anpassungen in der letzten Iteration.
Ergebnisse
Formal Mind lieferte ein Handbuch mit 178 Seiten in PDF-Version, mit dem die Stakeholder sehr zufrieden waren. Während einige Inhalte aus dem Wiki übernommen (und anschließend zur Vermeidung von Redundanz entfernt) wurden, wurde der Großteil neu erstellt.
Im Rahmen des Projekts sammelte und verarbeitete Formal Mind 124 Rückmeldungen von Stakeholdern. Sie richteten zudem ein kontinuierliches Build-System ein, das an der Universität Düsseldorf gehostet wird und das Handbuch in seinen verschiedenen Formaten automatisch neu erstellt, sobald neuer Inhalt in das Dokumentationsrepository eingecheckt wird.
Nicht nur waren die Stakeholder mit dem Ergebnis hochgradig zufrieden, auch erlaubt das entstandene System, dass es von jedem Committer mit etwas Latex-Kenntnissen gewartet werden kann, da es gut dokumentiert und automatisiert ist.
