Referentie
In één oogopslag
Sectie met titel “In één oogopslag”Gebruik deze sectie als startpunt voor het referentiemateriaal: API-overzichten, configuratiesleutels, compatibiliteitstabellen, ondersteund CSS-gedrag en dekkingsregisters voor alle packages.
Referentiekaart
Sectie met titel “Referentiekaart”| Referentie | Welke vragen worden beantwoord |
|---|---|
| CSS-ondersteuningsmatrix | Welke CSS-functies de HTML-pijplijn verifieert, als ondersteund claimt, gedeeltelijk ondersteunt of niet ondersteunt. |
| Integratie-API-index | Welke extensie-API-pagina elk framework, elke renderer, elk transport en elk buildtool-oppervlak behandelt. |
| Integratiesecties | Waar je package-specifieke API- en configuratiereferentie vindt. |
| Referentie voor de Core-module | API- en architectuurpagina’s op moduleniveau, gegenereerd vanuit de core-repository. |
Contract voor referentievermeldingen
Sectie met titel “Contract voor referentievermeldingen”Elke API-vermelding moet dezelfde vragen beantwoorden:
| Vraag | Vereist antwoord |
|---|---|
| Wat roep ik aan? | Volledig gekwalificeerd symbool, endpoint, command-line interface (CLI)-opdracht of configuratiesleutel. |
| Welke invoer wordt geaccepteerd? | Parametertabel met type, of het verplicht is, standaardwaarde en geaccepteerde waarden. |
| Wat gebeurt er standaard? | Het gedrag als optionele invoer wordt weggelaten. |
| Wat komt er terug? | Retourtype, responsbody, bestandsuitvoer, stream of neveneffect. |
| Wat kan er misgaan? | Uitzondering, validatiefout, HTTP-status of operationele faalmodus. |
| Hoe gebruik ik het veilig? | Opmerkingen over beveiliging, worker-veiligheid, groottelimieten, paden, time-outs en het omgaan met secrets. |
Dekkingsbeleid
Sectie met titel “Dekkingsbeleid”Referentiepagina’s zijn gebaseerd op de broncode. Publieke API’s worden gedocumenteerd aan de hand van de broncode van het package, configuratiebestanden, tests en voorbeelden. Interne hulpklassen worden alleen gedocumenteerd wanneer applicatieontwikkelaars het gedrag ervan moeten begrijpen om het package te configureren of te bedienen.
Vertaalgereedheid
Sectie met titel “Vertaalgereedheid”Referentiepagina’s gebruiken bij voorkeur tabellen in plaats van tekstzware alinea’s. Elke rij moet op zichzelf kunnen staan, omdat de latere Extensible Localization Interchange File Format (XLIFF)-segmentatie de inhoud per blok splitst.