Sperren von Themen

Bei der Arbeit an der Dokumentation, allein oder im Team, besteht immer das Risiko, einen fertigen Abschnitt versehentlich zu ändern oder zu löschen. Die Sperrfunktion in Dr.Explain löst dieses Problem. Sie ermöglicht es, jeden beliebigen Abschnitt eines Projekts vor unerwünschten Änderungen zu schützen und so die Sicherheit Ihrer Inhalte zu gewährleisten.

Wie funktioniert das Sperren von Abschnitten in Dr.Explain?

Dr.Explain gewährleistet die Sicherheit Ihrer Inhalte, indem es Ihnen erlaubt, Themen vor versehentlichen Änderungen zu schützen. Konzentrieren Sie sich auf das Schreiben Ihrer Dokumentation, im Wissen, dass Ihre Inhalte geschützt sind, und nutzen Sie Status und Schlüsselwörter für effizientes Arbeiten.

Um einen Abschnitt zu sperren, klicken Sie mit der rechten Maustaste darauf und wählen Sie den Befehl 'Sperren'. Derselbe Menüpunkt ermöglicht es Ihnen, den Abschnitt zusammen mit allen darin enthaltenen Unterabschnitten zu sperren.

Um einen Abschnitt zu entsperren, klicken Sie mit der rechten Maustaste darauf und wählen Sie den Befehl 'Entsperren' (oder 'Aktuelles und Unterelemente entsperren').

Beispiele für mit Dr.Explain erstellte Benutzerdokumentationen

Nachfolgend finden Sie Screenshots von mit dem Programm erstellten Benutzerdokumentationen.

Welche Vorteile bieten sich Ihnen mit Dr.Explain?

• Schutz vor unbeabsichtigten Änderungen. Ein gesperrter Abschnitt kann weder bearbeitet noch gelöscht werden, solange Sie oder Ihre Kollegen die Sperre nicht aufheben.
• Sicherung der Integrität bei der Teamarbeit. Verhindert Situationen, in denen zwei Autoren gleichzeitig am selben Abschnitt arbeiten oder ein neuer Mitarbeiter versehentlich die fertige Arbeit eines anderen verändert.
• Flexible Sperrmöglichkeiten. Sie können entweder nur einen einzelnen Abschnitt oder gleich einen Abschnitt mitsamt aller seiner Unterabschnitte sperren.
• Visuelle Kennzeichnung. Gesperrte Abschnitte werden in der Baumstruktur des Projekts entsprechend gekennzeichnet, sodass der Schutzstatus sofort ersichtlich ist.
• Fokus auf dem Inhalt. Sie werden nicht durch die Überprüfung der Sicherheit bereits geschriebener Texte abgelenkt und können sich auf die Erstellung neuer Materialien konzentrieren.

In der Projektstruktur können Sie Abschnitten auch einen Status zuweisen, um so den Arbeitsfortschritt zu verfolgen, und Themen mit Schlüsselwörtern versehen – für eine bessere Navigation in der Dokumentation.

Für wen ist Dr.Explain geeignet?

Dr.Explain hat keine Einschränkungen hinsichtlich der Zielgruppe. Es ist ein universelles Werkzeug, das die Entwicklung erleichtert und beschleunigt. Wem kann es die Arbeit vereinfachen?

• Technischen Redakteuren, die im Team arbeiten. Das Sperren ist ein grundlegendes Werkzeug der Versionskontrolle bei der gemeinsamen Bearbeitung, um Versionskonflikte zu vermeiden.
• Autoren, die komplexe, mehrseitige Dokumentationen verfassen. Je größer das Projekt, desto höher das Risiko, versehentlich einen fertigen Abschnitt zu beschädigen. Die Sperrfunktion schützt das Ergebnis Ihrer Arbeit.
• Denjenigen, die Dr.Explain zur Vorbereitung finaler Versionen der Dokumentation (Releases) nutzen. Sperren Sie die Abschnitte, die der fertigen Produktversion entsprechen, damit sie unverändert bleiben.
• Leitern von Dokumentationsteams. Das Sperren ermöglicht eine klare Aufteilung der Verantwortungsbereiche und die Kontrolle darüber, welche Teile des Projekts in Arbeit und welche bereits abgeschlossen und geschützt sind.

Nutzer über die Arbeit mit Abschnitten in Dr.Explain

'Auch ohne Programmierkenntnisse können Sie ein Handbuch erstellen und im Internet veröffentlichen. Darüber hinaus können Sie den Status verschiedener Abschnitte einfach verwalten, was mehreren Bearbeitern ermöglicht, gleichzeitig Texte zu schreiben.'

Alessandro Calmo, Software-Koordinator der Firma Ala Data System

Häufig gestellte Fragen (FAQ)

Siehe auch

 
• Verwalten der Projektstruktur
• Stichwortverzeichnis
• Themenstatus