


Technische Doku nach Projektregeln überarbeiten, ohne Links zu zerstören
Nutze dies, wenn eine KI die technische Dokumentation eines Projekts bearbeitet. Sie erkennt bearbeitbare Dateien, hält Schreib- und Seitenregeln ein, prüft Links, führt nur nötige Prüfungen aus und hält jede Änderung klein und leicht zu prüfen.
Diese KI-Regeln verwenden
## Vor dem Bearbeiten bearbeitbare und erzeugte Dateien unterscheiden
- Ermittle, wo verfasste Inhalte, wiederverwendbare Einbindungen, Vorlagen, strukturierte Daten, statische Ressourcen und erzeugte Referenzen liegen.
- Behandle den Beitragsleitfaden, den Stilleitfaden, die Komponentenreferenz und die Regeln für Kopfmetadaten des Repositoriums als maßgeblich.
- Unterscheide vor einer Änderung bearbeitbare Quellen von eingebundenen Fremdinhalten und erzeugten Inhalten.
- Bearbeite eingebundene Fremddateien oder erzeugte Referenzseiten nicht direkt. Verfolge sie bis zu ihrer übergeordneten Quelle zurück und nimm die Korrektur dort vor.
- Wenn ein lokaler Prüfungsfehler aus geschützten Inhalten stammt, melde die zuständige übergeordnete Quelle, statt eine lokale Umgehung anzuwenden.
## In Links echte Dateipfade nutzen und jedes Ziel prüfen
- Ermittle, ob das Veröffentlichungssystem Quellpfade umschreibt, Pfadteile entfernt oder Aliase vergibt.
- Verwende für interne Verweise den vollständigen Quellpfad, wenn das Erstellungssystem Verknüpfungen anhand des Quellbaums auflöst, auch wenn die öffentliche URL kürzer ist.
- Vergleiche Anker mit den tatsächlich erzeugten Überschriftenkennungen und berücksichtige dabei die Regeln zur Kleinschreibung und Slug-Bildung.
- Prüfe Ersatzverknüpfungen, statt sie zu erraten. Kann das Ziel nicht bestätigt werden, gilt die Änderung als blockiert, sofern nicht eine etablierte Migration eine sicherere URL ohne Anker zulässt.
- Prüfe vor dem Ändern eines Verweises auf eine fehlende Ressource neben dem sichtbaren Quellordner auch das virtuelle Dateisystem des Rahmenwerks und die von Abhängigkeiten bereitgestellten Ressourcen.
## Kurz und direkt mit den freigegebenen Begriffen des Projekts schreiben
- Schreibe direkt, knapp und im Aktiv.
- Entferne abschwächende Formulierungen, werbliche Fülltexte, Metakommentare und Aussagen, die eine Aufgabe als mühelos darstellen.
- Bevorzuge leserorientierte Anweisungen und nenne das Produkt oder System, wenn die Zuständigkeit ausdrücklich erkennbar sein muss.
- Verwende die vom Repositorium zugelassene Terminologie, Groß- und Kleinschreibung, UI-Verben und Hervorhebungsregeln.
- Behalte dauerhafte Hinweise zur Versionseinführung bei, wenn sie erklären, ab wann ein Verhalten gilt; vermeide relative Zeitangaben, deren Bedeutung verfällt.
- Ergänze zulässige Fachbegriffe in der engstmöglichen Wortschatz-Zulässigkeitsliste. Verwende die kanonische Schreibweise und vermeide breite Muster, die unabhängige Prüfungen unterdrücken.
## Titel und Beschreibung jeder Seite angeben und Komponenten richtig schreiben
- Füge alle vorgeschriebenen Metadatenfelder ein, etwa Seitentitel, Vorschautext und Suchbegriffe.
- Halte Navigationsbezeichnungen innerhalb der dokumentierten Grenzen und verwende Sortierfelder nur, wenn der Abschnitt sie benötigt.
- Prüfe die Komponentenreferenz, bevor du Kurzcodes des Rahmenwerks oder eingebettete Komponenten schreibst; ungültige Syntax kann unbemerkt fehlschlagen und beschädigte Ergebnisse erzeugen.
- Befolge das dokumentierte Verhalten clientseitiger UI-Anweisungen. Kombiniere nicht zwei Verbergungsmechanismen, wenn einer den anderen dauerhaft übersteuern kann; verwende das Vorinitialisierungs-Verbergungsmuster des Rahmenwerks.
- Ändere die globale Konfiguration nicht nur, um eine Einschränkung des lokalen Erstellungslaufs oder Arbeitsbaums zu umgehen.
## Zuerst die geänderten Dateien formatieren und prüfen, bei Bedarf dann die ganze Website
- Führe nach der Bearbeitung das vom Repositorium bereitgestellte Formatierungswerkzeug für die geänderten Dateien aus.
- Führe vor umfassenderen Prüfungen das dateibezogene Prüfwerkzeug aus, das Auszeichnung und Fließtext gemeinsam kontrolliert.
- Bevorzuge bei schrittweisen Arbeiten gezielte Prüfungen, damit unabhängige Fehler das Ergebnis nicht verdecken.
- Führe eine vollständige Website-Erstellung und Verknüpfungsprüfungen durch, wenn die Änderung Weiterleitung, gemeinsame Komponenten, Navigation, erzeugte Referenzen oder anderes seitenübergreifendes Verhalten betrifft.
- Ist ein gebündeltes Prüfziel mit der Umgebung nicht vereinbar, führe die unterstützten Prüfungen getrennt aus und lasse die Konfiguration unverändert.
- Schließe die zutreffenden Prüfungen ohne weitere Erinnerung ab und melde jede Prüfung, die nicht ausgeführt werden konnte.
## Pro Problem eine kleine Änderung machen und auf jeden Review-Kommentar antworten
- Erstelle für jeden Vorgang genau einen klar abgegrenzten Änderungssatz. Vermische Dokumentationskorrekturen nicht mit benachbarten Aufräumarbeiten oder unabhängigen Umstrukturierungen.
- Merke Dateien ausdrücklich für die Aufnahme vor. Verwende niemals breit wirkende Vormerkbefehle, die Sperrdateien oder erzeugte Änderungen miterfassen können.
- Prüfe vor dem Commit die Liste der vorgemerkten Dateien und nimm alles heraus, was außerhalb des vorgesehenen Dokumentationsumfangs liegt.
- Bestätige, dass jedes Übertragungsziel die Abzweigung des Mitwirkenden oder ein anderes genehmigtes entferntes Repositorium ist und nicht das geschützte übergeordnete Repositorium.
- Behandle Fehlerberichte und Prüfungsvorschläge als zu überprüfende Behauptungen. Bestätige das beobachtete Verhalten, bevor du die Dokumentation änderst.
- Antworte nach der Bearbeitung auf jeden Prüfungsfaden, einschließlich zeilenbezogener Kommentare, für die möglicherweise ein eigener Aufruf der Prüfungs-API erforderlich ist.
- Verwende die nachweislich etiketten- und metadatenerhaltende Dienstschnittstelle, wenn ein Komfortbefehl unzuverlässig ist.
## Seiten entfernen oder eine neue Version hinzufügen, ohne kaputte Links zu hinterlassen
- Suche vor dem Löschen einer Seite in verfassten Inhalten und Navigationskonfigurationen nach ihrem Slug, Titel, ihren Aliasen und eingehenden Verweisen.
- Aktualisiere beim Fortschreiben einer versionierten Referenz in einer einzigen Änderung die zentrale Versionseinstellung, erstelle die neue Versionsseite und verschiebe die Aliase der neuesten Version von der vorherigen Seite.
- Niemals dürfen zwei Versionsseiten denselben Alias der neuesten Version beanspruchen.
- Ändere bei erzeugten Referenzen die übergeordnete Spezifikation oder den Generator und erzeuge das Ergebnis neu; bearbeite die erzeugte Seite nicht von Hand.
- Halte Korrekturen klein, bestätige den tatsächlichen Fehler und wahre einen klaren Eskalationsweg, solange Zuständigkeit oder externe Belege ungeklärt sind.
