1Was das KIT hervorbringt

Dieses Dokument ist eine sinngemäße Übersetzung. Maßgeblich ist das Originaldokument auf Französisch; Erweiterungen und Änderungen werden stets dort eingepflegt.

Sie beschreiben Ihr Thema einer künstlichen Intelligenz. Sie wendet bereits geschriebene Darstellungsregeln an und bringt drei Formate hervor: Word-Dateien, PDF und die Seiten einer Website.

Der Inhalt wird einmal erfasst; die drei Formate folgen daraus. Der Assistent der künstlichen Intelligenz — Claude, Gemini, Grok oder ein anderer — ist der Ihrer Wahl: das KIT legt die Regeln und die Produktionskette fest, es hängt von keinem Anbieter ab. Es verdeckt außerdem die Technik, und Sie widmen sich Ihrer Dokumentation.

Drei Fragen entscheiden sich vor der ersten Zeile: sie bestimmen den Aufbau des Inhalts, und sie später erneut aufzugreifen erzwingt ein Neuschreiben.

2Für wen schreiben Sie

Das Publikum bestimmt das Vokabular, den Grad der Ausführlichkeit und das, was als bekannt vorausgesetzt werden darf.

–Fachleute. Ihr Vokabular lässt sich unverändert verwenden. Das Dokument ist dicht und kurz.

–Menschen, die neu dazukommen. Die Begriffe werden bestimmt, das Beispiel geht der Regel voraus. Das Dokument ist länger und schrittweise aufgebaut.

–Sie selbst, in zwei Jahren. Sie schreiben, was Sie vergessen haben werden: den Grund einer Entscheidung, was zuvor versucht worden war.

Ein Dokument für zwei dieser Publika ist für das eine zu ausführlich und für das andere zu knapp. Ein Publikum je Dokument.

3In welcher Form

Zwei Formen des Lesens. Der Papierordner gibt eine Reihenfolge, eine Seitenzählung und ein Deckblatt vor; er liest sich ohne Gerät. Die Website aktualisiert sich in einem Arbeitsgang, lässt sich per Stichwort durchsuchen und über einen Link weitergeben.

Beide entstehen aus derselben Quelle.

4In welcher Sprache

In einer oder in mehreren. Das KIT bringt die Varianten hervor und veröffentlicht sie nebeneinander, mit einer Sprachauswahl auf der Website.

Von Anfang an vorgesehen, ist dieser Punkt eine Zeile Konfiguration. Später hinzugefügt, erzwingt er, jedes Dokument erneut aufzugreifen und die maßgebliche Fassung zu bestimmen.

5Zwei Kniffe, die Ihnen die Pflege Ihrer Dokumentation erleichtern

–Ein sprechender Dateiname. Die Regel selbst ist zweitrangig; es zählt, eine Datei ohne Öffnen zu erkennen. Das KIT fügt Datum und Uhrzeit in jeden Namen ein, was die Pflege der Fassungen erleichtert.

–Ein einziges Dokument ist maßgeblich. Zwei Dateien werden sich irgendwann widersprechen — das ist in einem Projekt, das sich entwickelt, normal. Sobald die Abweichung entdeckt ist, sagen Sie dem Assistenten, welche der beiden die Quelle ist; die übrigen richten sich danach.

6Was Sie veröffentlichen

Ein Teil Ihrer Dokumentation bleibt intern: Arbeitsnotizen, Aufgabenlisten, noch nicht gefestigte Bestandteile. Der Status entscheidet sich Dokument für Dokument, im Augenblick seiner Erstellung.

Ein nicht veröffentlichtes Dokument bleibt im Ordner und erscheint nicht auf der Website. Eine Veröffentlichung lässt sich schlecht zurücknehmen: ein online gestellter Inhalt kann vor seiner Entfernung eingesehen, kopiert oder indexiert worden sein.

💡Soll ein Teil nur einem begrenzten Kreis zugänglich sein: die meisten Hoster erlauben, ein Verzeichnis mit einem Kennwort zu schützen, ohne die Seiten selbst zu ändern.

7Arbeiten mit künstlicher Intelligenz

Sie schreibt die Formatierung, bringt die Dateien hervor und hält die Konventionen ein. Sie steuern den Inhalt bei.

Kein Assistent ist heute fehlerfrei: es wird ungeschickte Formulierungen geben, ja sogar Fehler. Lesen Sie stets mit den Augen des Publikums, das Sie im Blick haben, und bringen Sie dem Assistenten bei, sich anzupassen.

Hinweis:Das KIT startet vor jeder Lieferung seine eigenen Prüfwerkzeuge. Sie fangen ab, was sich maschinell prüfen lässt — Aufbau, Abfolgen, Version. Eine Formulierung, die falsch klingt, oder ein schlecht gewähltes Beispiel zeigen sich erst beim Lesen.

8Weiter gehen

Die Darstellung des KIT wird Ihnen vielleicht nicht zusagen — kein Problem. Sie können die Formatierungen anpassen und Ihre eigenen Layouts daneben stellen, ohne das Original zu ändern. So können Sie weiterhin Aktualisierungen erhalten, ohne Ihre Erweiterungen zu überschreiben. Das Vorgehen ist in Das Kit erweitern beschrieben.

9Wenn Sie loslegen möchten…

Das KIT lässt sich als ZIP-Datei von der Website kit.sliver.lu herunterladen — das Symbol oben rechts auf der Startseite.

Der Einrichtungsleitfaden beschreibt das Weitere.