Riferimenti
In breve
Sezione intitolata “In breve”Questa sezione è il punto di ingresso al materiale di riferimento: inventari delle API, chiavi di configurazione, tabelle di compatibilità, comportamento CSS supportato e registri di copertura tra pacchetti.
Mappa dei riferimenti
Sezione intitolata “Mappa dei riferimenti”| Riferimento | A cosa risponde |
|---|---|
| Matrice di supporto CSS | Quali funzionalità CSS risultano verificate, dichiarate, parziali o non supportate nella pipeline HTML. |
| Indice delle API di integrazione | Quale pagina dell’API di estensione copre ciascuna superficie di framework, renderer, trasporto e strumento di compilazione. |
| Sezioni di integrazione | Dove trovare il riferimento alle API e alla configurazione specifico del pacchetto. |
| Riferimento del modulo core | Pagine API e di architettura a livello di modulo generate dal repository core. |
Contratto delle voci di riferimento
Sezione intitolata “Contratto delle voci di riferimento”Ogni voce API deve rispondere alle stesse domande:
| Domanda | Risposta richiesta |
|---|---|
| Che cosa viene richiamato? | Simbolo completo, endpoint, comando CLI o chiave di configurazione. |
| Quale input viene accettato? | Tabella dei parametri con tipo, stato di obbligatorietà, valore predefinito e valori accettati. |
| Che cosa accade per impostazione predefinita? | Comportamento quando l’input facoltativo viene omesso. |
| Che cosa viene restituito? | Tipo restituito, corpo della risposta, output su file, flusso o effetto collaterale. |
| Che cosa può fallire? | Eccezione, errore di convalida, stato HTTP o modalità di errore operativo. |
| Come usarlo in modo sicuro? | Note su sicurezza applicativa, sicurezza dei worker, limite di dimensione, percorso, timeout e gestione dei segreti. |
Criteri di copertura
Sezione intitolata “Criteri di copertura”Le pagine di riferimento si basano sul codice sorgente. Le API pubbliche sono documentate a partire dal codice sorgente del pacchetto, dai file di configurazione, dai test e dagli esempi. Le classi helper interne sono documentate solo quando uno sviluppatore di applicazioni deve comprenderne il comportamento per configurare o usare il pacchetto.
Preparazione alla traduzione
Sezione intitolata “Preparazione alla traduzione”Le pagine di riferimento privilegiano le tabelle rispetto ai paragrafi densi. Ogni riga deve risultare comprensibile in modo autonomo, perché la successiva segmentazione XLIFF suddividerà il contenuto per blocco.