參考資料
本節是參考資料的入口,涵蓋 API 清單、組態鍵、相容性表格、支援的 CSS 行為,以及跨套件的涵蓋範圍帳本。
參考地圖
標題為「參考地圖」的區段| 參考項目 | 回答的問題 |
|---|---|
| CSS 支援矩陣 | 哪些 CSS 功能在 HTML 管線中已驗證、已宣稱支援、部分支援或不支援。 |
| 整合 API Index(索引) | 各個 Framework(框架)、renderer(渲染器)、傳輸與建置工具介面,分別由哪個擴充 API 頁面涵蓋。 |
| 整合各章節 | 在哪裡可以找到各套件專屬的 API 與組態參考資料。 |
| 核心模組參考 | 由核心儲存庫產生的模組層級 API 與架構頁面。 |
參考項目合約
標題為「參考項目合約」的區段每個 API 項目都應回答同一組問題:
| 問題 | 必填答案 |
|---|---|
| 我要呼叫什麼? | 完整限定名稱的符號、endpoint、CLI 指令或組態鍵。 |
| 接受哪些輸入? | 包含型別、是否必填、預設值與可接受值的參數表格。 |
| 預設會發生什麼? | 省略選填輸入時的行為。 |
| 會回傳什麼? | 回傳型別、回應內容、檔案輸出、stream 或副作用。 |
| 可能在哪裡失敗? | 例外、驗證錯誤、HTTP 狀態碼或維運層級的失敗模式。 |
| 我要怎麼安全地使用它? | 安全性、worker 安全性、大小限制、路徑、逾時與密鑰處理等注意事項。 |
涵蓋範圍政策
標題為「涵蓋範圍政策」的區段參考頁面皆以原始碼為佐證。公開 API 依套件原始碼、組態檔、測試與範例撰寫而成。只有當應用程式開發者必須理解內部輔助類別的行為,才能設定或操作該套件時,才會為這些類別撰寫文件。
翻譯就緒度
標題為「翻譯就緒度」的區段參考頁面優先使用表格,而不是密集的 segment(段落)。每一列都應能獨立理解,因為後續 XLIFF 段落切分會依區塊拆分內容。