Mit zunehmender Digitalisierung steigt der Bedarf an Softwaredokumentation. Dieser Artikel bietet Einsteigern einen Überblick über die wesentlichen Merkmale von Softwaredokumentation. Was macht gute Softwaredokumentation aus und was müssen Technische Redakteure wissen, um sie zu erstellen? Teil 1 von 2 mehr...

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

Befragt man Entwickler nach API-Dokumentation, tun sich ziemlich schnell zwei unterschiedliche Lager auf. Es gibt Entwickler, die davon überzeugt sind, dass guter Code überhaupt keiner Erklärung bedarf, und natürlich auf der anderen Seite auch jene Entwickler, die häufig Dokumentation lesen und sie auch selbst gern schreiben. Ebenfalls verschiedenste Meinungen und Ansätze existieren bezüglich Aussehen, Darreichung und Inhalt einer perfekten API-Dokumentation. mehr...

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

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