Alle Beiträge zu Softwaredokumentation

Wie bei einem Text lassen sich auch die Inhalte einer Grafik einfach vermitteln: Vereinfachte und SUI-Grafiken in der Softwaredokumentation betonen das Wesentliche und schaffen Orientierung. Das Ergebnis ist eine deutlich höhere Verständlichkeit und Akzeptanz.
  weiterlesen

SICK benötigte eine Online-Hilfe für die Lokalisierungssoftware LiDAR-LOC. parson entwickelte eine topic-basierte Informationsarchitektur und unterstützte SICK redaktionell beim Erstellen der Online-Hilfe. weiterlesen

Anna M. ist Software-Entwicklerin. Seit kurzem arbeitet sie bei einer Firma, die spezialisierte Erweiterungen für eine kaufmännische Standardsoftware verkauft. Für die Entwicklung dieser Erweiterungen soll Anna das API der kaufmännischen Software verwenden. Aber Anna hat ein Problem. Sie weiß nichts über das API – seine Struktur, die Schnittstellen, die angebotenen Funktionen. weiterlesen

In der agilen Software-Entwicklung werden Anforderungen nicht mehr in Pflichten- und Lastenheften geschrieben, sondern in Form von handlichen User-Stories festgehalten, die auf einer Karteikarte oder einem Bierdeckel Platz haben. Doch wie schreiben Sie kurze und knackige Anforderungen, die nützlich für die Entwickler sind und eine gute Basis für aufgabenorientierte Dokumentation darstellen? weiterlesen

Writing technical documentation for software engineers is more than authoring code comments. In order to use an application programming interface (API) or existing source code effectively, software engineers require different types of information. For this reason, technical writers who author API documentation need to analyze the requirements of their target group. weiterlesen