Standard for Public Code

← Publish with an open license ← 發行採用開放授權 ← 發行採用開放授權 Use a coherent style → 風格要前後一致 → 風格要前後一致 →

目次

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

程式基底可查詢得到

一旦程式基底越容易被發現,更多的潛在協作者也就找得到它。不能只是發表個程式基底,然後就盼望他人找得到這套程式基 底,更需要主動積極。

有中介資料說明檔的話,會讓程式基底更容易被發現。良好且包含永久唯一識別碼的中介資料,例如寫成 Wikidata 維基數據條目,或是放到 FSF 自由軟體基金會的軟體 目錄列表之中(使程式基底成為語意網路中的一部份),他人就能更容易透過第三方工具參考、引用、辨別、發現程式基底。

需求規定

  • 程式基底名稱「應該」要能描述說明其用途,且不包含任何首字母縮寫字、縮寫、雙關語,或組織單位品牌名稱或抬頭等。
  • 程式基底說明「應該」要簡短,幫助他人瞭解程式基底的目的與作用。
  • 維護人員「應該」將程式基底提交至相關的軟體目錄上。
  • 程式基底「應該」要架設網站,內容中以程式基底各類潛在使用者(技術人員、政策專家、管理人員等)偏好的業內用語,描述程式基底所能解決的問題。
  • 在搜尋引擎查找程式基底名稱時,「應該」能搜尋得到程式基底。
  • 在使用搜尋引擎時,如果以自然語言描述程式基底所能解決的問題,「應該」能搜尋得到程式基底。
  • 程式基底「應該」具備永久唯一識別碼,而且該項條目要提及主要貢獻者、儲存庫、位置、網站等。
  • 程式基底「應該」包含機器可讀的中介資料說明,例如採用 publiccode.yml格式的檔案。
  • 「可選擇」是否為程式基底設置專用的網域名稱。
  • 「可選擇」是否在社群舉辦的會議中定期進行簡報。

測試方式

  • 檢查程式基底名稱是否描述說明其用途,且不包含雙關語。
  • 檢查程式基底名稱是否不包含任何首字母縮寫字或縮寫,或是其首字母縮寫字或縮寫比完整名稱更熟為人知。
  • 檢查程式基底是否不包含組織單位品牌名稱或抬頭等,除非該組織單位也是程式基底社群成員。
  • 檢查程式基底儲存庫是否包含程式基底的簡短描述。
  • 檢查程式基底有刊登在相關軟體型錄上。
  • 檢查程式基底的網站有描述程式基底能夠解決的問題。
  • 檢查以程式基底名稱來作搜尋時,有超過一個的常用主流搜尋引擎,都有將程式基底列在搜尋結果中。
  • 檢查以自然語言來作搜尋,例如使用程式基底的簡短描述時,有超過一個的常用主流搜尋引擎,都將程式基底放在搜尋結果中。
  • 檢查永久唯一識別碼條目有提及主要貢獻者。
  • 檢查永久唯一識別碼條目中有包含儲存庫位置。
  • 檢查永久唯一識別碼條目有列出程式基底網站。
  • 檢查中介資料說明檔是機器可讀的格式。

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

  • 貢獻一段說明此程式基底作用的政策領域,或所處理問題的描述。
  • 請那些對程式基底不熟悉且不同領域背景的同事,來測試您的問題描述。
  • 在相關會議上作簡報,介紹程式基底如何執行政策

管理人員:需要的工作

  • 在決定專案名稱之前,先搜尋過商標資料庫,以避免名稱造成混淆或侵權的問題。
  • 在引用到程式基底的地方,都使用簡短描述,例如放到社交媒體帳號中的說明。
  • 為團隊編列內容設計與實作 SEO 搜尋引擎最佳化技能的預算。
  • 確保專案參與人員出席相關會議,或作簡報介紹。

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

  • 實作搜尋引擎最佳化,例如加入網站地圖
  • 在引用到程式基底的地方,都使用簡短描述,例如放到儲存庫中的說明。
  • 請那些對程式基底不熟悉且不同領域背景的同事,來測試您的問題描述。
  • 推薦適合出席或作簡報介紹的會議,並且在這些會議中出席或作簡報。

延伸閱讀

  • Wikidata 維基數據社群《維基數據簡介》。
  • FSF 自由軟體基金會《FSF 軟體目錄列表》。
  • GO FAIR 國際支援與合作辦公室所撰寫的《FAIR 科學資料管理與監督指導原則》,提供一份滿好的特性清單,解說哪些特性會讓資料(或中介資料)更容易讓 機器採取行動(也因此更容易被找到)。其中的部分特性可直接套用到程式基底上,而其他無法直接套用的,我們還需要再研究程式基底與其對應的特性要怎麼處理。