Entwicklerdokumentation erstellen
Wir unterstützen Ihre Softwareentwicklung
Ihr Unternehmen entwickelt innovative Softwareprodukte, APIs, Plattformen oder Webservices, die Softwareentwickler:innen für eigene Anwendungen nutzen können. Ihre Produkte sind smart, intuitiv zu bedienen und erleichtern den Entwickler:innen die Arbeit.
Nur Ihre Dokumentation hinkt der rasanten Entwicklung hinterher. Das führt dazu, dass es viele Supportanfragen gibt und Ihr Kunden-Support überlastet ist. Außerdem haben Ihre Entwickler:innen neben der Produktentwicklung immer weniger Zeit für die Dokumentation.
Entwicklerdokumentation und API-Dokumentation für Ihre Produkte
parson erstellt für Sie zeitgemäße Entwicklerdokumentation und API-Dokumentation. Dazu gehören u.a. Architekturdokumentation, Referenzinformationen, Code-Dokumentation, Tutorials und Anwendungsfälle. Das Besondere: Wir benutzen die gleichen Tools und Methoden wie die Entwickler:innen und integrieren die Dokumentation nahtlos in die Entwicklungsprozesse. Denn wir wissen, dass Entwickler:innen nicht gern ihre Umgebung verlassen. Daher bringen wir die Dokumentation zu ihnen. So arbeiten wir.
Ihre Ansprechpartner:innen
Entwicklerdokumentation
Unsere Kundschaft
Bessere Entwicklerdokumentation für Ihre Produkte. So arbeiten wir
- Anforderungen analysieren. Gemeinsam analysieren wir die Anforderungen Ihrer Zielgruppen, erarbeiten eine Informationsarchitektur für Ihre Dokumentation und entwickeln Vorlagen, etwa in Markdown.
- Entwicklerdokumentation schreiben. Wir erstellen die unterschiedlichen Bestandteile der Entwicklerdokumentation in Kooperation mit Ihren Entwickler:innen. Dabei nutzen wir häufig einfache Auszeichnungssprachen wie AsciiDoc oder Markdown. Wir schreiben in der Regel direkt auf Englisch.
- Docs-as-code-Ansatz. Wir arbeiten eingebettet in Ihre Entwicklungsumgebung und verwenden Tools für Issue-Tracking, Versionskontrolle und Continuous Integration. Wir nutzen agiles Projektmanagement. Mehr erfahren über Dokumentation automatisieren mit Docs-as-code.
- Bei der Systemauswahl unterstützen. Wir unterstützen Sie bei der Auswahl und Einrichtung von Systemen für die Auslieferung der Dokumentation und für den Aufbau von Entwicklerportalen.
Weitere Informationen rund um das Thema Entwicklerdokumentation finden Sie auch in unseren FAQs.
FAQs – Häufig gestellte Fragen zu Entwicklerdokumentation
Was ist Entwicklerdokumentation?
Entwicklerdokumentation ist Teil der Softwaredokumentation. Sie wird für Entwickler:innen geschrieben, die Funktionen, Schnittstellen oder Services eines Systems in eigenen Anwendungen nutzen möchten. Entwicklerdokumentation wird oft in einfachen Auszeichungssprachen wie Markdown oder AsciiDoc und auf Englisch geschrieben.
Wer schreibt Entwicklerdokumentation: Technische Redakteur:innen oder Entwickler:innen selbst?
Softwareentwickler:innen sind hoch spezialisiert. Deshalb muss die Dokumentation für diese Zielgruppe auch diesem spezialisierten Kenntnisstand entsprechen. Entwickler:innen kennen sich gut mit der technischen Umsetzung von Software aus. Verständliches, korrektes und konsistentes Schreiben gehört oft nicht zu ihren Stärken. Oder ihnen fehlt die Zeit zum Schreiben. Hier können Technische Redakteur:innen unterstützen. Mit einem gemischten Team von Entwickler:innen und Redakteur:innen funktioniert es daher am besten.
Was ist Docs-as-code?
Docs-as-code ist ein Ansatz zur Erstellung und Bereitstellung von Dokumentation für Software. Docs-as-code bedeutet, dass Sie die Dokumentation auf die gleiche Weise behandeln wie den Code. Der Docs-as-code-Ansatz kombiniert zwei wichtige Aspekte:
- Die Dokumentation verwendet die gleichen Werkzeuge wie die Entwickler:innen, z. B. IDEs (integrated development environments), Versionskontrollsysteme und Werkzeuge für continuous integration und delivery.
- Die Autor:innen verwenden die gleichen Methoden wie die Entwickler, z. B. agiles Projektmanagement und Scrum.
Mehr erfahren über Dokumentation automatisieren mit Docs-as-code.
Kann ich Entwicklerdokumentation in einem Texteditor erstellen oder brauche ich ein Autorensystem?
Sie benötigen nicht zwingend ein Autorensystem. Mit Docs-as-Code können Sie Inhalte als reinen Text in einem Texteditor erstellen, normalerweise in einer einfachen Auszeichnungssprache. Die drei am häufigsten verwendeten Sprachen sind Markdown, AsciiDoc und reStructuredText. Als Editor zum Schreiben ist Visual Studio Code von Microsoft sehr verbreitet.
Wie veröffentliche ich Inhalte mit Docs-as-Code?
Sie schreiben Docs-as-Code in einer einfachen Auszeichnungssprache als reinen Text. Durch die Trennung von Inhalt und Darstellung können Sie verschiedene Ausgabeformate aus denselben Quellen erstellen, z. B. XHTML, PDF oder DocBook XML. Statische Website-Generatoren sind die gängigsten Werkzeuge zur Erstellung von HTML-Ausgaben. Es gibt eine Reihe von Website-Generatoren, z. B. Hugo, Jekyll, Gatsby oder Docusaurus. Für AsciiDoc gibt es Antora.