短連結評分量表

短連結 (fuchsia.dev/go) 旨在保持耐用性、有意義的名稱,並且具有一般興趣。這些連結具有耐用性,並使用固定式命名空間,因此最好仔細考慮每個提案,以限制已建立的短連結數量。

審查人員應考慮出下列短時間內的待處理連結要求:

  • 您提出的連結需要長期連結嗎? 連結旨在提供耐用性,因此您應合理確保連結會持續維持一般興趣。

    • 正面範例:一般 Fuchsia 常見問題頁面,或目前支援的硬體清單。雖然主題會隨時間而改變,但這些主題絕對絕對是關聯性高的。

    • 負示例:目前正在考慮的 RFC 提案。雖然提案目前相關,但可接受或拒絕提案。如果接受的話,這可能是合適的短連結主題以供參考。

  • 連結是否涵蓋一般主題或概念?是否適合所有觀眾?

    • 好例子

      • FIDL 總覽。這是 Fuchsia 所使用的基本技術。
      • Fuchsia 安全性模型。這對於使用者和開發人員都很感興趣。
    • 排除範例

      • 單一系統呼叫的說明文件。系統呼叫清單的連結可能較為相關。
      • 透過乙太網路啟動特定 NUC 模型的操作說明。如果連結較為通用,可讓使用者在更多類別上啟動 Fuchsia 且使用不同類別的裝置。
  • 連結是否重複使用一個容易使用且不會變更的現有連結?

    • 正面範例 不太可能改變,因此 可能是多餘的。
  • 連結名稱是否合理?是否符合程式碼規範政策的規定? 短連結當然應該要很短,但他們不瞭解這些費用。

    • 好例子:以下幾個範例都簡短扼要:

      • /docs/go/faq (轉譯為 fuchsia.dev/go/faq)。
      • /docs/go/hardware-specs (轉譯為 fuchsia.dev/go/hardware-specs)。
  • to 連結是否指向 /docs/ 目錄中的文件?

    • 好例子

      • to: /docs/concepts/software_model.md
    • 排除範例