Blog

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

Machen Sie Ihre technische Dokumentation intelligent – der Weg vom Content Management zu Content Delivery

In diesem Beitrag möchten wir Ihnen aufzeigen, wie man CDPs mit technischer Dokumentation so intelligent befüllt, dass die Nutzer schnell und gezielt Antworten auf ihre Fragestellungen bekommen. mehr ...

So funktioniert Mentoring bei parson

Die Bewerbung ist verschickt, das Vorstellungsgespräch war erfolgreich, jetzt kommt die Zusage. Und da ist er schon, der erste Arbeitstag, an dem alles so fremd ist: Kollegen, deren Namen man sofort wieder vergisst, Ablagestrukturen, Prozesse, ERP-System. Nicht mal die Kaffeemaschine funktioniert auf Anhieb. Und wo war noch mal der Besprechungsraum? mehr ...

Ein Jahr in London. Ich vermisse nicht nur meine Socke

Darf ich vorstellen? Parsons Green in London. Ich finde, der perfekte Ort für einen weiteren Standort von parson. Der Standort ist leider nicht geplant, aber ein Stückchen parson ist im Moment tatsächlich in London. 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.

Kommentar schreiben


  • facebook
  • linkedin
  • xing