Lompat ke konten
dokumentasi.id
Commit a27b09d
v2
Star11 rb

Kamu membaca versi lama. Halaman ini hanya bisa dibaca.

5

Platforms dan Desain API

Bagian Platforms memuat 42 entri dalam 15 subbagian, membentang dari ### Android di baris 263 sampai ### Other yang berakhir di baris 347 README.md:261-347. Isinya tidak seragam: ada pedoman sistem operasi, pedoman vendor, format hypermedia, sampai panduan aksesibilitas web. Daftar Isi di awal berkas hanya menautkan bagian tingkat atas, dan Platforms berada di urutan ketiga dari enam tautan README.md:7-12. Tidak ada tautan ke subbagian, jadi pembaca harus menggulir sendiri untuk mencapai ### SQL atau ### Node.js.

Peta bagian Platforms

Diagram berikut memecah 42 entri menjadi tujuh kelompok, lalu membuka kelompok Desain API sampai tingkat isinya.

graph TD
  P["Platforms: 42 entri di 15 subbagian"]
  P --> CORE["Platform inti: Android 2, Apache 1, GNU 1, Linux 1"]
  P --> RT["Runtime dan hardware: Node.js 2, Arduino 2"]
  P --> VEND["Vendor: Java 1, Mailchimp 1, Mozilla 1, Google 1"]
  P --> APIC["Desain API: 5 entri"]
  P --> FE["Frontend dan aksesibilitas: 15 entri"]
  P --> DATA["Data: SQL 1, MongoDB 1"]
  P --> OTH["Other: 7 entri"]
  APIC --> FMT["HAL dan JSON API: format representasi"]
  APIC --> GUIDE["Microsoft REST dan Google Cloud: panduan desain"]
  APIC --> SEC["API Security Checklist: gerbang rilis"]
  VEND --> JAVADUP["Java: heading kembar dengan baris 109"]
  style P fill:#f59e0b,color:#000
  style APIC fill:#f59e0b,color:#000
  style CORE fill:#2d7d46,color:#fff
  style RT fill:#2d7d46,color:#fff
  style DATA fill:#336791,color:#fff
  style FE fill:#8b5cf6,color:#fff
  style JAVADUP fill:#dc2626,color:#fff
%% fig: Peta bagian Platforms
%% desc: Bagian Platforms dipecah menjadi tujuh kelompok, kelompok Desain API dibuka menjadi tiga lapis, dan heading Java yang kembar ditandai.
Fig. 1: Peta bagian PlatformsBagian Platforms dipecah menjadi tujuh kelompok, kelompok Desain API dibuka menjadi tiga lapis, dan heading Java yang kembar ditandai.

Tabel ini memuat seluruh subbagian, jumlah entri, dan rentang barisnya.

SubbagianEntriBarisSorotan
Android2README.md:263-266Android Guidelines dan Xmartlabs Android Style Guide
Apache1README.md:268-270Gaya bahasa C untuk Apache HTTP Server
API5README.md:272-278Format hypermedia sampai checklist keamanan
Arduino2README.md:280-283Satu entri tanpa deskripsi
Frontend Development15README.md:285-301Satu-satunya subbagian yang memuat panduan aksesibilitas
GNU1README.md:302-304Standar kode dan dokumentasi GNU
Java1README.md:306-308Hanya JavaEE Specification
Linux1README.md:310-312Linux kernel coding style
Mailchimp1README.md:314-316Gaya penulisan konten
Mozilla1README.md:318-320Gaya kode proyek Mozilla
Google1README.md:322-324Pedoman editorial dokumentasi developer
Node.js2README.md:326-329Pedoman engineering dan gaya kode
MongoDB1README.md:331-333Mongo Style Guide
SQL1README.md:335-337SQL Style Guide
Other7README.md:339-347Lintas topik: changelog sampai CodeQL

Desain API

Subbagian API berisi lima entri, dan urutannya tidak alfabetis: HAL, Microsoft REST API Guidelines, JSON API - Recommendations, API Security Checklist, lalu Google Cloud API Design Guide README.md:272-278. Kelima entri itu menempati tiga lapis berbeda, dari format representasi sampai gerbang rilis.

graph LR
  FMT["HAL dan JSON API"] --> GUIDE["Microsoft REST API Guidelines dan Google Cloud API Design Guide"]
  GUIDE --> SEC["API Security Checklist"]
  style FMT fill:#8b5cf6,color:#fff
  style GUIDE fill:#f59e0b,color:#000
  style SEC fill:#2d7d46,color:#fff
%% fig: Tiga lapis panduan desain API
%% desc: Subbagian API memisahkan format representasi, panduan desain, dan checklist keamanan sebagai tiga lapis terpisah.
Fig. 2: Tiga lapis panduan desain APISubbagian API memisahkan format representasi, panduan desain, dan checklist keamanan sebagai tiga lapis terpisah.
EntriBarisLapisIsi menurut deskripsi README
HAL274format representasiformat sederhana untuk hyperlink antar resource secara konsisten
JSON API - Recommendations276format representasirekomendasi untuk implementasi JSON API
Microsoft REST API Guidelines275panduan desainpedoman REST API dari Microsoft
Google Cloud API Design Guide278panduan desainpanduan desain umum untuk networked API
API Security Checklist277gerbang riliscountermeasure keamanan saat mendesain, menguji, dan merilis API

⚠️ Dari lima entri itu, hanya API Security Checklist yang menyebut tahap rilis. Empat entri lain berhenti pada bentuk kontrak, jadi jangan memperlakukannya sebagai pengganti satu sama lain.

Platform inti dan kernel

### Android berisi dua pedoman, Android Guidelines dari ribot dan Xmartlabs Android Style Guide README.md:263-266. ### Apache hanya satu entri: gaya bahasa C untuk Apache HTTP Server README.md:268-270. ### GNU juga satu, GNU coding standards yang mencakup standar kode dan dokumentasi README.md:302-304. ### Linux berisi Linux kernel coding style untuk kernel Linux README.md:310-312. Keempatnya adalah pedoman untuk satu sistem atau satu proyek, bukan untuk satu bahasa.

Runtime, hardware, dan vendor

### Node.js memuat dua entri: Microsoft + Node.js Guidelines untuk pedoman engineering aplikasi Node.js, dan Node.js Style Guide untuk gaya kode Node.js maupun JavaScript README.md:326-329. Gaya JavaScript sendiri dibahas di Bahasa Web dan Skrip Dinamis. ### Arduino juga dua entri, dan entri keduanya, API Style Guide for Arduino, ditulis tanpa deskripsi README.md:280-283.

### Java di bagian ini hanya memuat JavaEE Specification README.md:306-308. Judul subbagian itu kembar dengan ### Java di bagian Programming Languages README.md:109, sehingga anchor otomatis untuk keduanya tidak unik. Entri bahasa Java yang lengkap ada di Bahasa Sistem dan Enterprise.

Tiga subbagian berikut memakai nama organisasi, bukan nama bahasa atau sistem. ### Mailchimp berisi panduan gaya penulisan konten README.md:314-316, ### Mozilla berisi panduan gaya kode untuk proyek Mozilla README.md:318-320, dan ### Google berisi pedoman editorial untuk dokumentasi developer README.md:322-324. Urutannya pun tidak alfabetis: ### Google diletakkan setelah ### Mozilla, bukan sebelum ### GNU.

Frontend Development dan WCAG 2.1

### Frontend Development adalah subbagian terbesar dengan 15 entri, dari CSS Guidelines sampai Web Content Accessibility Guidelines (WCAG) 2.1 README.md:285-301. WCAG 2.1 hanya muncul di sini: satu-satunya panduan aksesibilitas di seluruh bagian Platforms, dan posisinya di bawah subbagian frontend, bukan di bawah API. Empat belas entri sisanya membahas CSS, Sass, HTML, CoffeeScript, design system, dan checklist pra-rilis.

⚠️ Baris 301 berakhir dengan dua spasi, dan ### GNU di baris 302 menyusul tanpa baris kosong README.md:301-302. Subbagian lain di bagian ini dipisahkan baris kosong. Kalau menambah entri di ujung ### Frontend Development, sisipkan baris kosong sebelum heading berikutnya.

Data dan Other

### SQL hanya memuat SQL Style Guide untuk gaya dan format SQL README.md:335-337. ### MongoDB juga satu entri, Mongo Style Guide untuk pemakaian MongoDB README.md:331-333. Keduanya adalah satu-satunya panduan yang menyentuh penyimpanan data, dan keduanya diletakkan setelah ### Node.js sehingga urutan abjad bagian ini terputus.

### Other menutup bagian Platforms dengan tujuh entri lintas topik: Keep a CHANGELOG, Project Guidelines, Semantic Versioning, Indent style, WebAppSec/Secure Coding Guidelines, Robot Framework User Guide, dan CodeQL Coding Standards README.md:339-347.

Pola penulisan entri

Setiap entri memakai bentuk - [Nama](url) - deskripsi. Enam dari 42 entri di bagian ini menghilangkan deskripsi: API Style Guide for Arduino pada baris 283, LESS Coding Guidelines pada baris 295, Google HTML/CSS Style Guide pada baris 296, Semantic Versioning pada baris 343, Indent style pada baris 344, dan CodeQL Coding Standards pada baris 347. Rentang subbagian yang memuatnya sudah dikutip pada tabel di atas.

⚠️ Jangan menambah entri baru tanpa deskripsi. Enam entri tanpa deskripsi di atas adalah warisan format lama, bukan pola yang perlu diikuti. Aturan kontribusi selengkapnya ada di Panduan Berkontribusi dan Kode Etik.