News

Bringing together what belongs together: DITA as the glue between content silos

Ulrike Parson spricht zu diesem Thema auf der Adobe DITA World 2017. mehr ...

Dynamische Content-Delivery für Navigationsdatenbanken bei NDS e.V.

Auf dem Content-Delivery-Symposium am 27. September 2017 in Esslingen spricht Ulrike Parson zum Thema "Entwickler und Entwicklerdokumentation in den Griff bekommen! Dynamische Content-Delivery für Navigationsdatenbanken bei NDS e.V." mehr ...

Blog

Flipped Classroom: Schulungen effizienter gestalten

Es kostet nicht nur Zeit, in einer Präsenzschulung auf die häufig sehr unterschiedlichen Kenntnisse der Teilnehmer einzugehen. Auch besteht die Gefahr, dass sich Teilnehmer mit höheren Vorkenntnissen langweilen, während sich diejenigen mit geringem Vorwissen überfordert fühlen. mehr ...

Is DITA working for you? Ergebnisse vom DITA Satisfaction Survey 2017

Technische Redakteure aus 250 Unternehmen weltweit haben bereits an der Umfrage des Content Wrangler’s 2017 teilgenommen. Jetzt sind die ersten Ergebnisse da. 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