Alle Beiträge zu Entwicklerdokumentation

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