Referensi
Sekilas pandang
Bagian berjudul “Sekilas pandang”Gunakan bagian ini sebagai titik masuk ke materi referensi: inventaris API, kunci konfigurasi, tabel kompatibilitas, perilaku CSS yang didukung, dan catatan cakupan lintas paket.
Peta referensi
Bagian berjudul “Peta referensi”| Referensi | Pertanyaan yang dijawab |
|---|---|
| Matriks dukungan CSS | Fitur CSS mana saja yang diverifikasi, diklaim, didukung sebagian, atau tidak didukung dalam alur HTML. |
| Indeks API integrasi | Halaman API ekstensi mana saja yang mencakup setiap framework, renderer, transport, dan permukaan alat build. |
| Bagian integrasi | Di mana menemukan referensi API dan konfigurasi khusus paket. |
| Referensi modul inti | Halaman API dan arsitektur tingkat modul yang berasal dari repositori inti. |
Kontrak entri referensi
Bagian berjudul “Kontrak entri referensi”Setiap entri API harus menjawab pertanyaan yang sama:
| Pertanyaan | Jawaban yang diperlukan |
|---|---|
| Apa yang saya panggil? | Simbol dengan nama lengkap, endpoint, perintah antarmuka baris perintah (CLI), atau kunci konfigurasi. |
| Input apa yang diterima? | Tabel parameter berisi tipe, status wajib, nilai standar, dan nilai yang diterima. |
| Apa perilaku standarnya? | Perilaku saat input opsional tidak diberikan. |
| Apa yang dikembalikan? | Tipe kembalian, isi respons, keluaran berkas, aliran, atau efek samping. |
| Apa saja yang dapat gagal? | Pengecualian, kesalahan validasi, status HTTP, atau mode kegagalan operasional. |
| Bagaimana cara menggunakannya dengan aman? | Catatan tentang keamanan, keamanan worker, batas ukuran, path, timeout, dan penanganan rahasia. |
Kebijakan cakupan
Bagian berjudul “Kebijakan cakupan”Halaman referensi ditopang oleh kode sumber. API publik didokumentasikan berdasarkan kode sumber paket, berkas konfigurasi, pengujian, dan contoh. Kelas pembantu internal hanya didokumentasikan ketika pengembang aplikasi perlu memahami perilakunya untuk mengonfigurasi atau mengoperasikan paket.
Kesiapan terjemahan
Bagian berjudul “Kesiapan terjemahan”Halaman referensi mengutamakan tabel daripada paragraf padat. Setiap baris harus dapat berdiri sendiri, karena segmentasi Extensible Localization Interchange File Format (XLIFF) nantinya akan memecah konten berdasarkan blok.