Professionelle Dokumentation anfertigen

FISIPEDIA Doku-Turbo: Von Idee zu fertiger Seite mit Gemini und Rotlink

Dieses Tutorial zeigt Ihnen, wie Sie mit der Unterstützung eines KI-Assistenten (wie Google Gemini) und der effizienten Rotlink-Methode Ihre Dokumentationsprojekte für FISIPEDIA in HTML-Form schnell und professionell umsetzen können.

Was ist die Rotlink-Methode?

In MediaWiki wird ein Link zu einer noch nicht existierenden Seite als "Rotlink" (rot gefärbter Link) angezeigt. Klickt man auf einen Rotlink, gelangt man direkt zum Bearbeitungsformular für diese neue Seite. Dies ist eine sehr effiziente Methode, um neue Seiten zu erstellen, sobald man den Inhalt fertig hat.

Schritt 1: Die Idee und erste Notizen

Sie haben eine Idee für ein Thema, das Sie in FISIPEDIA dokumentieren möchten. Vielleicht haben Sie schon ein paar Stichpunkte, Code-Fetzen oder Teile einer alten Dokumentation.

• Beispiel-Idee: Eine Anleitung zur Installation von Nextcloud auf dem Synology NAS.
• Notizen/Fetzen: "Docker Image", "Volumes mounten", "Port 80/443", "Datenbank einrichten (MariaDB)", "Reverse Proxy".

Schritt 2: Gemini nutzen, um die Doku zu erstellen

Jetzt kommt der KI-Assistent ins Spiel. Füttern Sie Gemini mit Ihren Ideen und Notizen und bitten Sie ihn, daraus eine vollständige, strukturierte und HTML-formatierte Dokumentation zu erstellen.

2.1 Der effektive Prompt

Formulieren Sie Ihren Prompt so klar und detailliert wie möglich. Sagen Sie Gemini genau, was Sie brauchen:

<code>"Bitte erstelle eine vollständige und professionelle Dokumentation
    im HTML-Format für mein MediaWiki. Das Thema ist 'Installation von Nextcloud
    auf einem Synology NAS mit Docker'. Ich habe bereits folgende Stichpunkte:
    Docker Image, Volumes mounten, Ports (80/443), Datenbank (MariaDB), Reverse Proxy.
    Ergänze fehlende Schritte, korrigiere falsche Informationen und sorge für
    eine klare Struktur mit Überschriften und Absätzen. Mach es anfängerfreundlich."</code>

2.2 Überprüfung und Anpassung der Gemini-Ausgabe

Gemini wird Ihnen nun einen kompletten HTML-Code liefern.

1. Überprüfen Sie den Inhalt: Lesen Sie die generierte Dokumentation sorgfältig durch. Sind alle wichtigen Punkte enthalten? Ist die Reihenfolge logisch? Sind die technischen Details korrekt?
2. Spezifische Anpassungen: Ergänzen Sie Details, die nur für Ihr Setup relevant sind (z.B. spezifische Ordnerpfade auf Ihrem NAS, Versionen der Software etc.).
3. Formatierung für MediaWiki: Gemini liefert standardmäßiges HTML. MediaWiki versteht dies gut, aber für interne Links oder spezielle Wiki-Funktionen müssen Sie möglicherweise noch geringfügige Anpassungen vornehmen (z.B. <a href="#"> durch Zielseite ersetzen, wenn Sie auf andere Wiki-Seiten verlinken möchten).
4. Bilder planen: Überlegen Sie, wo Screenshots oder andere Bilder hilfreich wären. Diese können Sie später hochladen und über Wikitext einbinden (

   Datei:Bildname.jpg

   Bildunterschrift

   ).

Ein Beispiel-Prompt für Gemini zur Erstellung einer Doku.

Schritt 3: Die Rotlink-Methode für die FISIPEDIA

Sobald Sie den finalen HTML-Text von Gemini haben, erstellen Sie damit Ihre Wiki-Seite.

3.1 Erstellen des Rotlinks

1. Gehen Sie zu einer beliebigen bestehenden Seite in Ihrer FISIPEDIA (z.B. Ihrer Hauptseite oder einer Übersichtsseite).
2. Bearbeiten Sie diese Seite und fügen Sie einen Link zu Ihrer neuen Dokumentationsseite ein. Beispiel:

   <code>[[Nextcloud Installation auf Synology NAS]]</code>

        (Dieser Link ist rot, da die Seite noch nicht existiert.)
   

3. Speichern Sie diese Seite.

3.2 Die neue Seite erstellen und Inhalte einfügen

1. Klicken Sie auf den gerade erstellten roten Link (z.B. "Nextcloud Installation auf Synology NAS").
2. Sie gelangen nun direkt in den Bearbeitungsmodus der neuen Seite. Der Titel ist bereits korrekt gesetzt.
3. Fügen Sie den von Gemini generierten und von Ihnen angepassten kompletten HTML-Code in das Bearbeitungsfeld ein. MediaWiki kann diesen direkt verarbeiten.
4. Geben Sie eine Zusammenfassung Ihrer Bearbeitung ein (z.B. "Neue Dokumentation für Nextcloud Installation hinzugefügt").
5. Klicken Sie auf "Vorschau zeigen", um das Ergebnis zu überprüfen.
6. Wenn alles Ihren Vorstellungen entspricht, klicken Sie auf "Seite speichern".

Datei:MediaWiki-Rotlink.png

Ein roter Link in MediaWiki, der zur Erstellung einer neuen Seite einlädt.

Fazit

Durch die Kombination der schnellen Texterstellung durch KI-Assistenten wie Google Gemini und der effizienten Rotlink-Methode von MediaWiki können Sie innerhalb kürzester Zeit umfangreiche und gut formatierte Dokumentationsseiten für Ihre FISIPEDIA erstellen. Dies spart Ihnen viel Zeit und hilft, Ihr Wissen schnell zu teilen!