Technische Dokumentation für Software
Wir schreiben auf, wie Ihre Software aufgebaut ist, wie sie betrieben wird und wie neue Entwickler einsteigen: aus dem Code heraus, von Entwicklern.
Das Wissen über Ihre Software festhalten
Steckt das Wissen über eine Software in wenigen Köpfen, wird jede Übergabe schwierig. Wir lesen Code und Konfiguration, sprechen mit Ihrem Team und halten fest, was andere wissen müssen.
- Architektur: Aufbau, Bausteine und die Entscheidungen dahinter
- Schnittstellen: Beschreibung der APIs mit Beispielen und Fehlerfällen
- Datenmodell: Tabellen, Zusammenhänge und Datenflüsse
- Betrieb: Umgebungen, Auslieferung und Vorgehen bei Störungen
- Übergabe: Einstieg für neue Entwickler oder einen neuen Dienstleister
Für wen das passt
- Ein Entwickler oder Dienstleister geht, und das Wissen soll im Haus bleiben.
- Eine Ausschreibung oder Übergabe verlangt eine aktuelle Dokumentation.
- Neue Entwickler brauchen lange, bis sie sich in Ihrer Software zurechtfinden.
So läuft es ab
Vom Bedarf bis zur Übergabe in vier Schritten.
1.
Bedarf klären
Wer liest die Dokumentation, und wofür? Danach richten sich Umfang und Form.
2.
Bestand ansehen
Wir lesen Code, Konfiguration und vorhandene Unterlagen und sprechen mit den Personen, die das System kennen.
3.
Schreiben
Wir schreiben die Kapitel nacheinander und stimmen sie mit Ihrem Team ab.
4.
Übergabe
Die Dokumentation liegt dort, wo Ihr Team arbeitet, zum Beispiel neben dem Code, und wir zeigen, wie sie aktuell bleibt.
Preisrahmen
| Leistung | Rahmen |
|---|---|
| Dokumentation nach Aufwand | 160 € pro Stunde, 1.280 € pro Tag |
| Architektur und Audit | 220 € pro Stunde |
Das sind Richtwerte, keine Angebote: Alle Angaben sind unverbindlich und verstehen sich zuzüglich Umsatzsteuer. Den Preis für Ihr Vorhaben nennen wir im Angebot.
Für Kunden in der Schweiz: Dokumentation CHF 200 pro Stunde oder CHF 1.600 pro Tag, Architektur und Audit CHF 275 pro Stunde.
Eine erste Spanne für ein Softwareprojekt zeigt Ihnen unser Kostenrechner in sechs Fragen.
Erfolgreich abgeschlossene Projekte
30.06.2025IPW - Internet Platform Wasser
30.06.2025IPW - Internet Platform Wasser
Webplattform für die Wasser-Infrastruktur von Gemeinden: Kanalnetz, Zustand, Maßnahmen und Pläne an einem Ort.
31.12.2023KIM CRM - Kunde im Mittelpunkt
31.12.2023KIM CRM - Kunde im Mittelpunkt
KIM CRM – Effektives Kundenbeziehungsmanagement für nachhaltigen Unternehmenserfolg
15.03.2023Azure DevOps Connector für CAPAMAP
15.03.2023Azure DevOps Connector für CAPAMAP
Eine Erweiterung die Organisationseinstellungsseite, benutzerdefiniertes Arbeitsobjektsteuerelement und umfasst. Ziel ist es, API-Key und Domäne zu konfigurieren, AutoSuggest für verschiedene Objekttypen bereitzustellen und Zugriff auf Azure DevOps Work Items mit Suchfunktion und Statusanzeige zu ermöglichen.
Häufige Fragen
Was gehört in eine technische Dokumentation für Software?
Mindestens der Aufbau der Software, ihre Schnittstellen, das Datenmodell, der Betrieb und der Einstieg für neue Entwickler. Wie tief das geht, hängt davon ab, wer damit arbeitet.
Schreiben Sie auch Betriebsanleitungen für Maschinen?
Nein. Wir dokumentieren Software und ihren Betrieb. Für Betriebsanleitungen von Maschinen und Geräten sind technische Redakteure die richtigen Ansprechpartner.
Was kostet eine technische Dokumentation?
Wir rechnen nach Aufwand ab: 160 € pro Stunde oder 1.280 € pro Tag, Architekturarbeit 220 € pro Stunde. Den Aufwand schätzen wir vorab, unverbindlich.
Dokumentieren Sie auch Software, die Sie nicht selbst gebaut haben?
Ja. Wir brauchen Lesezugriff auf den Quellcode und jemanden aus Ihrem Team für Rückfragen.
Wie bleibt die Dokumentation aktuell?
Am besten liegt sie neben dem Code und wird mit jeder Änderung mitgepflegt. Wir richten sie so ein und zeigen Ihrem Team, wie das geht.
