Softwaredokumentation erstellen

Bessere Softwaredokumentation für Ihre Anwendungen. So arbeiten wir

• Anforderungen analysieren. Gemeinsam analysieren wir die Anforderungen Ihrer Zielgruppen. Wir identifizieren die Aufgaben Ihrer Anwender:innen sowie die verwendeten Informationsarten, z. B. Handlungsanweisungen und Fehlerlösungen.
• Informationsarchitektur entwickeln. Wir erarbeiten eine Informationsarchitektur für Ihre Softwaredokumentation.
• Dokumente standardisieren. Wir unterstützen Sie bei der Standardisierung Ihrer Dokumentation: mit Standardstrukturen für die Informationsarten, einem Redaktionsleitfaden und Terminologie.
• Softwaredokumentation erstellen. In enger Zusammenarbeit mit Ihren Expert:innen erstellen wir Ihre Softwaredokumentation, in einem Redaktionssystem, mit einem Autorentool oder nach dem Docs-as-code-Ansatz.
• Screenshots erstellen. Wir erstellen Screenshots oder vereinfachte Grafiken (SUIs) und binden Sie in Ihre Dokumentation ein.
• UX-Texte erstellen. Wir unterstützen Sie beim UX-Writing und erstellen User-Interface-Texte für Ihre Anwendungen.
• Rechtliche Anforderungen einhalten. Wir erstellen Softwaredokumentation, die den aktuellen rechtlichen Anforderungen entspricht.
• Bei der Systemauswahl unterstützen. Wir unterstützen Sie bei der Auswahl eines Systems für die Veröffentlichung Ihrer Online-Dokumentation oder bei der Einrichtung eines Customer-Service-Portals oder Content-Delivery-Portals.

Weitere Informationen rund um das Thema Softwaredokumentation finden Sie auch in unseren FAQs.

FAQs – Häufig gestellte Fragen zum Thema Softwaredokumentation

Was macht gute Softwaredokumentation aus?

Softwaredokumentation beantwortet gezielt die Fragen der Anwender:innen und versetzt sie in die Lage, Ihr Produkt korrekt zu verwenden. Gute Softwaredokumentation ist verständlich, hält sich kurz und richtet sich nach den Bedürfnissen und Aufgaben der Anwender:innen.

In welcher Form stelle ich Softwaredokumentation zur Verfügung?

Softwaredokumentation wird in der Regel online ausgeliefert, entweder als Online-Hilfe mit dem Produkt oder in ein Webportal, z.  B. ein Customer-Service-Portal oder Dokumentationsportal. Welche Auslieferungsform Sie wählen, hängt von den Anforderungen Ihrer Anwender:innen und den technischen Eigenschaften der Software ab. Für eine Cloud-Software z. B. bietet sich die Auslieferung in ein Portal an.

Wie erstellt man zielgruppengerechte Softwaredokumentation?

Jede:r Anwender:in muss die für sie relevanten Informationen schnell und einfach finden. Bevor unsere Expert:innen anfangen zu schreiben, analysieren wir die Zielgruppen Ihrer Dokumentation, ihre Kenntnisse und die Aufgaben, die sie mit der Software erledigen. Auch analysieren wir ihren Wissensstand, d. h., ob es sich um Expert:innen oder Anfänger:innen handelt. An den Ergebnissen der Zielgruppenanalyse richten wir den Informationsgehalt und die Informationstiefe der Dokumentation aus.

Was ist Docs-as-code?

Docs-as-code ist ein Ansatz zur Erstellung und Bereitstellung von Softwaredokumentation. 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:

• Sie verwenden die gleichen Werkzeuge wie die Entwickler:innen, z. B. IDEs (integrated development environments), Versionskontrollsysteme und Werkzeuge für continuous integration und delivery.
• Sie verwenden die gleichen Methoden wie die Entwickler:innen, z. B. agiles Projektmanagement und Scrum.

Hier finden Sie weitere Informationen zu Docs-as-code:

• Unsere Leistung: Dokumentation automatisieren mit Docs-as-code
• Unsere Leistung: Entwicklerdokumentation erstellen

• Wissensartikel Docs-as-code

Wie finde ich heraus, welche Informationen meine Kundschaft benötigt?

Softwaredokumentation, insbesondere Dokumentation für Endanwender, ist stark aufgabenbasiert. Deswegen finden wir zunächst heraus, welche Aufgaben die Anwender:innen mit der Software ausführen. Wir sehen uns auch den Produktlebenszyklus einer Software an, von der Installation über die Konfiguration hin zur Wartung, und die Aufgaben, die die Anwender:innen innerhalb dieser Lebenszyklen ausführen. Diese Aufgaben können dann die Themen der Dokumentation repräsentieren.

Wo finde ich Beispiele für gute Softwaredokumentation?

Hier sind ein paar Beispiele für Softwaredokumentation, die uns gefallen:

Microsoft

• Gute Suchfunktion
• Einfaches Navigieren zum Produkt
• Gut strukturierte Anleitungen für Einsteiger und Fortgeschrittene
• Tipps für die Fehlerbehebung
• Community
• Schnelle Kontaktmöglichkeiten zum Support

Prezi

• Tutorials für Einsteiger und Fortgeschrittene
• Quick-Start-Guides
• Gut strukturierte Wissensdatenbank
• Produktforen – von anderen Nutzern lernen
• Prezi-Training für Einsteiger und Fortgeschrittene

Moodle

• Die Dokumentation der Open-Source-Software wird von der Community geschrieben und übersetzt. Die Dokumentation basiert auf MediaWiki, d. h. der Quelltext der Dokumentation liegt offen.
• Das Dashboard bietet wichtige Themen als Überblick
• Verfügt über eine gute Suchfunktion
• Kommentarmöglichkeit
• In verschiedenen Sprachen verfügbar
• Für Entwickler: Die Dokumentation wird in Markdown mit Docusaurus geschrieben.
• Die Quellen werden auf GitHub verwaltet und sind öffentlich.
• Die Dokumentationsaufgaben werden über Tickets verfolgt.