Dokumentation Erstellen

Erstellen von Dokumentation

Herausgeber Für die Erstellung und Bearbeitung der IT-Dokumentationsrahmen steht ein eigener Herausgeber zur Verfügung. Nach der Projektumsetzung wurde beschlossen, die endgültige Dokumentation bis Ende Juni zu erstellen. Entwickeln Sie Software-Dokumentationen, schreiben Sie Betriebsanleitungen, veröffentlichen Sie Anweisungen.

Allgemeine Bedingungen für die Erstellung Ihrer fachlichen Dokumentation - terminsicher, wirtschaftlich, verständlich.

Dein Artikel ist bereit. Nun erhebt sich die Frage: Wer gestaltet die technischen Unterlagen? - Zumindest denken Ihre Programmierer bereits an das nächste Jahr. Bei der Erstellung Ihrer technischen Dokumentation sollten Sie dieses Wissen dem Anwender so einfach wie möglich mitteilen. Falls Sie eine eigene Dokumentation erstellen und gestalten, finden Sie hier einige Tipps:

Bringen Sie sich in die Lage des Anwenders, der Ihr Projekt noch nicht gut kannte. Lernen Sie die Features der Software-Tools kennen, mit denen die Dokumentation erstellt wurde. Fordern Sie jetzt ein unverbindliches Preisangebot an! Ab wann sollte Ihre Technikdokumentation verfügbar sein? Fordern Sie ein Preisangebot für Ihre technischen Dokumentationen an!

IT-Dokumentation erstellen

Es steht ein eigener Redakteur für die Gestaltung und Editierung der IT-Dokumentationsrahmen zur Verfügun. Nachdem die Kopfzeile der IT-Dokumentation oder ein zugrundeliegender Punkt markiert wurde, erscheint das Ribbon der Itdokumentation. Klicken Sie auf die Taste Herausgeber, um den Herausgeber in einem separaten Dialogfenster zu öffnen. Es wird im rechten Fensterbereich eine Datenbankstruktur dargestellt, die alle vorhandenen IT-Dokumentationsrahmen aufzeigt.

Je nachdem, welcher Teilnehmer in der Datenbankstruktur selektiert wurde, stehen im Ribbon die entsprechenden Buttons zur Auswahl. Wenn z. B. eine Sicht gewählt ist, wird die Taste zur Lagenerstellung angezeigt. Verwenden Sie dieses Sichtfenster, um eine Voransicht der Unternehmensstrukturen anzuzeigen, sobald sich die Unternehmensstruktur ändert.

In einem ersten Arbeitsschritt bei der Dokumentation wird ein neuer Rahmen erstellt. Das ist die höchste Stufe dieser Dokumentation. Wahlweise entweder in der Baumstruktur oder über den Redakteur. Ist im Dokumentationsbereich die Rubrik IT-Dokumentation markiert, kann ein Rahmen für das entsprechende Unternehmen aufgesetzt werden. Klicken Sie auf die Taste New, um die Input-Maske zu öffnen.

Nach der Zuweisung eines Namens an das Gerüst kann dieser durch Anklicken der Taste Save erzeugt werden. Oder Sie können alle Elemente von Grund auf mit dem Redakteur erstellen. Nach der Auswahl der Rubrik IT-Dokumentation erscheint das RibbonIT-Dokumentation. Wenn Sie auf die Editiertaste klicken, öffnet sich ein eigenes Dialogfenster und über die Taste Add Framework können Sie ein weiteres Rahmenwerk erstellen.

Hier kann auch eine neue Sicht mit Hilfe des Dokumentationsbaums oder des Editors angelegt werden. Wählen Sie im Bearbeitungsprogramm für jeden Framework-Knoten Views aus und klicken Sie dann auf die Drucktaste Add View in der Menüband. Geben Sie in der Erfassungsmaske einen Dateinamen für die neue Sicht ein und klicken Sie dann auf Sichern.

Layer können nur im Bearbeitungsprogramm erzeugt werden. Nach der Erstellung können sie jedoch im Dokumentierungsbaum editiert werden. In diesem Fall wird im Datenexplorer eine erzeugte View selektiert und eine neue Layer durch Anklicken der Taste Add new layer erzeugt. Neben dem Dateinamen kann auch eine Farbwahl für die in der Darstellung verwendete Schicht getroffen werden.

Bei Auswahl einer Immobilie kann dieser Parameter für alle dieser Schicht zugewiesenen Objekte festgelegt werden. Wurden bereits Layer in einer anderen Sicht erzeugt, können diese Layer auch der derzeit ausgewählten Sicht über die Drucktaste Add Existing Layer zugewiesen werden. Nach der Auswahl einer Stufe oder eines Strukturelements kann über die Drucktaste Strukturelement hinzufuegen ein neuer Strukturbaustein erzeugt werden.

Bei der Auswahl einer Immobilie kann diese für alle Komponenten dieses Strukturelementes festgelegt werden. Die Drucktaste Add Elements eröffnet ein Dialogfenster, in dem Sie Artikel aus dem Bestandsbaum auswählen können, die inventarisiert oder von Hand erstellt wurden. Sie werden der gerade ausgewählten Stufe oder dem ausgewählten Bauelement beigefügt.

Wollen Sie später Elementen eine andere Schicht zuweisen, können Sie diese auch später verschieben. Für die Darstellung von Beziehungswissen müssen die einzelnen Komponenten noch untereinander verbunden sein. Dazu muss das zugehörige Segment selektiert und die entsprechenden Amtsvorgänger oder Rechtsnachfolger in der Gesamtübersicht selektiert werden. Wird das Originalobjekt durch Hinzufügen von Elementen entfernt, verbleiben die Objekte weiterhin in der Hierarchieebene.

Sollen auch diese Bestandteile ebenfalls entfernt werden, müssen sie aus der IT-Dokumentation entfernt werden. Nach dem Hinzufügen eines Objektes als Bestandteil wird es im Dialogfeld Verknüpfung von Elementen deaktivert, so dass es nicht mehr neu eingefügt werden kann. Wenn Sie das Messobjekt bewegen, kann es in der IT-Dokumentation nicht mehr zugewiesen werden und das Messobjekt ist im Dialogfeld Assign Elements weiterhin inaktiv. Daher kann das Messobjekt ein zweites Mal ergänzt werden.

Mehr zum Thema