{"id":1018,"date":"2015-01-01T08:00:00","date_gmt":"2015-01-01T07:00:00","guid":{"rendered":"https:\/\/www.formalmind.com\/uncategorised\/production-rodin-handbook\/"},"modified":"2022-04-22T13:06:25","modified_gmt":"2022-04-22T11:06:25","slug":"production-rodin-handbook","status":"publish","type":"post","link":"https:\/\/www.formalmind.com\/de\/success-story\/production-rodin-handbook\/","title":{"rendered":"Erstellung des Rodin-Handbuchs"},"content":{"rendered":"
\n
\n
Rodin Handbuch online aufrufen<\/a><\/div>\n\n\n\n
Hardcover bei Amazon kaufen<\/a><\/div>\n<\/div>\n\n\n\n
\n
<\/div>\n\n\n\n
\n

Situation<\/h3>\n\n\n\n

Bereitstellung von<\/a> war ein vierj\u00e4hriges europ\u00e4isches FP7-Programm mit dem Ziel, durch den Einsatz formaler Engineering-Methoden wesentliche Fortschritte in den Engineering-Methoden f\u00fcr zuverl\u00e4ssige Systeme zu erzielen. Die Fortentwicklung und Verbesserung der professionellen Entwicklungsumgebung, die auf der Eclipse-basierten Rodin-Umgebung aufbaut, sowie die Erm\u00f6glichung der Nutzung der Plattform durch industrielle Anwender waren zentrale Ziele.<\/p>\n<\/div>\n<\/div>\n\n\n\n

\n
<\/div>\n\n\n\n
\n

Herausforderung<\/h3>\n\n\n\n

W\u00e4hrend Rodin bereits ausgereifte Software war, als Bereitstellung von<\/a> 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.<\/p>\n\n\n\n

Die Bereitstellung von<\/a> Das Projektmanagement schaffte es nicht, Personal f\u00fcr die Verbesserung der Dokumentation zu rekrutieren: Weder die akademischen noch die industriellen Partner waren bereit, Ressourcen f\u00fcr diese Aufgabe bereitzustellen, die, obwohl wichtig, als allt\u00e4glich und weniger spannend als die Arbeit an neuen Technologien empfunden wurde.<\/p>\n<\/div>\n<\/div>\n\n\n\n

\n
<\/div>\n\n\n\n
\n

L\u00f6sung<\/h3>\n\n\n\n

Formal Mind hat sich freiwillig gemeldet, diese Aufgabe zu \u00fcbernehmen. Bevor sie auch nur einen Satz schrieben, machten sie eine Problem analyse<\/a> (ein offensichtlicher erster Schritt, da sie Experten f\u00fcr Anforderungen sind). Von Anfang an wurde die Rodin-Community eingeladen und ermutigt, Feedback zu geben. Diese Problemanalyse f\u00fchrte zu einer L\u00f6sung, die aus einem zentralen Dokumentationsrepository und einem Build-Prozess bestand, der drei verschiedene Arten von Dokumentation generierte: PDF, HTML und Eclipse Help.<\/p>\n\n\n\n

Die eigentliche Schreibarbeit erfolgte in vier Iterationen, die jeweils etwa acht Wochen dauerten. Auch dies erm\u00f6glichte es der Rodin-Community, Feedback zu geben und Formal Mind, die Ziele der kommenden Iterationen entsprechend anzupassen. Aber um sicherzugehen, f\u00fchrte Formal Mind w\u00e4hrend 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\u00fchrten zu Anpassungen in der letzten Iteration.<\/p>\n<\/div>\n<\/div>\n\n\n\n

\n
<\/div>\n\n\n\n
\n

Ergebnisse<\/h3>\n\n\n\n

Formal Mind lieferte ein Handbuch mit 178 Seiten in PDF-Version, mit dem die Stakeholder sehr zufrieden waren. W\u00e4hrend einige Inhalte aus dem Wiki \u00fcbernommen (und anschlie\u00dfend zur Vermeidung von Redundanz entfernt) wurden, wurde der Gro\u00dfteil neu erstellt.<\/p>\n\n\n\n

Im Rahmen des Projekts sammelte und verarbeitete Formal Mind 124 R\u00fcckmeldungen von Stakeholdern. Sie richteten zudem ein kontinuierliches Build-System ein, das an der Universit\u00e4t D\u00fcsseldorf gehostet wird und das Handbuch in seinen verschiedenen Formaten automatisch neu erstellt, sobald neuer Inhalt in das Dokumentationsrepository eingecheckt wird.<\/p>\n\n\n\n

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.<\/p>\n<\/div>\n<\/div>\n<\/div>","protected":false},"excerpt":{"rendered":"

Michael Jastram und das D\u00fcsseldorfer Team haben hervorragende Arbeit bei der Zusammenstellung, Erweiterung und Verbesserung verschiedener Dokumentationsquellen zum Rodin-Tool geleistet.<\/p>","protected":false},"author":1,"featured_media":1309,"comment_status":"open","ping_status":"closed","sticky":false,"template":"wp-custom-template-page-large-header-dark","format":"standard","meta":{"_kadence_starter_templates_imported_post":false,"_kad_post_transparent":"","_kad_post_title":"","_kad_post_layout":"","_kad_post_sidebar_id":"","_kad_post_content_style":"","_kad_post_vertical_padding":"","_kad_post_feature":"","_kad_post_feature_position":"","_kad_post_header":false,"_kad_post_footer":false,"_kad_post_classname":"","footnotes":""},"categories":[17],"tags":[],"class_list":["post-1018","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-success-story"],"_links":{"self":[{"href":"https:\/\/www.formalmind.com\/de\/wp-json\/wp\/v2\/posts\/1018","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.formalmind.com\/de\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.formalmind.com\/de\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.formalmind.com\/de\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.formalmind.com\/de\/wp-json\/wp\/v2\/comments?post=1018"}],"version-history":[{"count":0,"href":"https:\/\/www.formalmind.com\/de\/wp-json\/wp\/v2\/posts\/1018\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.formalmind.com\/de\/wp-json\/wp\/v2\/media\/1309"}],"wp:attachment":[{"href":"https:\/\/www.formalmind.com\/de\/wp-json\/wp\/v2\/media?parent=1018"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.formalmind.com\/de\/wp-json\/wp\/v2\/categories?post=1018"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.formalmind.com\/de\/wp-json\/wp\/v2\/tags?post=1018"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}