Communitygithub.com

thatdudealso/read-me-launcher

為 AI 代理提供感知受眾、基於倉庫的 README 生成工具(檢查 + 證據 + 語法檢查)

read-me-launcher 是什麼?

Read Me Launcher 是一個專為 AI 代理(如 Claude Code、Cursor 等)設計的技能,旨在生成準確反映實際倉庫內容的 README 文件。其核心原則是「先檢查,後撰寫」,通過自動化腳本檢查倉庫結構,並根據分類結果(接口類型、目標受眾、主要證據)選擇最合適的文檔風格和證據級別。該技能支持所有主流代理平台,並包含嚴格的語法檢查規則,確保不包含虛構信息、機密字符串洩漏或渲染錯誤。它提供了一套完整的參考資料(如分類法、視覺指南、章節映射),幫助代理生成結構化、誠實且受眾友好的 README。

相容平台~Claude Code~Codex CLI~Cursor
npx skills add thatdudealso/read-me-launcher

在你喜歡的 AI 中提問

開啟一個已預先載入此 Agent Skill 的新對話。

說明文件

Read Me Launcher

核心承諾:一份與倉庫完全匹配的 README。

先檢查。絕不虛構技術棧資訊。為目標受眾選擇最簡潔且誠實的證據。 完成前進行語法檢查,確保無渲染錯誤及疑似機密字串。

步驟 0:分類

  1. 執行 scripts/inspect-repo.sh。
  2. 確定 INTERFACE × AUDIENCE × PRIMARY_PROOF(參見 references/taxonomy.md)。
  3. 如有需要,映射為簡潔的模式名稱(參見 references/audience.md)。

嚴格規則(錯誤)

  • 關於安裝/執行/測試的聲明必須與檢查結果一致(✓ 已驗證 vs ? 未知)
  • 不得發明不存在的功能、腳本或執行環境
  • 代碼區塊不得放在 <div> / <section> / <center> 內部
  • README 中引用的本地圖片必須存在
  • scripts/check-readme.sh README.md 必須以退出碼 0 結束(機密字串與渲染檢查)
  • 遵守 references/privacy.md 中的隱私規則

強烈建議(非強制要求)

  • 函式庫應以可運行的程式碼為開頭,而非行銷話術
  • 內部倉庫應優化執行手冊內容,而非發布儀式
  • 公開 GUI 通常需要一個真實截圖
  • 只有在每個素材都能證明某項功能時,才添加橫幅/預覽/展示區域
  • 嵌入光柵圖時優先使用 PNG(參見 references/visuals.md)

風格偏好(警告 / 傾向)

  • 使用 em dash 是偏好設定(PREF);僅在使用者希望強制失敗時才使用 --strict-style
  • 預設情況下,首屏徽章最多約 3 個
  • 避免過多表情符號和徽章牆

工作流程

  1. 檢查 - scripts/inspect-repo.sh
  2. 分類 - 分類法 + 目標受眾
  3. 選擇證據 - 最簡潔的必要證據
  4. 草擬 README - references/design.md、 references/section-map.md
  5. 僅在必要時生成素材 - references/generation.md
  6. 語法檢查 - scripts/check-readme.sh README.md
  7. 使用者視角審查 - 一個陌生人能從第一個畫面就成功安裝嗎?

聲明標記(建議在草稿/審查中使用)

標記含義
✓ 已驗證從檢查/清單檔案中確認
~ 推斷合理但未在倉庫中明確指出
? 未知不要當作事實呈現
✗ 不支持移除或重寫

輸出規則

  • 撰寫 README(僅在有充分理由時才生成素材)
  • 傾向於修正現有良好的 README,而非破壞性重寫
  • 不得包含「由 AI 生成」字樣
  • 不得誇大「機密安全」功能,僅限於 check-readme.sh 掃描的範圍;需說明殘留風險

附帶資源

路徑使用時機
scripts/inspect-repo.sh總是第一步
scripts/check-readme.sh總是完成前
references/taxonomy.md分類
references/audience.md證據模式
references/visuals.md圖片格式
references/generation.md素材提示/禁用規則
references/design.md結構
references/privacy.md公開/私有 + 拒絕清單
references/section-map.md各類型的章節指南
tests/run-tests.sh本地驗證

相關技能