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

plusmeta und parson werden Partner

Mit der Digitalisierung und Industrie 4.0 müssen technische Informationen intelligent werden. Die Software unseres neuen Partners plusmeta analysiert komplexe Inhalte mit Hilfe von Künstlicher Intelligenz und erzeugt automatisiert zugehörige Metadaten und semantische Strukturen. mehr ...

Dokumentieren mit DITA XML und Schulung für Technische Redakteure

Modern, kundengerecht und zukunftssicher sollte die Dokumentation für die Zeichenmaschine liNear Desktop werden. parson hat liNear GmbH bei der Umstellung auf DITA XML unterstützt. mehr ...

Blog

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 ...
  • linkedin
  • xing