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

Zusammenfassung der Adobe DITA World

Die weltweit größte Online-DITA-Konferenz, die Adobe DITA World, hat letzte Woche stattgefunden. mehr ...

Ulrike Parson spricht auf Adobe DITA World: From DITA to iiRDS

Die Adobe DITA World ist die weltgrößte Online-DITA-Konferenz für Experten aus Marketing und Technical Communication. mehr ...

Blog

Der-die-das, drei Redakteure gehen essen und ein Könjunktiv. Bericht von der tekom-Tagung, 1. Teil

Eine Referentin irritierte mich, weil sie konsequent von "dem" Engine sprach, der in der Software für die maschinelle Übersetzung zuständig ist. Ich benutze bei Engine immer "die".  mehr ...

Der iiBot gibt Anweisung

Ein Chatbot, der dem Servicetechniker genaue Anweisungen für seine akute Fragestellung gibt – live, anwendungsgerecht und zugeschnitten auf die Qualifikation des Servicetechnikers. mehr ...
  • linkedin
  • xing