19.-20. März 2016: Spartakiade in Berlin

Sport frei, Developer. Die Spartakiade ist eine Konferenz, die nur aus Workshops besteht. Unsere Kollegin Anne Hoffmann ist mit einem halbtägigen Workshop dabei.

Anne Hoffmanns Workshop am 20. März befasst sich mit dem Thema "Funktionsdesign® für Entwicklerdokumentation".

Anne Hoffmann, parson AGAnne Hoffmann, parson AGWorum es geht: Die Ansprüche an Entwicklerdokumentation steigen. Neben der kompletten Referenz werden erklärende und leicht verständliche Texte gewünscht. Nur wie erreicht man das? Parameter besser in eine Tabelle oder Liste? Code Snippets lieber fett oder in Monospace-Schrift? Wo beginnt ein neues Kapitel und wo ein neuer Absatz? Welche Information kommt auf die Startseite und welche erläutert das Tutorial?

In diesem halbtägigen Workshop werden Methoden geübt, um Dokumentation zu „designen“. Ziel ist es, im Team eine gut verständliche und kompakte Entwickler­dokumentation für die API einer App zu erstellen. Aus Use Cases, ersten Ideen und Mindmaps wird Schicht für Schicht ein Text geformt. Funktionsdesign® hilft dabei, die Einleitung, Konzepte, Funktionen und Tutorials aussagekräftig zu schreiben. Wenn Zeit bleibt, können mitgebrachte Beispieldokumentationen umgekehrt Schicht für Schicht entpackt und auf Form und Funktion überprüft werden.

Funktionsdesign® ist eine von Werkzeugen unabhängige Methode. Der Workshop wird keine Tools für die halb- oder vollautomatische Generierung einer Dokumentation einer API nutzen oder bewerten. Für die aktive Mitarbeit reicht ein Notebook mit Texteditor oder ganz einfach Zettel und Stift.

Anne Hoffmann, 20. März 2016, vormittags 10-14 Uhr
Funktionsdesign® für Entwicklerdokumentation

Die Spartakiade findet vom 19. bis 20. März 2016 in Berlin statt. Mehr unter https://spartakiade.org/.

News

LearningDITA Live 2019 - jetzt auch mit deutschen Vorträgen. Registrieren Sie sich jetzt!

LearningDITA Live ist die kostenlose Online-Konferenz von Scriptorium Publishing mit spannenden Präsentationen rund um DITA. Tauchen Sie ein in die Welt von DITA vom 25. bis 28. Februar 2019. mehr ...

Der Technische Redakteur als Wissensmanager. Vortrag von Ulrike Parson

Die tekom Österreich veranstaltet am 30. November 2018 in Wels die Tagung "Von der Dokumentation zum Wissensmanagement". Ulrike Parson ist eine der vier Referenten. mehr ...

Blog

tekom-Jahrestagung 2018: Was gibt’s Neues bei iiRDS?

iiRDS war zentrales Thema auf der tekom-Tagung: das iiRDS-Café, Fachvorträge, Showcases und Tutorials widmeten sich dem neuen Standard. Auch auf Twitter wurde diskutiert, unter anderem über den für US-Kollegen so schwer auszusprechenden Namen. mehr ...

tekom-Bericht Teil 3: Kreativität statt Langeweile – Online-Videos für die technische Doku

Manege auf! Zu Beginn seines Workshops „Packende Online-Videos mit einfachen Mitteln erstellen“ zeigte Stephan Schneider zwei Bilder. mehr ...
  • linkedin
  • xing