Blog

Arbeiten in selbstführenden Teams. Oder wie wir das Management abschaffen

Die Welt von heute ist VUCA: volatile, uncertain, complex und ambiguous. Unternehmen stehen vor komplexen Herausforderungen wie Industrie 4.0 und dem Internet der Dinge. Wer nicht schnell genug agiert, wird vom Markt verdrängt. mehr ...

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

Hoher Qualitätsanspruch ohne mentale Sandburgen und Dünkel - 10 Fragen an Ines Lasch

Ines Lasch macht eine Weiterbildung zur Technischen Redakteurin und absolviert ein achtwöchiges Praktikum bei parson. Wir haben ihr zehn Fragen gestellt. mehr ...

Volontariat für Technische Redakteure. Zwei Sichten auf die berufsbegleitende Ausbildung

Anja Schiel, Volontärin, und Ulrike Parson, Vorstand der parson AG, berichten über ihre Sicht des Volontariats für die Technische Redaktion.* mehr ...

Wie schreibt man gute API-Dokumentation?

Wenn Software-Entwickler APIs programmieren, steht die Dokumentation oft hinten an. Erst wenn der Fertigstellungstermin nahe rückt oder bereits in Gefahr ist, denkt man an sie. Häufig müssen die Entwickler dann die Dokumentation selbst schreiben. Die arbeiten jedoch unter Hochdruck daran, den Projekttermin zu halten: sie lösen Bugs und nehmen allerletzte Änderungen vor.

Es gibt Software-Entwickler, die beides können: programmieren und schreiben. Meistens sind Entwickler aber besser im Programmieren. Und mal ehrlich, viele Entwickler finden Dokumentation einfach nur mühsam.

Bisher habe ich nur wenige Informationen über das Schreiben von guter API-Dokumentation gefunden. Bis ich vor einigen Tagen auf diesen MSDN-Artikel von Peter Gruenbaum stieß.

Ulrike Parson hat sich in ihrem Artikel Documentation for Software Engineers ebenfalls mit dem Thema befasst.

  • linkedin
  • xing