Textvariablen in der Benutzerdokumentation
Autoren von Dokumentationen stehen oft vor dem Problem, denselben Textabschnitt mehrfach verwenden zu müssen. In solchen Fällen greifen sie häufig zu naheliegenden Lösungen – Strg+C, Strg+V oder sie geben die benötigten Informationen jedes Mal aufs Neue ein.
Um sich wiederholende Arbeiten beim Schreiben der Dokumentation zu vermeiden, bietet Dr.Explain eine Funktion, die Ihre Produktivität erheblich steigert: Text-Makrovariablen. Sie sind nützlich, wenn Sie in Ihrem Handbuch immer wieder dieselben Textteile verwenden, wie Firmenname, Produktname, Kontaktdaten und so weiter. Variablen sind besonders hilfreich, wenn ein Text, der regelmäßig geändert wird, oft geschrieben werden muss – zum Beispiel die Version der zu dokumentierenden Software.
Wie arbeiten Makrovariablen in Dr.Explain?
Angenommen, Sie müssen im Handbuch mehrfach die Programmversion oder eine E-Mail-Adresse nennen. Anstatt sie jedes Mal auszuschreiben – definieren Sie eine Variable. Beim nächsten Mal müssen Sie den Text nicht erneut eingeben, sondern wählen einfach die Variable mit dem passenden Wert aus.
Wenn Sie die Versionsnummer oder die Kontakt-E-Mail-Adresse im gesamten Projekt ändern müssen – aktualisieren Sie den Wert der Variable in den Projekteinstellungen. Dr.Explain übernimmt die Änderungen automatisch auf allen Seiten, die diese Variable im Text enthalten.
Um Variablen zu Ihrem Projekt hinzuzufügen, klicken Sie auf das entsprechende Symbol in der Symbolleiste oder öffnen Sie den Abschnitt 'Variablen' in den Projekteinstellungen. Geben Sie dann einen Namen für die Variable und anschließend ihren Wert ein.
Auf diese Weise sehen Sie bei der Arbeit am Projekt im Editor die Namen der Variablen, während beim endgültigen Export ihre aktuellen Werte eingesetzt werden.
Beispiele für mit Dr.Explain erstellte Benutzerdokumentationen
Unten finden Sie eine Auswahl von Screenshots mit einigen Beispielen, die die Möglichkeiten des Programms veranschaulichen.
Welche Vorteile bieten sich Ihnen mit Dr.Explain?
- Wenn Sie die Produktversion in allen Abschnitten aktualisieren müssen – genügt es, den Wert der Variable einmal zu ändern. Sie müssen nicht den gesamten Text durchsuchen und jede Erwähnung manuell korrigieren.
- Wenn mehrere Autoren an der Dokumentation arbeiten – die Verwendung von Variablen stellt sicher, dass alle dieselben Bezeichnungen, Kontaktdaten und Versionen verwenden. Inkonsistenzen sind ausgeschlossen.
- Wenn Sie Dokumentation für verschiedene Kunden oder Produktversionen erstellen – kombinieren Sie Variablen mit der bedingten Ausgabe, um verschiedenen Zielgruppen unterschiedliche Inhalte anzuzeigen.
- Weniger Routine – mehr Kreativität. Gewinnen Sie Zeit von mechanischer Arbeit und konzentrieren Sie sich auf die Qualität der Inhalte.
Für wen ist Dr.Explain geeignet?
Dr.Explain eignet sich sowohl für große als auch für kleine Organisationen, für Einsteiger und für erfahrene Spezialisten. Die Einfachheit und Benutzerfreundlichkeit der Werkzeuge erfordern keine lange Einarbeitungszeit, und die Vorlagenauswahl ermöglicht eine deutliche Zeitersparnis bei der Erstellung qualitativ hochwertiger Hilfesysteme.
- Wenn Sie regelmäßig Kontaktdaten, Produktversionen oder Namen aktualisieren – Variablen ersparen Ihnen, dieselbe Änderung in jedem Abschnitt manuell vornehmen zu müssen.
- Wenn mehrere Autoren an einem Dokument arbeiten – einheitliche Variablen gewährleisten Synchronität und schließen Fehler aus.
- Wenn Sie verschiedene Versionen der Dokumentation für unterschiedliche Kunden erstellen – Variablen in Kombination mit bedingter Ausgabe ermöglichen eine Personalisierung der Inhalte, ohne Projekte duplizieren zu müssen.
Nutzer über die Arbeit mit Makrovariablen in Dr.Explain
'Wir mögen die Variablen in Dr.Explain sehr, da sie es uns ermöglichen, die Dokumentation in einem einzigen Projekt zu versionieren. Benutzer können leicht erkennen, dass sie die neueste Version des Dokuments vor sich haben.'
David Swindon, IT-Direktor der Trustco Group Holdings
'Da Dr.Explain speziell für die Arbeit mit Dokumentation entwickelt wurde, hat es den gesamten Prozess erheblich vereinfacht. Zum Beispiel Suche, Indexierung, Hyperlinks usw.'
Mike McLaughlin, Einzelentwickler bei Champion Software
Häufig gestellte Fragen (FAQ)
Kann man Variablen in Tabellen, Bildunterschriften und anderen Elementen verwenden?
Ja. Variablen funktionieren in jedem Textfeld – im normalen Text, in Tabellen, Bildunterschriften, in Abschnittsüberschriften usw.
Funktionieren Variablen beim Export in alle Formate (PDF, CHM, HTML)?
Ja. Beim Export in jedes beliebige Format (PDF, DOCX, CHM, HTML) werden die Variablen durch ihre aktuellen Werte ersetzt. Im fertigen Dokument sieht der Benutzer den endgültigen Text, nicht die Variablennamen.
Sieht der Benutzer in der fertigen Dokumentation, dass Variablen verwendet wurden?
Nein. Im exportierten Dokument (PDF, CHM, HTML) sieht der Benutzer nur die endgültigen Werte. Die Variablen selbst verbleiben im Projekt und sind in der endgültigen Version nicht sichtbar.
Besteht die Möglichkeit, bei bestimmten Fragen Ihren Support zu kontaktieren?
Ja, die besteht.
Gibt es Video-Tutorials für die Arbeit mit Ihrem Programm?
Ja, gibt es. Besuchen Sie unser Profil auf Youtube.