Blog

How to become a technical writer – Confessions of a former translator

A former translator, I worked the first seven years of my professional life in the translation industry, in various positions. While I learned a lot from this experience, it also left me, as a writer, frustrated. Translators are chained to their source text and writing the words of others in another language, usually focusing on what their clients want. mehr ...

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. mehr ...

tekom-Impressionen Teil 1: Improvisationstechniken, Fluff Hunt und Videos

Auf dem Weg zur Konferenz sehe ich an der Fassade des Stuttgarter Bahnhofs ein Zitat von Hegel: „daß diese Furcht zu irren schon der Irrtum selbst ist“. Genau darum ging es in Anthonys Apodacas Vortrag am Morgen des zweiten Konferenztages. mehr ...

My first time at tekom

I got back from Stuttgart last night and it is safe to say that after three days of action-packed presentations, writing an article is not in the realm of possibilities right now as I try to connect one synapse with another. mehr ...

Eine Tasse auf Reisen #4 - die Auflösung

In welcher Stadt wurde die parson-Tasse fotografiert, haben wir Anfang September gefragt. Die Frage war knifflig. Trotzdem kamen die meisten auf die richtige Antwort: In Chicago, USA. mehr ...

Spartakiade in Berlin: Jägerschnitzel, Scrum und Funktionsdesign

Vom 19.-20. März 2016 nahm ich an der Spartakiade in Berlin teil. Müde, geschafft, glücklich und mit vielen Gedanken im Kopf kehrte ich zurück. Das habe ich erlebt:

Freitagabend: Das geht gut los. Abendessen im Restaurant Volkskammer mit Jägerschnitzel, Soljanka und roter Grütze.

Spartakiade in BerlinEröffnung der Spartakiade in Berlin. Foto: Anne HoffmannAm Samstag dann: Sport frei! Im Workshop „Ab morgen bitte Scrum“ von Thomas Schissler lerne ich viel über den Klebstoff zwischen Scrum-Guidelines und Scrum-Meetings. Dabei nehme ich Anregungen für kommende Retrospektiven, für die Planung und Priorisierung von Aufgaben sowie für das Teambuilding mit. Der Workshop wird agil gehalten: Wir Teilnehmer stimmen jeweils iterativ ab, was wir als nächstes hören oder machen möchten. Dafür hat der Trainer ein Backlog aus Vorträgen, Spielen und Diskussionsrunden vorbereitet. Es bleibt viel Zeit zum Erfahrungsaustausch über Scrum. Abgeschlossen wird der Workshop mit der Prüfung der am Anfang festgelegten Erfolgskriterien. Das Ergebnis: abgenommen. Das war ein klasse Workshop!

Samstagabend: Party! Freibier, Spaß und Networking. Viele wollen wissen, was in meinem Workshop am Sonntag dran kommt. Ich bleibe eisern und verrate nichts.

Sonntag: Sport frei für die zweite Runde. Heute bin ich die Trainerin. Das Thema meines Workshops ist Funktionsdesign® für Entwicklerdokumentation.

Mit acht Entwicklern übe ich das Funktionsdesign®. Die Idee: Informationsprodukte lassen sich Schicht für Schicht strukturieren - genauso, wie man Matroschkas auseinander nimmt und wieder verschachtelt. Die äußeren Schichten bestehen aus den sichtbaren Blöcken wie Listen, Tabellen, Bilder und Schritt-für-Schritt-Anweisungen. Die inneren Schichten erkennt man meist durch Formatierungen, Farben und semantische Auszeichnungen.

Spartakiade3Bob, Dörte und Petra. Die drei Matroschkas dienen zur Verdeutlichung der Strukturebenen und als Personas. Foto: Anne Hoffmann

Zu Beginn erstellen wir drei Personas und überlegen, wann sie eine API-Dokumentation lesen würden:

  • Bob: Nerd, 25, will zu Hause mit der API per „Trial and Error“ herumspielen.Bob braucht einen Startpunkt, der ihm Informationen zum Ausprobieren und Unterstützung bei der Fehlersuche bietet.
  • Dörte: Product Owner, ehemals Entwicklerin, will eine API einsetzen und weiß nicht, ob sie passt. Dörte möchte sich eine Übersicht über die Features verschaffen und ein Gefühl dafür bekommen, wie der Code funktioniert.
  • Petra: Entwicklerin, soll nach Dörtes „Go“ loslegen und mit der API einen konkreten Use Case umsetzen. Petra sucht sich aus der Referenz die passenden Objekte und Methoden heraus. Zusätzlich möchte sie grundsätzliche Konzepte der API verstehen, um sie richtig einsetzen zu können.

Spartakiade in Berlin. Anne Hoffmann, parson AGMit Teilnehmern meines Workshops Funktionsdesign® für EntwicklerdokumentationMit den Personas und Use Cases im Hinterkopf prüfen wir eine bestehende API-Dokumentation und optimieren sie nach Funktionsdesign®. Alle Teams finden schnell die typischen strukturellen Fehler im Dokument, z.B. fehlende Informationen und Auszeichnungen, verwirrende Formatierungen, falsch eingesetzte Listenformate sowie terminologische Inkonsistenzen. Jeder wird fündig und bringt Ideen für die Verbesserung ein.

Spartakiade 2016 in Berlin Bob, Dörte und Petra wurden am Ende unter den Teilnehmern verlost. Richtig glücklich ist Bob darüber nicht. Foto: Anne HoffmannZum Schluss wird die Zeit leider zu knapp, um noch einmal bei null anzufangen und nach Funktionsdesign® zu schreiben. Auch der Erfahrungsaustausch kommt etwas kurz. Ich hätte mit den Teilnehmern gern auch allgemeine Fragen besprochen, zum Beispiel: „Ist Entwicklerdokumentation deshalb so schlecht, weil sie so einen geringen Stellenwert in den Unternehmen hat?“ Und: „Wie kann man die Asynchronität zwischen Code und Dokumentation verringern?“ Den Erfahrungsaustausch kann man sicher noch nachholen, z.B. auf der nächsten Spartakiade.

Die Spartakiade auf Twitter: https://twitter.com/spartakiade_org

Kommentar schreiben


  • facebook
  • linkedin
  • xing