Blog

iiRDS – How a Novice Sees the Information Delivery Standard

Lately, the newly developed tekom standard iiRDS has gained quite some attention. The next exciting step will be the release of version 1.0, which will be released soon. Requesting and delivering intelligent information as a standardized approach between individual enterprises is a pioneering step in the Internet of Things – but let’s rewind a little. mehr ...

Tiere im Büro. Teil 1: Molly

Zwar ist die Stimmung bei uns immer gut, aber wenn Molly da ist, sind wir alle noch viel netter. Molly tut uns gut. mehr ...

Blog-Empfehlung: Soft-Skills für den Berufseinstieg

Welche Fähigkeiten sollten Berufseinsteiger in der Technischen Redaktion mitbringen? Sprachliches und technisches Verständnis sind in unserem Beruf unabdingbar. Aber auch Soft-Skills sind wichtig – wie in jedem anderen Beruf auch. mehr ...

Eine Tasse auf Reisen #5 - die Auflösung

In welchem Land wurde die parson-Tasse fotografiert, haben wir Anfang Dezember gefragt. Die Frage war knifflig. Trotzdem kamen die meisten auf die richtige Antwort: Kuba. mehr ...

RDF is not XML – RDF serialization and iiRDS metadata

The world of technical writing loves XML. Its document type definitions are the foundation of structured authoring. XML and the underlying schemas structure the content of our information products. The benefits are twofold. Content is consistently structured and easy to read. Authors have an easier time writing the content. The structure provides guidelines for authoring. 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