Dokumentation ist vielfältig.

Die folgenden Dokumentationstypen kann ich nach Ihren Vorstellungen umsetzen:

Projektdokumentation

Wenn Sie für die Ausarbeitung eines Pflichtenheftes, einer Systembeschreibung oder eines ähnlichen Dokumentes Unterstützung im Texten und im Aufbereiten der Informationen benötigen, kann ich Ihnen als Expertin für Sprache in der Software mit meiner langjährigen Erfahrung behilflich sein.

Benutzerdokumentation

Online-Hilfen und Benutzerhandbücher richten sich an Ihre Endbenutzer und begleiten diese bei allen Anwendungsschritten. Neben der grundlegenden Bedienungsanleitung können auch Tutorials, Frequently Asked Questions oder Glossare eingebunden werden.

Grafiken wie Bildschirmabbildungen oder Diagramme erhöhen die Verständlichkeit der Texte. Verlinkungen stehen sowohl in PDFs als auch in allen Formaten der Online-Hilfen zur Verfügung.

Spezialisierte Tools wie MadCap Flare oder Doc-to-Help bieten vielfältige Möglichkeiten, die Inhalte an unterschiedliche Benutzergruppen anzupassen. Die Texte des Dokumentationsprojektes müssen dadurch nur an einer Stelle gewartet werden.

Mögliche Formate sind:

PDF
Compiled HTML Help
WebHelp (HTML 5)
eBook

Wenn Sie weitere Formate benötigen, kontaktieren Sie mich bitte.

Technische Dokumentation

Installations- und Administrationshandbücher wenden sich meistens an eine technisch orientierte Benutzergruppe. Sie beinhalten neben einer Auflistung der Systemanforderungen häufig eine Beschreibung der Standardbibliotheken und der Schnittstellen. Die Beschreibung der Installation, der Updates und der Deinstallation erfolgt häufig in Form von Schritt-für-Schritt-Anweisungen.

Darüber hinaus sind oft auch weiterführende Dokumente zu Formaten, Datentypen, Datenstrukturen oder Schnittstellen erforderlich, bei deren Erstellung ich Sie ebenfalls unterstützen kann.