Alle Beiträge zu Entwicklerdokumentation
Technische Dokumentation – deswegen ist sie wichtig und so wird sie erstellt
Für Anbieter und Nutzende von technischen Geräten, Prozessen oder Systemen ist Technische Dokumentation unverzichtbar. Doch was versteht man unter Technischer Dokumentation genau? Wann braucht man Technische Dokumentation und wann ist sie sogar vorgeschrieben? Wie können Sie als Hersteller effizient qualitativ hochwertige Technische Dokumentation anbieten? Antworten auf diese Fragen finden Sie in diesem Artikel. weiterlesen
Können Softwareentwicklung und Technische Redaktion gemeinsam dokumentieren?
parson hat den Bereich “Digital Industries, Factory Automation and Information Management” von Siemens dabei unterstützt, einen einheitlichen Redaktionsprozess zu gestalten, um die Technische Dokumentation zukunftsfähig zu gestalten. weiterlesen
Softwaredokumentation, das unbekannte Wesen?
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? weiterlesen
Mitarbeiter-Portrait: Information schlägt Unterhaltung. Ein Interview mit Gernot Baumann
Gernot Baumann arbeitet seit 2018 bei parson. Wir haben mit ihm über seine Erfahrungen als Quereinsteiger in die Technische Dokumentation und seine Arbeit gesprochen. weiterlesen
API-Dokumentation – Was wir von Entwicklern lernen können
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. weiterlesen