[BEE-2] 如何閱讀 BEE
INFO
本文說明 BEE 文章中使用的慣例,包括 RFC 2119 關鍵字的用法。
背景
BEE 文章使用特定關鍵字來表示要求層級。這些關鍵字遵循 RFC 2119 慣例,確保指引精確且無歧義。
關鍵字定義
| 關鍵字 | 含義 |
|---|---|
| MUST | 絕對要求。違反此項將導致正確性或安全性問題。 |
| MUST NOT | 絕對禁止。執行此項將導致正確性或安全性問題。 |
| SHOULD | 建議。可能有合理的偏離理由,但必須理解並權衡其影響。 |
| SHOULD NOT | 不建議。可能有合理的理由這樣做,但必須理解其影響。 |
| MAY | 可選。這是一個真正可接受的選擇。 |
文章結構
每篇 BEE 文章至少包含:
- 標題 --
[BEE-{id}] {標題} - 資訊區塊 -- 一句話摘要
- 背景 -- 為什麼這很重要
- 原則 -- 使用 RFC 2119 關鍵字的核心指引
選擇性段落(在有價值時包含):
- 圖解 -- Mermaid 圖表
- 範例 -- 具體的、廠商中立的說明
- 常見錯誤 -- 反模式
- 相關 BEE -- 交叉引用
- 參考資料 -- 經過驗證的外部來源
交叉引用
BEE 文章會連結到相關 BEE,當主題與 ADE 或 DEE 重疊時,會使用提示區塊提供交叉引用:
深入探討
關於資料庫層級的實作細節,請見 DEE-100: Normalization。
參考資料
- Bradner, S. 1997. "Key words for use in RFCs to Indicate Requirement Levels". RFC 2119. https://www.rfc-editor.org/rfc/rfc2119
相關 BEE
- BEE-1 BEE 總覽