Standard for Public Code

← 要求審查貢獻內容 ← 要求審查貢獻內容 ← Require review of contributions 程式碼要有文件 → 程式碼有文件 → Document the code →

目次

  1. 需求規定
  2. 測試方式
  3. 公共政策制定者:需要的工作
  4. 管理人員:需要的工作
  5. 開發人員與設計師:需要的工作
  6. 延伸閱讀

程式基底要有目標文件

以文件清楚記錄程式基底目標,來傳達程式基底的用途目標。這能幫助利害關係人與貢獻者劃定程式基底的開發範圍。這些目 標也能方便人們判斷,是否在當下或未來,會對此程式基底或其模組感興趣。

需求規定

  • 程式基底「必須」包含描寫目標的文件,像是主旨、使命或目標陳述。開發人員與設計師需要能夠瞭解這些,他們才知道可以怎樣使用程式基底或協助貢獻。
  • 程式基底文件「應該」清楚描述政策目標與程式基底目標之間的關聯。
  • 「可選擇」是否以文件記錄給一般大眾看的程式基底目標。

測試方式

  • 確認程式基底文件有包含程式基底目標,或主旨、使命等。
  • 查看政策目標與程式基底目標之間關聯的描述。

公共政策制定者:需要的工作

  • 將政策目標加入程式基底文件中,例如「README」文件當中。
  • 確保所有程式基底目標,有連結或引用為了符合〈政策與原始碼要合捆〉準則而加入的支持政策文 件。

管理人員:需要的工作

  • 將單位目標、組織目標或業務目標加入程式基底文件中,例如「README」文件當中。

開發人員與設計師:需要的工作

  • 將技術與設計目標加入程式基底文件中,例如「README」文件當中。

延伸閱讀