Wer schreibt die Benutzerdokumentation?Definition ISO/IEC 26514)! • Analyse der entstehenden...
1
Kontakt und Informationen zum Écrit Projekt FH VORARLBERG Forschungszentrum Prozess- und Produkt-Engineering DI (FH) Descher Marco, MSc [email protected] Fördergeber Österreichische Forschungsförderungsgesellschaft (FFG) Projektnummer 840165 Projektlaufzeit Oktober 2013 - September 2014 Projektleiter Prof. (FH) Feilhauer Thomas Projektmitglieder DI (FH) Descher Marco, MSc und Amann Lucia, BSc Wer schreibt die Benutzerdokumentation? Problem • Die Benutzerdokumentation einer Anwendung ist eine der ersten Anlaufstellen des Anwenders • Das Erstellen der Benutzerdokumentation wird meist der Entwicklung nachgestellt und oft existieren Abweichungen zwischen der Anwendung und derselbigen Relevanz • 4738 Software-entwickelnde Kleinbetriebe (micro enterprises) mit weniger als 9 Mitarbeitern in Österreich 1 • Kein dezidiertes Dokumentations-Team in Kleinbetrieben • Verkürzte Dokumentationszeit = Mehr Zeit für die Entwicklungstätigkeit Kann die Benutzerdokumentation automatisiert erstellt werden? • Ansätze dazu bereits in mehreren wissenschaftlichen Arbeiten erörtert (vgl. Johnson 2 und Amalfitano et al. 3 ) • Nur Teilspektrum einest vollständigen Benutzerdokumentation konnte bisher extern über Modellierung abgedeckt (bspw. instructional, task oriented - Ablaufdokumentation) und dadurch automatisiert erstellt werden • Quellcode besteht aus Klassen und Paketen, von welchen die weiterführende Bedeutung nicht automatisiert ableitbar ist • Bisher keine Verbindung zwischen Entwicklungs- und Dokumentationscode/-prozess gegeben Das Eclipse Applikationsmodell • (Live) Modell welches den Aufbau und die graphischen Komponenten der Anwendung beinhaltet und damit eine Lücke zwischen Code und Code-Bedeutung schliesst • Standard zur Entwicklung neuer Anwendungen auf Basis von Eclipse RCP • Die Anwendung selbst wird modelliert, die einzelnen Abläufe und Darstellungen werden weiterhin codiert • Folgende Informationen sind aus diesem Modell ableitbar - Zur Verfügung stehende Aktionen und deren „Einbettungsart“ (bspw. als Menüeintrag oder Button) - Erweiterungen der Anwendung - Grafischer Aufbau der Anwendung Das Écrit Projekt Die Forschungsfrage 4 : Welche Möglichkeiten zur automatisierten Erzeugung der Benutzerdokumentation ergeben sich auf Basis des Eclipse Applikationsmodell? Welchen Beschränkungen unterliegen wir? Projektablauf • Erstellen einer Beispiel-Anwendung mit Entwicklungs-Artefakten (User stories, Meta-Daten) • Definition einer ISO/IEC 26514 konformen Benutzerdokumentation • Applikationsmodell um semantische Beschreibung erweitern • Automatisiertes Erstellen der Benutzerdokumentation aus dem beschriebenen Applikationsmodell • Analyse der entstehenden Benutzerdokumentation • Erweiterung des Applikationsmodell um fehlende Elemente (gem. Definition ISO/IEC 26514) • Analyse der entstehenden Benutzerdokumentation auf erweitertem Applikationsmodell Referenzen [1] Statistik Austria: Unternehmen und Arbeitsstätten; Klassifikation ÖNACE 2008, Kategorie J6201 Stand 2010 [2] W.L. Johnson, Dynamic (Re)Generation of Software Documentation, Proc. 4th Systems Reengineering Technology Workshop, J. Hopkins University, 1994 [3] D. Amalfitano et al. Using dynamic analysis for generating end user documentation for Web 2.0 applications, 13th IEEE International Symposium on Web Systems Evolution (WSE 2011), Williamsburg, VA, USA, September 30, 2011 [4] Towards automated application software documentation generation based on the Eclipse application model (Marco Descher, Thomas Feilhauer), In Proceedings of the IASTED International Conference on Software Engineering (SE 2014) (M.H. Hamza, ed.), 2014. About Pharmacy Austria 1 — Introduction 1.1 About Pharmacy Austria Pharmacy AT is an application that allows to manage a strongly limited set of aspects of an Austrian Pharmacy. Its main purporse is, to act as a sample application for the development of the http://www.ecrit.atEcrit User Manual creation project. The application provides an interface for 4 different kinds of users: • Seller the person selling articles to customers • Stockist responsible for managing the stock and the respective orders • Clerk responsible for accounting and balance of the pharmacy • Admin responsible for defining access rights within the application Beispiel-Anwendung Pharmacy Austria HTML Benutzerdokumentation LaTeX/PDF Benutzerdokumentation http://www.ecrit.at Semantische Beschreibung eines Befehls Applikationsmodell
Transcript of Wer schreibt die Benutzerdokumentation?Definition ISO/IEC 26514)! • Analyse der entstehenden...
![Page 1: Wer schreibt die Benutzerdokumentation?Definition ISO/IEC 26514)! • Analyse der entstehenden Benutzerdokumentation auf erweitertem Applikationsmodell ! Referenzen [1] Statistik](https://reader035.fdokument.com/reader035/viewer/2022070623/5e4c914f0935893b3b56a2fd/html5/thumbnails/1.jpg)
Kontakt und Informationen zum Écrit Projekt!FH VORARLBERG!Forschungszentrum Prozess- und Produkt-Engineering!!DI (FH) Descher Marco, [email protected]!!Fördergeber! ! ! Österreichische Forschungsförderungsgesellschaft (FFG)!Projektnummer! ! 840165!Projektlaufzeit! ! Oktober 2013 - September 2014!Projektleiter! ! ! Prof. (FH) Feilhauer Thomas!Projektmitglieder!! DI (FH) Descher Marco, MSc und Amann Lucia, BSc
Wer schreibt die Benutzerdokumentation?Problem!!• Die Benutzerdokumentation einer Anwendung ist eine der ersten
Anlaufstellen des Anwenders!• Das Erstellen der Benutzerdokumentation wird meist der
Entwicklung nachgestellt und oft existieren Abweichungen zwischen der Anwendung und derselbigen
Relevanz!!• 4738 Software-entwickelnde Kleinbetriebe (micro enterprises) mit
weniger als 9 Mitarbeitern in Österreich1!• Kein dezidiertes Dokumentations-Team in Kleinbetrieben!• Verkürzte Dokumentationszeit = Mehr Zeit für die
Entwicklungstätigkeit
Kann die Benutzerdokumentation automatisiert erstellt werden?!!• Ansätze dazu bereits in mehreren wissenschaftlichen Arbeiten erörtert (vgl. Johnson2 und Amalfitano et al.3)!• Nur Teilspektrum einest vollständigen Benutzerdokumentation konnte bisher extern über Modellierung abgedeckt (bspw. instructional, task
oriented - Ablaufdokumentation) und dadurch automatisiert erstellt werden!• Quellcode besteht aus Klassen und Paketen, von welchen die weiterführende Bedeutung nicht automatisiert ableitbar ist!• Bisher keine Verbindung zwischen Entwicklungs- und Dokumentationscode/-prozess gegeben
Das Eclipse Applikationsmodell!!• (Live) Modell welches den Aufbau und die graphischen Komponenten der Anwendung beinhaltet und damit eine Lücke zwischen Code und Code-Bedeutung schliesst!• Standard zur Entwicklung neuer Anwendungen auf Basis von Eclipse RCP !• Die Anwendung selbst wird modelliert, die einzelnen Abläufe und Darstellungen werden weiterhin codiert!• Folgende Informationen sind aus diesem Modell ableitbar!! ! - Zur Verfügung stehende Aktionen und deren „Einbettungsart“ (bspw. als Menüeintrag oder Button)!! ! - Erweiterungen der Anwendung!! ! - Grafischer Aufbau der Anwendung
Das Écrit Projekt!!Die Forschungsfrage4: Welche Möglichkeiten zur automatisierten Erzeugung der Benutzerdokumentation ergeben sich auf Basis des Eclipse Applikationsmodell? Welchen Beschränkungen unterliegen wir?!!Projektablauf !• Erstellen einer Beispiel-Anwendung mit Entwicklungs-Artefakten (User stories, Meta-Daten)!• Definition einer ISO/IEC 26514 konformen Benutzerdokumentation!• Applikationsmodell um semantische Beschreibung erweitern!• Automatisiertes Erstellen der Benutzerdokumentation aus dem beschriebenen Applikationsmodell!• Analyse der entstehenden Benutzerdokumentation!• Erweiterung des Applikationsmodell um fehlende Elemente (gem. Definition ISO/IEC 26514)!• Analyse der entstehenden Benutzerdokumentation auf erweitertem Applikationsmodell !!!
Referenzen [1] Statistik Austria: Unternehmen und Arbeitsstätten; Klassifikation ÖNACE 2008, Kategorie J6201 Stand 2010 [2] W.L. Johnson, Dynamic (Re)Generation of Software Documentation, Proc. 4th Systems Reengineering Technology Workshop, J. Hopkins University, 1994 [3] D. Amalfitano et al. Using dynamic analysis for generating end user documentation for Web 2.0 applications, 13th IEEE International Symposium on Web Systems Evolution (WSE 2011), Williamsburg, VA, USA, September 30, 2011 [4] Towards automated application software documentation generation based on the Eclipse application model (Marco Descher, Thomas Feilhauer), In Proceedings of the IASTED International Conference on Software Engineering (SE 2014) (M.H. Hamza, ed.), 2014.
About Pharmacy Austria
1 — Introduction
1.1 About Pharmacy AustriaPharmacy AT is an application that allows to manage a strongly limited set of aspects of anAustrian Pharmacy. Its main purporse is, to act as a sample application for the development ofthe http://www.ecrit.atEcrit User Manual creation project.
The application provides an interface for 4 different kinds of users:• Seller the person selling articles to customers• Stockist responsible for managing the stock and the respective orders• Clerk responsible for accounting and balance of the pharmacy• Admin responsible for defining access rights within the application
Beispiel-Anwendung Pharmacy Austria
HTML Benutzerdokumentation
LaTeX/PDF Benutzerdokumentation
http://www.ecrit.at
Semantische Beschreibung eines Befehls
Applikationsmodell
