News

Fachtagung Industrie 4.0 und Technische Kommunikation

Industrie 4.0 – Buzzword, Hype und in aller Munde. Doch was steckt dahinter? Was bedeutet die digitale Vernetzung der industriellen Wertschöpfungskette, welche Konsequenzen hat sie? mehr ...

Metadaten für intelligente Informationen und iiRDS

Am 13. November 2017 hält Ulrike Parson bei der tekom-Regionalgruppe Nord einen Vortrag zum Thema: "Metadaten für modulare Informationen". mehr ...

Blog

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

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

  • facebook
  • linkedin
  • xing