Fragebogen zum Thema: Software-Entwicklerdokumentation
Autoren: Michael Meng | Andreas Schubert | Stephanie Steinhardt
Diese Befragung wird im Rahmen eines Forschungsprojektes der Hochschule Merseburg von Michael Meng, Andreas Schubert und Stephanie Steinhardt durchgeführt.Das Ziel dieser Befragung ist, dein Nutzungsverhalten von Software-Entwicklerdokumentation zu untersuchen. Wir möchten erfahren, wann du im täglichen Arbeitsprozess auf Dokumentation zurückgreifst und welche Inhalte für dich besonders interessant sind.Dieser Fragebogen reiht sich in eine Folge von Untersuchungen zum Thema Software-Entwicklerdokumentation ein. Aus den gewonnenen Ergebnissen werden wir Optimierungsvorschläge ableiten, um Software-Entwicklerdokumentation zu verbessern. Wir wollen sie damit für dich als Entwickler nützlicher machen.Wir hoffen, dass du uns etwa 20 Minuten deiner Zeit gönnst und damit hilfst, Entwicklerdokumentation zu optimieren.Bei möglichen Rückfragen stehen wir dir gerne zur Verfügung. Kontakt: andreas.schubert@hs-merseburg.deVielen Dank für deine Unterstützung.Datenschutzerklärung: Diese Umfrage erfolgt anonym. Ihre Daten werden ausschließlich für die Verarbeitung und Auswertung gespeichert. Es erfolgt keine Weitergabe an Dritte.
Alter:
Geschlecht:
Muttersprache:
Wie viele Jahre arbeitest du schon als Entwickler?
Welcher Rolle im Unternehmen würdest du dich am ehesten zuordnen? (Mehrfachnennungen möglich)
Welche Programmiersprachen hast du in letzter Zeit regelmäßig verwendet? (Mehrfachnennungen möglich)
Mit welchen API-Typen hast du bereits Erfahrung gesammelt?
Web APIs (z. B. SOAP, REST)
keine Erfahrung
viel Erfahrung
bibliothekbasierte APIs (z. B. Javascript)
klassenbasierte APIs (z. B. Java)
andere APIs (z. B. Hardware APIs)
Du musst dich in eine neue API einarbeiten. Welche Fragen stellst du dir ...
... als Erstes?
Andere:
... als Zweites?
... als Drittes?
Du musst dich in eine neue API einarbeiten. Was sind deine ersten Schritte? (Mehrfachnennungen möglich, maximal 3 Antworten)
Was sind typische Probleme bei der Einarbeitung in eine neue API? (Mehrfachnennungen möglich)
Bei der Arbeit mit der API tritt ein Problem auf. Was machst du…
Anderes:
Wie häufig nutzt du die folgenden Informationsquellen?
Konzeptdokument (z. B. Technical Whitepaper)
nie
sehr häufig
API-Referenz
Codebeispiel
Tutorial
Forum (z. B. Stack Overflow)
Blog
Quellcode (wenn verfügbar)
Wie hilfreich findest du die folgenden Informationsquellen?
nicht hilfreich
sehr hilfreich
Welche Informationsquellen nutzt du eher bei der Einarbeitung in eine neue API? (Mehrfachnennungen möglich)
Welche Informationsquellen nutzt du später bei der Lösung von Programmieraufgaben mit der API? (Mehrfachnennungen möglich)
Wie suchst du bevorzugt in einer Dokumentation nach relevanten Informationen? (Mehrfachnennungen möglich)
Wenn du bei der Suche eine Seite als Treffer gefunden hast, wie suchst du dann auf dieser Seite weiter? (Mehrfachnennungen möglich)
Was hilft dir bei der Einschätzung, ob eine gefundene Seite in der Doku für dein Problem relevant ist? (Mehrfachnennungen möglich)
Bewerte die folgenden Eigenschaften von API-Dokumentation nach ihrer Wichtigkeit für dich.
Vollständigkeit
unwichtig
sehr wichtig
Aktualität
Suchfunktion
Filtersuche
enthält Codebeispiele
ist in die Entwicklungsumgebung integriert
enthält Erklärungen zu Klassen/Methoden
enthält Erklärungen zu technischen Hintergründen und Zusammenhängen
enthält Erklärungen zur Verwendung bei alternativen Methoden/Klassen
behandelt Fehlerfälle
unterscheidet nach Versionen
enthält revision history
enthält Kommentare anderer Nutzer
Was sind typische Hindernisse bei der Nutzung von API-Dokumentation? (Mehrfachnennungen möglich, maximal 3 Antworten)
Arbeitest du gern mit Codebeispielen?
Bevorzugst du kurze Codebeispiele?
Bevorzugst du Erklärungen zu Beispielcode?
Wozu verwendest du Codebeispiele in der täglichen Arbeit? (Mehrfachnennungen möglich)
Welche Mängel von Codebeispielen treten bei der Arbeit wie häufig auf?
funktionsunfähig
veraltet
zu komplex
zu einfach
schlecht programmiert
unverständlich
schlecht dokumentiert
Sollten Abbildungen innerhalb der Dokumentation verwendet werden?
Arbeitest du mit UML?
Erstellst du selbst Grafiken zur Dokumentation deines Codes oder zur Architektur?
Welche Arten von Abbildungen findest du hilfreich?
Klassendiagramm
Prozessgrafik
technische Übersicht
Screenshot
Überblicksgrafik
Welchen Anteil deiner Arbeitszeit (in Prozent) nehmen die folgenden Aktivitäten ungefähr ein?
Coden
0%
100%
Testen
Dokumentieren
Recherchieren
Organisatorisches
Wann dokumentierst du deinen eigenen Code?
Wird dir ausreichend Zeit zum Dokumentieren eingeräumt?
Musst du über Quellcode-Dokumentation hinaus auch andere Arten von Dokumentation schreiben?
Dokumentierst du gern?
Wie schätzt du die Qualität der Dokumentation ein, die du selber schreibst?
sehr schlecht
sehr gut
Welche Sprache bevorzugst du in der Dokumentation?
In welcher Sprache würdest du dokumentieren, wenn du frei wählen könntest?
Hast du Schwierigkeiten, Dokumentation in Englisch zu verstehen?
keine Schwierigkeiten
große Schwierigkeiten
Hast du Schwierigkeiten, Dokumentation in Englisch zu schreiben?
Hast du noch Anregungen oder Bemerkungen zum Thema "Software-Entwicklerdokumentation" oder zu diesem Fragebogen?
Vielen Dank für deine Teilnahme an unserer Umfrage!
Lizenziert an Hochschule Merseburg - evasys V9.1 (2450) - Copyright © 2023 evasys GmbHöffnet im neuen Fenster. Alle Rechte vorbehalten.