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

Setting a Standard for Intelligent Content. Ulrike Parson und Mark Schubert mit Vortrag bei DITA North America

In Industrie 4.0 und dem Internet der Dinge sollen Anlagen, Geräte und Komponenten intelligent miteinander verbunden sein. Aber wie können wir die Geräte- und Softwaredokumentation verschiedener Hersteller miteinander verbinden? mehr ...

parson und ICMS führen bei der Korsch AG Schema ST4 ein

Eine Partnerschaft zum Nutzen des Kunden: Gemeinsam haben parson und ICMS die Korsch AG bei der Einführung von strukturierter Dokumentation mit Schema ST4 unterstützt. mehr ...

Blog

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