News

Version 1.0 von iiRDS veröffentlicht

Die tekom veröffentlichte am 18. April 2018 Version 1.0 von iiRDS, dem herstellerübergreifenden Standard für die Auslieferung und Abfrage intelligenter Informationen. parson beteiligte sich aktiv an der Entwicklung von iiRDS (intelligent information Request and Delivery Standard). mehr ...

Wir suchen Technischen Redakteur (m/w) für Hamburg

Sie haben Spaß an IT und Freude an Sprache? Dann kommen Sie zu uns. Als Mittler zwischen Technikern und Anwendern vermitteln Sie in anschaulicher Weise, wie komplexe Technologien funktionieren. mehr ...

Blog

Tiere im Büro, Teil II: Der Miau-Effekt

Im zweiten Teil unserer Mini-Blogserie geht es um zwei Brüder. Und das ist auch vorerst der letzte Teil. Es sei denn, es schleicht sich noch ’ne Maus ins Haus. Oder ein Goldfisch. mehr ...

Check if oder check that? Oder: Have you tried turning it off and on again?

Wie oft schreiben oder lesen wir in Anleitungen, dass wir etwas prüfen sollen. Beispiel: "Check if the computer is connected to power." Klare Ansage, alles schön. Was aber, wenn dort steht: "Check that the computer is connected to power"? 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