tekom-Impressionen Teil 2: API-Dokumentation und die VUKA-Welt

Daniela Herbold und Ulrike Parson berichten über Leitlinien für eine optimierte API-Dokumentation sowie Lösungsansätze für eine innovative Personalführung.

Daniela Herbold

Vier Leitlinien für die Optimierung von API-Dokumentation

Stephanie Steinhardt, Prof. Michael Meng (API03)

Frau Steinhardt von der Hochschule Merseburg stellte vier Leitlinien vor, die zu einer besseren Nutzung und Akzeptanz von API-Dokumentation führen und Softwareentwickler zum Lesen ermutigen sollen. Die Leitlinien geben vor, dass unter anderem auf Folgendes zu achten ist:

  • Einfacher Einstieg, schnelle produktive Nutzung
  • Schneller Zugriff auf die Dokumentation und einfache Navigation
  • Verknüpfung von Beispielcode mit der entsprechenden Stelle im Quellcode des Entwicklers

Die Leitlinien waren die Ergebnisse einer Studie, mit Softwareentwicklern als Probanden. Mithilfe von Eye Tracking zeichneten die Forscher Augenbewegungen auf und konnten so die Bereiche der Softwareoberfläche nachverfolgen, die von den Probanden während der Bearbeitung einer Aufgabe angesehen wurden. Anschließend verglichen die Forscher die Nutzung herkömmlicher Entwicklerdokumentation mit der, die mithilfe der Leitlinien optimiert wurde.

In der optimierten Version wurde z. B. auf dem linken Bildschirmbereich die Dokumentation und auf der rechten Seite der Entwicklercode angezeigt. Im Code wurde der Abschnitt markiert, der der Handlungsanweisung in der links angezeigten Dokumentation entspricht. Ergebnis des Vergleichs: mithilfe der optimierten Dokumentation lösten die Entwickler ihre Aufgaben im Schnitt schneller und machten weniger Fehler. Außerdem lasen sie in der optimierten Version mehr Text.

Die Forschungsergebnisse von Frau Steinhardt und Prof. Meng sind extrem nützlich für technische Redakteure, die im Bereich der API-Dokumentation tätig sind. In der Zukunft möchte Frau Steinhardt die Prozesse für die optimierte Dokumentationserstellung beschleunigen, um die geschilderte Verzahnung der Informationen für den Redaktionsalltag noch nutzbarer zu gestalten.

Lesen Sie auch den Gastbeitrag von Frau Steinhardt zum gleichen Thema auf unserer Website: API-Dokumentation – Was wir von Entwicklern lernen können.

tekom 2017 Mitarbeiter parsonUlrike Parson, Luca Leonie Jäger und Lucie Le Naour von parson vor der Messe in Stuttgart

Ulrike Parson

Innovative Personalführung bei Komplexität - Ausgewählte Lösungsansätze

Prof. Michael Schaffner (PTK 02)
Slides

Zu meiner Schande muss ich gestehen, dass ich eher zufällig in Prof. Schaffners Vortrag gelandet bin. Ich hatte einen freien Slot, das Thema klang interessant und relevant, und da war ich nun. Und merkte schnell, dass der Vortrag eine Zusammenfassung unserer Organisationsänderungen der letzten zwei Jahre darstellte.

Aber von Anfang an: Prof. Schaffner beschrieb, dass sich Menschen und Unternehmen in einer VUKA-Welt bewegen: Volatil, Unsicher, Komplex und Ambigue. Organisationen, die streng hierarchisch aufgebaut sind und Entscheidungen nur auf bestimmten Ebenen treffen, sind in einer VUKA-Welt anfälliger für disruptive Veränderungen des Marktes. Sie haben größere Schwierigkeiten, sich anzupassen, u.a. weil Entscheidungen zu lange dauern oder nicht von den richtigen Mitarbeitern getroffen werden.

In den letzten Jahren sind neue Organisationsformen entstanden: Soziokratie und transformationale Führung. Sie fördern Kreativität und Selbstorganisation und ermöglichen es, dass Entscheidungen wieder dort getroffen werden, wo die notwendige Sachkompetenz vorliegt. Soziokratie bedeutet aber nicht Entscheidungen durch Mehrheit, sondern kollektive Entscheidungsfindung mit einem Vetorecht, wenn begründete und schwerwiegende Gegenargumente vorliegen (Konsentprinzip).

Auf den Folien von Prof. Schaffner gibt es viele Literaturhinweise. Ergänzen würde ich hier noch das Buch Reinventing Organizations von Frederic Laloux, das uns viele Anregungen gegeben hat.

Und natürlich nicht das Steinhösel-Video verpassen:

 

Kommentar schreiben


Blog

Ein Schuh ist ein Schuh ist ein Schuh. Aber Schleife ist nicht gleich Schleife

Ich bin ungeschickt und zwar nicht nur ein bisschen. Das können Ihnen meine Kollegen bestätigen. Da verwundert es nicht, dass ich seit meiner Kindheit nicht in der Lage war, die Schleifen an meinen Schuhen so zu binden, dass diese nicht nach kurzer Zeit wieder aufgingen. mehr ...

Drei Selbstläufer in Escheburg

Wenn drei Läuferinnen und Läufer von parson an einem kleinen, regionalen Volkslauf teilnehmen, stellen sie nicht nur über zehn Prozent der Gesamtteilnehmer; sie räumen auch die Preise ab. mehr ...

Bitte zweimal klingeln

Endlich! Wir sind umgezogen und haben unser altes Bürohaus in Bergedorf hinter uns gelassen. Dort war es so eng geworden, dass wir uns gegenseitig auf die Zehen traten. Außerdem war es so laut, dass uns an manchem Abend die Ohren sausten. mehr ...

Sprache für junge Nerds, E-Scooter und Sue-ees

Ulrike Parson und Uta Lange erzählen von der Frühjahrstagung in Wien. mehr ...

Wie beinflusst die Digitalisierung die Arbeit der Technischen Redakteure?

Mit der Digitalisierung ändern sich Produkte, Produktionsprozesse und das Nutzungsverhalten. Daraus resultieren neue Anforderungen an die Arbeit der Technischen Redakteure. mehr ...
  • linkedin
  • xing