Optimieren Sie Ihre Dokumentationsbemühungen mithilfe dieser fünf Apps

Wenn Sie ein System- oder Netzwerkadministrator oder Programmierer sind, wissen Sie, dass eine der mühsamsten Übungen, die Sie ausführen können, die Dokumentation Ihrer Systeme, Netzwerke oder Projekte ist. Ohne die richtige Dokumentation können Sie auch alles erstellen und vergessen, wie Sie es getan haben - denn diese Informationen werden aus Ihrem Gedächtnis verschwinden. Oder schlimmer noch, Sie werden von Ihren Pflichten entbunden, und diejenigen, die Ihre Schuhe füllen, wissen nicht, was Sie getan haben. Jede Situation wird sich schlecht auf Sie auswirken. Um dies zu vermeiden, müssen Sie Ihre Dokumentation erstellen.

Aber wie geht man am besten damit um? Öffnen Sie einfach ein Textverarbeitungsprogramm und geben Sie zufällige Informationen ein? Oder verwenden Sie eine Anwendung, um den Prozess zu vereinfachen? Es ist sinnvoll, eine spezielle App zu nutzen, aber welche sollten Sie verwenden? Ich habe eine Liste mit fünf nützlichen Apps erstellt, die Ihre Dokumentationsaufgaben vereinfachen können. Sie sind entweder aufgabenspezifisch oder allgemein genug, um in den meisten Situationen zu helfen.

Hinweis: Dieser Artikel ist auch als Fotogalerie verfügbar.

1: Sphinx

Sphinx ( Abbildung A ) ist ein textbasiertes Tool, das sich an Personen richtet, die ein solides Verständnis für die Funktionsweise der Programmdokumentation haben. Es ist für Linux, Mac und Windows verfügbar und enthält Funktionen, die Ihnen den Einstieg sowie die Erstellung Ihrer Dokumentation erleichtern. Der erste Schritt besteht darin, den Sphinx-Schnellstart auszuführen, der die Verzeichnisstruktur für Ihre Dokumentation erstellt. Sie erhalten zahlreiche Fragen (in den meisten Fällen funktionieren die Standardantworten) und werden dann angewiesen, Ihre Masterdatei zu füllen und andere Dokumentationsquelldateien zu erstellen. Danach führen Sie den Befehl make builder aus, um die Dokumente zu erstellen.

Abbildung A.

2: Scribus

Scribus ( Abbildung B ) wurde nicht speziell für die Erstellung von Dokumentationen entwickelt, sondern ist ein leistungsstarkes Seitenlayout-System, das effektive Ergebnisse erzielen kann. Anstatt gegen ein Textverarbeitungsprogramm zu kämpfen (eines, bei dem Sie sich die Haare ausreißen, weil es sich nicht um Zeilenumbrüche kümmert oder eine korrekte Bildplatzierung ermöglicht), möchten Sie ein Tool wie Scribus verwenden. Mit Scribus können Sie genau steuern, was wohin geht - Textfelder, Bilder, Ebenen ... Sie nennen es. Scribus ist für Linux, Mac und Windows verfügbar und kann professionell aussehende, vierfarbige, druckertaugliche PDF-Dokumente erstellen, die Sie an Mitarbeiter und Kunden verteilen können.

Abbildung B.

3: Dia

Dia ( Abbildung C ) ist ein kostenloser Open-Source-Diagrammeditor, mit dem Sie einfache Systemdiagramme erstellen können, ohne lernen zu müssen, eines der komplizierteren Diagrammwerkzeuge zu verwenden. Dia bietet eine große Auswahl an Objekten für Ihre Diagramme, von Standardnetzwerkobjekten über Flussdiagrammformen bis hin zur Kybernetik. Die Benutzeroberfläche ist vollständig per Drag & Drop erstellt, sodass Sie in der Lage sein sollten, Diagramme schnell zu starten und zu beenden. Sobald Sie Ihr Diagramm fertiggestellt haben, können Sie es im nativen Dia-Format speichern oder als Bilddatei exportieren (die Sie dann in Scribus importieren können).

Abbildung C.

4: Geany

Geany ( Abbildung D ) ist nicht nur ein einfacher plattformübergreifender Texteditor. Es ist ein benutzerfreundlicher grafischer Texteditor, der Ihre Dokumentationsaufgaben im XML-Format erledigen kann (denken Sie an DocBook). Geany bietet unter anderem Syntaxhervorhebung, Code-Faltung, automatische Vervollständigung von Symbolnamen, automatisches Schließen von XML- und HTML-Tags sowie Tipps zum Aufrufen. Es unterstützt auch eine große Liste von Dateitypen.

Abbildung D.

Sie können Projekte in Geany erstellen und pro Projekt Dateitypen, Codierungen und Zeilenenden angeben. Obwohl Geany mehr auf das Codieren von Projekten ausgerichtet ist, ist es ein hervorragendes Tool, mit dem Sie Ihre Dokumentation erstellen können. Es gibt auch ein Plug-In namens GeanyGenDoc, das automatisch eine Dokumentation basierend auf dem Quellcode generiert. Weitere Informationen zu GeanyGenDoc finden Sie im Online-Handbuch.

5: Kaliber

Calibre ( Abbildung E ) ist bereit, Ihre Dokumentation in ein Ereader-Format zu konvertieren. Die Dokumentation kann oft unglaublich langwierig sein, und Sie möchten sie nicht überall hin mitnehmen müssen. Warum generieren Sie nicht eine .MOBI- oder .EPUB-Datei aus Ihrer ursprünglichen .HTML- oder .DOC-Dokumentation, damit Sie diese Informationen auf einem Ereader, Tablet oder Smartphone haben können? Mit Calibre können Sie auch ein praktisches Inhaltsverzeichnis erstellen, um die Navigation in der Dokumentation zu vereinfachen.

Abbildung E.

Den Aufwand wert

Dokumentation muss kein Albtraum sein. Mit den richtigen Tools können Sie Ihre Dokumentation auf den neuesten Stand bringen, sodass andere, wenn sie übernehmen müssen, über alle Informationen verfügen, die sie benötigen, um die Arbeit effizient und genau zu erledigen. Ohne Dokumentation wird jede Aufgabe mehr Zeit und Geld kosten.

Lesen Sie auch ...

Fünf kostenlose webbasierte Tools, mit denen Diagramme zum Kinderspiel werden

Fünf kostenlose Katalogisierungsanwendungen

Fünf Diagnosetools für Ihr tragbares Tech-Toolkit

Fünf kostenlose Tools für Brainstorming-Lösungen und Innovationen

Fünf kostenlose Apps, die PC-Informationen sammeln

Deine Tipps

Dokumentieren Sie? Wenn ja, welche Tools verwenden Sie, um den Prozess zu vereinfachen? Teilen Sie Ihre Empfehlungen mit anderen TechRepublic-Mitgliedern.

App der Woche Newsletter

Verschwenden Sie keine Sekunde mehr mit der Suche nach IT- und Business-Apps - wir haben alles für Sie. Unsere vorgestellte App der Woche kann Ihre Produktivität steigern, Ihre E-Mails sichern, Karriereziele verfolgen und vieles mehr. Donnerstags geliefert

Heute anmelden

© Copyright 2021 | pepebotifarra.com