Referenz
Auf einen Blick
Abschnitt betitelt „Auf einen Blick“Dieser Abschnitt dient als Einstiegspunkt für Referenzmaterial: API-Inventare, Konfigurationsschlüssel, Kompatibilitätstabellen, unterstütztes CSS-Verhalten und paketübergreifende Abdeckungs-Ledger.
Referenzkarte
Abschnitt betitelt „Referenzkarte“| Referenz | Was sie beantwortet |
|---|---|
| CSS-Support-Matrix | Welche CSS-Funktionen in der HTML-Pipeline verifiziert, beansprucht, teilweise oder nicht unterstützt werden. |
| Integrations-API-Index | Welche Seite der Erweiterungs-API für jede Framework-, Renderer-, Transport- und Build-Tool-Oberfläche maßgeblich ist. |
| Integrationsabschnitte | Wo Sie die paketspezifische API- und Konfigurationsreferenz finden. |
| Core-Modul-Referenz | API- und Architekturseiten auf Modulebene, die aus dem Core-Repository generiert werden. |
Vertrag für Referenzeinträge
Abschnitt betitelt „Vertrag für Referenzeinträge“Jeder API-Eintrag sollte dieselben Fragen beantworten:
| Frage | Erforderliche Antwort |
|---|---|
| Was rufen Sie auf? | Vollständig qualifiziertes Symbol, Endpunkt, CLI-Befehl oder Konfigurationsschlüssel. |
| Welche Eingabe wird akzeptiert? | Parametertabelle mit Typ, Pflichtstatus, Standardwert und akzeptierten Werten. |
| Was passiert standardmäßig? | Das Verhalten, wenn optionale Eingaben weggelassen werden. |
| Was wird zurückgegeben? | Rückgabetyp, Response-Body, Dateiausgabe, Stream oder Nebeneffekt. |
| Was kann fehlschlagen? | Exception, Validierungsfehler, HTTP-Status oder betrieblicher Fehlermodus. |
| Wie nutzen Sie es sicher? | Hinweise zu Sicherheit, Worker-Safety, Größenlimits, Pfaden, Timeouts und dem Umgang mit Secrets. |
Abdeckungsrichtlinie
Abschnitt betitelt „Abdeckungsrichtlinie“Referenzseiten sind quellengestützt. Öffentliche APIs werden anhand von Paketquellcode, Konfigurationsdateien, Tests und Beispielen dokumentiert. Interne Hilfsklassen werden nur dann dokumentiert, wenn Anwendungsentwicklerinnen oder Anwendungsentwickler ihr Verhalten verstehen müssen, um das Paket zu konfigurieren oder zu betreiben.
Übersetzungsbereitschaft
Abschnitt betitelt „Übersetzungsbereitschaft“Referenzseiten setzen bevorzugt auf Tabellen statt auf dichte Absätze. Jede Zeile sollte für sich allein verständlich sein, weil die spätere XLIFF-Segmentierung den Inhalt blockweise aufteilt.