Vorschau · Entwicklungsstand 1.6.1
Dokumentation für Agenten
Entwickler- und Agenten-Doku
Ein Agent kann diese Referenz ohne Browser lesen und daraus Dateien erstellen oder bestehende Konfigurationen bearbeiten. Die UI- und Dateianleitungen verwenden dieselben kanonischen Verträge.
Die Dokumentation maschinell lesen
- 1Zusammenhang 1
Lies zuerst Version und Dateiformate, dann den konkreten Step-/Trigger-/Makrovertrag. Die vollständige Referenz enthält alle Feld-, Options-, Eingabe- und Ergebnis-Erklärungen. JSON-Vertragsdaten erlauben gezieltes Nachschlagen; es handelt sich um Referenzdaten, nicht ein ausführbares Programm oder JSON-Schema.
- 2Zusammenhang 2
Für kleine Kontexte enthält llms.txt Links auf einzelne Markdown-Referenzen. Jede Funktionsseite bietet außerdem vertrag.json mit genau ihrem Vertrag, ihren Erklärungen und ihrer Vorlage. Der Referenzindex ordnet stabile IDs diesen URLs zu; so muss ein Agent nicht die gesamte mehrmegabytegroße Referenz lesen.
Schematische Übersicht: Beschriftungen und Werte aus der Referenz, keine nachgezeichnete Bedienoberfläche.
Verlässlicher Bearbeitungsablauf
- 1Schritt 1→
Bestimme App-Version und Formatversion der vorhandenen Datei. Behalte bestehende IDs und Eigenschaften, wenn der Auftrag sie nicht ändert.
- 2Schritt 2→
Wähle stabile type- beziehungsweise $type-IDs aus der Referenz. Für Windows-Funktionen nur unterstützte Capability-IDs und Parameter verwenden.
- 3Schritt 3→
Modelliere den Datenfluss: Anbieter, Source-ID, Typ, Kardinalität und Produzentenreihenfolge prüfen. Für direkte Werte aktuelle inputs/localValues verwenden; compound schemas nicht frei erfinden.
- 4Schritt 4→
Prüfe jede Einheit und Enum-Schreibweise an der tatsächlichen JSON-Vorlage. Defaultvorlagen mit leeren Pflichtwerten ergänzen; sie nicht als erfolgreich geprüften Ablauf ausgeben.
- 5Schritt 5→
Schreibe eine separate UTF-8-Datei, prüfe JSON-Syntax und lade sie zur fachlichen Validierung in die App. Bei Zugriff auf das Repository bestehende Serializer, Migratoren und Validatoren verwenden.
- 6Schritt 6→
Teste mit passenden Testdaten und deaktivierten Automationen. Prüfe in Logs technischen Status, fachliches Ergebnis und vollständige Belege.
- 7Schritt 7Abschluss
Berichte konkret, ob nur die Datei erzeugt, die Konfiguration fachlich validiert oder der Ablauf tatsächlich ausgeführt wurde.
Leserichtung: von oben nach unten. Die Zahlen zeigen die Reihenfolge.
Bei Produktänderungen die Doku mitpflegen
- 1Zusammenhang 1
Agenten im Repository müssen die betroffenen Anleitungen, Referenztexte, Werte-/Optionsbeschreibungen, Dateibeispiele und gegebenenfalls Screenshots in derselben Änderung pflegen. Das gilt auch für reine Verhaltensänderungen ohne neue Felder.
- 2Zusammenhang 2
website/Build.ps1 exportiert die kanonischen Verträge und validiert die internen Beispielkonfigurationen. Der Website-Check vergleicht Quellen, Export und Ausgabe und prüft vollständige Erklärungsschlüssel, Verweise und Regressionen. Der vollständige Repository-Check eng/verify.ps1 -Mode Full bleibt das Abschlusskriterium.
- 3Zusammenhang 3
Der Generator aktualisiert technische Kataloge und Seiten, schreibt aber keine ungeprüften Verhaltenserklärungen. Neue oder geänderte Konzepte benötigen eine semantische Prüfung durch den bearbeitenden Agenten.
Schematische Übersicht: Beschriftungen und Werte aus der Referenz, keine nachgezeichnete Bedienoberfläche.