Zum Inhalt springen
For Sellers

Dokumentation, die Support-Tickets für Code-Produkte reduziert

Wie Sie Softwaredokumentation für Kunden schreiben, die Ihren Quellcode kaufen: die sechs Dokumente, die jedes Produkt braucht, eine Vorlage für die Installationsanleitung, Einträge zur Fehlerbehebung rund um echte Fehlermeldungen und ein monatlicher Ablauf, der Tickets in Dokumentation verwandelt.

• Nov 17, 2026 • 11 Min. Lesezeit
Dokumentation, die Support-Tickets für Code-Produkte reduziert

Die meisten Support-Tickets zu Quellcode-Produkten betreffen keine Bugs. Es sind Installationsprobleme, Konfigurationsfragen und Anfragen nach dem Muster „Wie ändere ich X?“, die ein paar gut platzierte Seiten beantwortet hätten. Gute Softwaredokumentation für Kunden ist um genau diese Fragen herum aufgebaut: was der Käufer braucht, um die App zu installieren, zu konfigurieren, zu nutzen, anzupassen, zu aktualisieren und zu reparieren, wenn etwas schiefgeht.

Dokumentation beeinflusst auch, ob überhaupt gekauft wird. Sie ist eines der Vertrauenssignale, die in unserem Leitfaden So verkaufen Sie den Quellcode Ihrer Web-App oder Ihres SaaS beschrieben werden, und die Prüfer auf AppTrovo achten auf klare Installations- und Bedienungsanleitungen, bevor ein Produkt gelistet wird. Dieser Leitfaden zeigt Ihnen, was Sie schreiben sollten, in welcher Reihenfolge und wie Sie die Dokumentation mit fast keinem Zusatzaufwand aktuell halten.

Das Ziel sind nicht mehr Seiten. Das Ziel sind weniger Tickets pro Verkauf – genau das macht eine einmalige Lizenz auf Dauer profitabel.

Welche Dokumente braucht ein Code-Produkt?

Käufer von Quellcode kommen mit unterschiedlichen Zielen zu unterschiedlichen Zeitpunkten. Trennen Sie Ihre Dokumentation nach Zielen, damit jeder Leser seine Antwort schnell findet. Das Diátaxis-Framework ist ein bekanntes Modell für diese Aufteilung in Tutorials, Anleitungen, Referenz und Erklärung. Für eine verkaufsfähige Web-App decken sechs Dokumente fast alles ab:

DokumentFrage des LesersVerhindert Tickets wie
README / SchnellstartWas ist das, und wie bringe ich es zum Laufen?„Wo fange ich an?“, „Welche Datei lade ich hoch?“
InstallationsanleitungWie installiere ich es Schritt für Schritt auf meinem Server?„Leere Seite nach dem Upload“, „Fehler bei der Datenbankverbindung“
KonfigurationsreferenzWas bewirkt jede Einstellung und jede Umgebungsvariable?„E-Mails werden nicht versendet“, „Wie ändere ich die Währung?“
BenutzerhandbuchWie erledige ich eine Aufgabe in der App?„Wie füge ich einen Mitarbeiter hinzu?“, „Wo sind die Berichte?“
AnpassungsleitfadenWie ändere ich den Code sicher?„Wie ändere ich das Logo?“, „Wie füge ich ein Feld hinzu?“
Fehlerbehebung und Upgrade-HinweiseEtwas ist kaputt, oder ich möchte die neue Version„500-Fehler nach dem Update“, „Queue-Jobs laufen nicht“

Liefern Sie die Dokumentation im Download mit (ein Ordner docs/ oder eine HTML-Datei) und veröffentlichen Sie dieselben Inhalte online. Käufer, die nach einer Fehlermeldung suchen, finden eine öffentliche Seite; Käufer auf einem Server ohne Internetzugang können trotzdem die lokale Kopie lesen.

Beginnen Sie mit einer README für Käufer

Die README Ihres Repositorys haben Sie vermutlich für sich selbst geschrieben. Eine README für Käufer beantwortet auf dem ersten Bildschirm andere Fragen:

  1. Was das ist, in einem Satz.
  2. Voraussetzungen: Sprachversion, Erweiterungen, Datenbank, Cron, Queue sowie alle kostenpflichtigen Drittanbieterdienste.
  3. Was in der ZIP-Datei steckt: welcher Ordner hochgeladen wird, welcher die Dokumentation enthält und welcher optional ist (Designdateien, Beispieldaten).
  4. Der schnellste Weg zur laufenden App: fünf bis zehn Zeilen mit einem Link zur vollständigen Installationsanleitung.
  5. Standard-Logins, die das Installationsprogramm anlegt, mit dem Hinweis, sie zu ändern.
  6. Wo es Hilfe gibt: Link zur Dokumentation, wie man ein Support-Ticket eröffnet und was es enthalten sollte.
  7. Version und Link zum Changelog.

Vorlage für die Installationsanleitung

Die Installationsanleitung verhindert mehr Tickets als alles andere zusammen. Schreiben Sie sie, indem Sie Ihr Produkt auf einem frischen Server installieren und dabei mitschreiben – niemals aus dem Gedächtnis. Verwenden Sie diese Struktur:

  1. Bevor Sie beginnen. Eine Checkliste, die der Käufer abhaken kann: Serverzugang, PHP- oder Runtime-Version, benötigte Erweiterungen, eine Datenbank und ein Benutzer mit vollen Rechten darauf, eine Domain, die auf den Server zeigt, ein SSL-Zertifikat und die Möglichkeit, einen Cronjob einzurichten.
  2. Dateien hochladen. Sagen Sie genau, welcher Ordner wohin gehört und welcher Ordner das Web-Root sein muss (bei einer Laravel-App public/). Fügen Sie einen Hinweis für Shared Hosting hinzu, falls sich das Web-Root nicht ändern lässt.
  3. Abhängigkeiten installieren, falls sie nicht mitgeliefert werden, mit den genauen Befehlen, etwa composer install --no-dev --optimize-autoloader.
  4. Die Umgebungsdatei anlegen. Kopieren Sie .env.example nach .env und listen Sie die Werte auf, die geändert werden müssen.
  5. Dateiberechtigungen setzen. Nennen Sie die Verzeichnisse, die beschreibbar sein müssen, zum Beispiel storage/ und bootstrap/cache/, und erklären Sie den Grund, statt 777 zu empfehlen.
  6. Das Installationsprogramm oder die Migrationen ausführen. Zeigen Sie, was jeder Bildschirm des Installationsprogramms abfragt, einschließlich des Schritts für den Lizenzschlüssel.
  7. Geplante Aufgaben und Queues einrichten. Geben Sie die genaue Cron-Zeile an und erklären Sie, wie Queue-Worker gestartet oder überwacht werden.
  8. Erster Login und erste Aufgaben. Standard-Zugangsdaten, die ersten drei Einstellungen, die geändert werden sollten, und wie man eine Test-E-Mail versendet.
  9. Die Installation überprüfen. Eine kurze Liste der Dinge, die jetzt funktionieren sollten, etwa „das Dashboard lädt“, „eine Test-E-Mail kommt an“, „die geplante Aufgabe erscheint im Log“.
  10. Wenn etwas schiefgegangen ist: Links zu den fünf häufigsten Installationsfehlern auf Ihrer Seite zur Fehlerbehebung.

Ergänzen Sie für jedes gängige Hosting-Setup, das Sie unterstützen, einen eigenen kurzen Abschnitt: ein VPS mit Nginx, ein VPS mit Apache, Shared Hosting mit cPanel, Docker. Wenn Sie eines davon nicht unterstützen, sagen Sie das. Käufer können den allgemeinen Ablauf auch aus Leitfäden wie So installieren Sie eine Laravel-Web-App auf einem VPS lernen, aber Ihre Anleitung muss trotzdem die spezifischen Schritte Ihres Produkts abdecken.

Schreiben Sie eine Konfigurationsreferenz, nicht nur Kommentare in der .env

Kommentare in .env.example helfen Entwicklern, aber viele Käufer sind Unternehmer oder Junior-Entwickler. Eine Referenztabelle beantwortet an einer Stelle die Frage „Was bewirkt das, und wann ändere ich es?“.

VariableStandardwertWas sie bewirktWann Sie sie ändern
APP_URLhttp://localhostBasis-URL für Links und E-MailsImmer; setzen Sie sie auf Ihre echte Domain mit https
MAIL_MAILERlogWie E-Mails versendet werdenVor dem Livegang auf smtp oder Ihren Anbieter setzen
QUEUE_CONNECTIONsyncOb Hintergrundjobs sofort oder in einem Worker laufenAuf stark frequentierten Websites database oder redis verwenden und einen Worker betreiben
APP_TIMEZONEUTCZeitzone für Datumsangaben und geplante AufgabenAuf die Zeitzone Ihres Unternehmens setzen

Die Tabelle oben ist ein Beispiel; dokumentieren Sie jede Variable, die Ihr Produkt ausliest. Machen Sie dasselbe für die Einstellungsseiten in der App: was jede Einstellung verändert und welcher Standardwert sicher ist.

Fehlerbehebung: Schreiben Sie Einträge rund um echte Fehlermeldungen

Käufer suchen nach dem genauen Text, den sie sehen. Eine Seite zur Fehlerbehebung, die genau diese Zeichenketten als Überschriften verwendet, wird von Suchmaschinen und von der Suche auf der Website des Käufers gefunden. Verwenden Sie für jeden Eintrag dieses Format:

Fehler: SQLSTATE[HY000] [2002] Connection refused

Was er bedeutet: Die App kann den Datenbankserver nicht erreichen.

Häufige Ursachen: falscher DB_HOST oder DB_PORT; der Datenbankdienst läuft nicht; der Host akzeptiert nur Verbindungen von localhost.

So beheben Sie ihn: Prüfen Sie die Werte in der .env, vergewissern Sie sich, dass die Datenbank läuft, versuchen Sie 127.0.0.1 statt localhost und leeren Sie anschließend den Konfigurations-Cache.

Beginnen Sie mit den Fehlern, die Sie bereits kennen: eine weiße Seite bei ausgeschaltetem Debug-Modus, der 500-Fehler nach dem Upload, Berechtigungsfehler im Storage, die fehlende PHP-Erweiterung, fehlgeschlagene Mail-Authentifizierung, ein nicht laufender Cron und fehlgeschlagene Lizenzprüfungen. Ergänzen Sie dann jedes Mal einen neuen Eintrag, wenn ein Ticket einen neuen Fehler zutage fördert.

Anpassungsleitfaden: Beantworten Sie „Wie ändere ich X?“

Anpassungswünsche sind die zweitgrößte Quelle für Tickets, und viele Verkäufer beantworten sie für immer einzeln. Dokumentieren Sie die zehn häufigsten Änderungen ein einziges Mal:

  • Logo, Farben und App-Namen ändern.
  • E-Mail-Vorlagen und Benachrichtigungstexte bearbeiten.
  • Eine Sprache oder einen Übersetzungstext hinzufügen oder bearbeiten.
  • Ein Feld zu einem Formular und zur Datenbank hinzufügen.
  • Einen Menüpunkt oder eine Seite hinzufügen.
  • Währung, Datumsformat und Zahlenformat ändern.
  • Einen anderen Zahlungs-, SMS- oder E-Mail-Anbieter anbinden.
  • Eine Rolle oder Berechtigung hinzufügen.

Zeigen Sie für jede Änderung, wo die Datei liegt, was zu ändern ist und wie die Änderung bei künftigen Updates erhalten bleibt. Dieser letzte Punkt ist wichtig: Wenn Käufer Kerndateien bearbeiten, wird jedes Update zu einem Support-Ticket. Verweisen Sie sie stattdessen auf Erweiterungspunkte, Override-Ordner oder die Konfiguration. Unser Leitfaden zu Support, Updates und Versionierung erklärt, wie Sie Releases so gestalten, dass angepasste Installationen aktualisiert werden können.

Verwandeln Sie Tickets jeden Monat in Dokumentation

Dokumentation veraltet und deckt beim ersten Versuch nie alles ab. Ein einfacher monatlicher Ablauf hält sie nützlich:

  1. Versehen Sie jedes Ticket mit einer Kategorie: Installation, Konfiguration, Nutzung, Anpassung, Bug, Vorverkauf, Sonstiges.
  2. Zählen Sie einmal im Monat die Kategorien. Wählen Sie die drei häufigsten Fragen aus, die keine Bugs sind.
  3. Schreiben oder verbessern Sie die Seite, die jede dieser Fragen beantwortet hätte, und verwenden Sie in der Überschrift die Worte des Käufers.
  4. Beantworten Sie künftige Tickets mit einem Link und einer einzeiligen Zusammenfassung. Wenn der Link das Problem nicht löst, muss die Seite überarbeitet werden.
  5. Verbessern Sie das Produkt, wenn dieselbe Verwirrung immer wieder auftritt. Eine klarere Fehlermeldung oder eine Prüfung im Installationsprogramm ist besser als jedes Dokument.

Ein anschauliches Beispiel: Ein Verkäufer, der 40 Tickets im Monat erhält und feststellt, dass 15 davon die E-Mail-Konfiguration betreffen, kann die meisten davon in der Regel mit einer guten Seite und einem Installationsschritt beseitigen, der eine Test-E-Mail versendet.

Lassen Sie das Produkt sich selbst dokumentieren

Die beste Dokumentation ist die, die der Käufer nie öffnen muss:

  • Prüfungen im Installationsprogramm, die PHP-Version, Erweiterungen, beschreibbare Ordner und die Datenbankverbindung testen und Fehler in verständlicher Sprache erklären.
  • Hilfreiche Fehlermeldungen, die sagen, was als Nächstes zu tun ist („Der Mailserver hat die Anmeldung abgelehnt. Prüfen Sie MAIL_USERNAME und MAIL_PASSWORD in den Einstellungen“).
  • Eine Systemstatusseite im Admin-Bereich, die Versionen, Queue-Status, den letzten Cron-Lauf und die Speicherberechtigungen anzeigt. Käufer können einen Screenshot davon machen, wenn sie ein Ticket eröffnen.
  • Hilfetexte direkt neben Einstellungen, die leicht missverstanden werden.
  • Leere Zustände, die den nächsten Schritt erklären („Noch keine Mitarbeiter. Fügen Sie Ihren ersten Mitarbeiter hinzu“).

Stilregeln, die Dokumentation leichter verständlich machen

  • Schreiben Sie nummerierte Schritte für alles, was in einer Reihenfolge erledigt wird – eine Aktion pro Schritt.
  • Zeigen Sie genaue Befehle und genaue Pfade, und sagen Sie, wo sie ausgeführt werden.
  • Nennen Sie nach wichtigen Schritten das erwartete Ergebnis, damit Leser erkennen, wenn etwas schiefgegangen ist.
  • Verwenden Sie Screenshots für Einstellungsseiten, und aktualisieren Sie sie, wenn sich die Oberfläche ändert.
  • Schreiben Sie in einfachem US-Englisch mit kurzen Sätzen; viele Käufer lesen über ein Übersetzungstool.
  • Versionieren Sie die Dokumentation. Kennzeichnen Sie Abschnitte, die nur für bestimmte Versionen gelten, und führen Sie Upgrade-Hinweise für jedes Release.

Die kostenlosen Dokumentationsprinzipien von Write the Docs sind eine gute Checkliste für Klarheit und Struktur.

Dokumentations-Checkliste vor dem Einreichen

  1. Die README beantwortet, was das Produkt ist, welche Voraussetzungen gelten, was in der ZIP-Datei steckt, den Schnellstart, die Standard-Logins und wo es Hilfe gibt.
  2. Die Installationsanleitung ist auf einem frischen Server getestet und enthält einen Abschnitt für jedes unterstützte Hosting-Setup.
  3. Die Konfigurationsreferenz deckt jede Umgebungsvariable und jede wichtige Einstellung ab.
  4. Das Benutzerhandbuch deckt die Hauptaufgaben für jede Rolle ab.
  5. Der Anpassungsleitfaden deckt die zehn häufigsten Änderungen ab und erklärt, wie sie bei Updates erhalten bleiben.
  6. Die Seite zur Fehlerbehebung verwendet genaue Fehlermeldungen als Überschriften.
  7. Changelog und Upgrade-Hinweise sind enthalten.
  8. Die Dokumentation liegt im Download und online vor.

Gleichen Sie sie vor dem Einreichen mit der Checkliste für die Produkteinreichung und den Code-Standards von AppTrovo ab. Sobald Ihre Dokumentation fertig ist, kann Ihr Angebot im Abschnitt „Voraussetzungen“ darauf verlinken, was auch Käufern vor dem Kauf hilft.

Häufig gestellte Fragen

Was sollte Softwaredokumentation für Kunden enthalten?

Mindestens: eine README, eine Installationsanleitung, eine Konfigurationsreferenz, ein Benutzerhandbuch, einen Anpassungsleitfaden und eine Seite zur Fehlerbehebung mit Upgrade-Hinweisen. Jedes Dokument beantwortet eine andere Frage, halten Sie sie also getrennt und verlinken Sie untereinander.

Sollte die Dokumentation in der ZIP-Datei oder online sein?

Beides. Die Kopie in der ZIP-Datei passt immer zu der Version, die der Käufer hat. Die Online-Kopie ist durchsuchbar, lässt sich leicht in Support-Antworten verlinken und kann zwischen Releases aktualisiert werden. Machen Sie deutlich, für welche Version jede Online-Seite gilt.

Wie detailliert sollte eine Installationsanleitung sein?

So detailliert, dass jemand, der schon einmal eine Web-App installiert hat, aber noch nie Ihre, ohne Rückfrage bei Ihnen fertig wird. Nennen Sie genaue Befehle, Pfade, benötigte Berechtigungen und das erwartete Ergebnis nach jedem wichtigen Schritt. Testen Sie sie bei jedem Release, das die Voraussetzungen ändert, auf einem frischen Server.

Woher weiß ich, welche Dokumentation ich zuerst schreiben sollte?

Sehen Sie sich Ihre Support-Tickets und Fragen vor dem Kauf an. Installation und Konfiguration stehen meist an erster Stelle, gefolgt von den häufigsten Anpassungswünschen. Wenn Sie noch keine Tickets haben, installieren Sie das Produkt selbst auf einem frischen Server und dokumentieren Sie jede Stelle, an der Sie nachdenken mussten.

Reduziert gute Dokumentation wirklich Rückerstattungen?

Fehlgeschlagene Installationen und enttäuschte Erwartungen sind häufige Gründe, warum Käufer eine Rückerstattung verlangen, und klare Voraussetzungen sowie eine getestete Installationsanleitung adressieren beides. Rückerstattungen auf AppTrovo richten sich nach der Rückerstattungsrichtlinie, aber ein Problem zu verhindern ist immer günstiger, als die Anfrage zu bearbeiten.