Documentation Layout
文件型版面
文件版面把導覽、文章、範例、大綱和下一篇連結放在同一閱讀畫面。
另一個例子
SDK 指南在程式碼和文字旁顯示版本導覽。寬螢幕也會顯示文章大綱。
主要部分
- 01產品導覽
- 02文章正文
- 03頁內大綱
什麼時候用
適合可用不同順序閱讀的系列指南或參考頁。
什麼時候不要用
小螢幕不要強塞三欄或重複選單。範例要能連結,也要容易複製。
程式裡的名稱
sidebar + main + in-page TOC + deep links 上線前要檢查
檢查內容先後順序、共用設計變數、元件一致性、對比、縮放,以及版面能否隨螢幕大小調整。驗證每個主題、語系與狀態;有動態效果時,也要提供同樣完整的減少動態效果版本。
預期成果:定義或使用 文件型版面 (Documentation Layout),做出清楚、一致又好用的視覺體驗。 使用者情境:SDK 指南在程式碼和文字旁顯示版本導覽。寬螢幕也會顯示文章大綱。 要運用的設計概念:文件型版面 (Documentation Layout)。 適用理由:適合可用不同順序閱讀的系列指南或參考頁。 不應使用的情況:小螢幕不要強塞三欄或重複選單。範例要能連結,也要容易複製。 設計要求:定義內容先後順序、可重用的設計變數(Token)與元件。說明版面如何隨螢幕大小和狀態改變。分清楚必要的設計方向與純裝飾。 包容性與韌性:檢查對比、縮放、多語系、主題切換與減少動態效果。不能只靠顏色或特效傳達意思。 驗收條件:在手機、桌面、縮放、各種主題與所有支援語系中仍清楚可讀。每個互動狀態都一致且容易理解。 證據與限制(證據邊界):沒有一份官方標準能管到全部內容。不同團隊、平台或框架的用法可能不同。 待確認:品牌限制、內容多寡、支援的主題與語系、目標裝置,以及現有設計系統規則。
檢查這份需求
請 AI 程式助手檢查目前如何使用 文件型版面 (Documentation Layout)。 定義:文件版面把導覽、文章、範例、大綱和下一篇連結放在同一閱讀畫面。 正式環境檢查:檢查內容先後順序、共用設計變數、元件一致性、對比、縮放,以及版面能否隨螢幕大小調整。驗證每個主題、語系與狀態;有動態效果時,也要提供同樣完整的減少動態效果版本。 修改程式前,先列出看到的證據、缺口、嚴重程度,以及最小且安全的修正。