Community寫作與編輯github.com

Broklam/readme-constructor

根據使用者選擇的結構、章節內容與視覺元素,建構專屬的專案 README。適用於建立全新 README、進行重大重新設計,或明確要求 README 建構工具的情況。

readme-constructor 是什麼?

這是一個專為開發者與 AI 代理(如 Claude Code、Cursor、Codex)設計的 README 建構技能。它透過引導使用者選擇結構、章節內容與視覺元素,打造符合專案需求與讀者期待的 README。使用者可以完全自訂章節順序、內容深度與圖片配置,技能會根據專案現有檔案、文件與素材提供建議,但不會擅自發明功能、指令、結果或圖片。支援新 README 建立、大幅改版或局部編輯,並能尊重使用者已有的決策,逐步收斂未決的設計選項,最終產出可直接使用的 Markdown 文件。技能內建三個參考選單(結構、章節內容、視覺),並提供 `keep`、`none`、`skip`、`recommend` 等靈活選項,讓使用者能精細控制每個環節。

相容平台~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/Broklam/readme-constructor/tree/HEAD/skills/readme-constructor

Installed? Explore more 寫作與編輯 skills: steipete/notion, langchain-ai/langchain, bytedance/podcast-generation · View all 6 →

在你喜歡的 AI 中提問

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

說明文件

README 建構工具

打造一份符合專案及其讀者需求的 README。將使用者視為設計師。預設提案僅供參考,結構、內容與視覺元素皆為獨立選項。使用專案現有證據與使用者已有的決策。切勿憑空發明功能、指令、結果、圖片或聲明。

探索與提案

在提出配方之前,先檢查相關儲存庫、現有文件、文件產生來源與素材。識別 README 的目的、目標讀者、標題、語氣與呈現目標(若這些會影響設計)。尊重要求的輸出路徑或僅限聊天室的草稿。編輯文件來源(若輸出為產生的文件)。保留有用的既有事實與素材,特別是針對現有的 README。

選擇性地使用下方選單。這些選單的模式提供使用者可自行調整的選項。其連結範例是從 Awesome README 索引 中挑選的代表性子集,並附有簡短的原則說明。使用此技能無需網路連線。

  • 使用結構選單提出有序的起點與章節選項。
  • 使用章節內容選單為每個選中的章節選擇格式、深度與佐證材料。
  • 使用視覺選單選擇個別視覺元素、放置位置以及可用或建議的素材。

對於新 README 或重大重新設計,提供一份可編輯的客製化配方,顯示提議的標題順序、每個章節的內容選擇,以及任何個別放置的視覺元素。僅在仍具決定性時提供簡短的背景選項。在緊湊的選單中使用穩定的 ID,以便使用者新增、移除、重新命名或重新排序章節、獨立選擇每個章節的內容,並可選擇加入個別視覺元素。在適用的情況下提供 none、keep、skip、recommend 以及自由填寫的選項。說明 recommend 會將選擇權委派給 AI。讓使用者獨立於預設組合之外決定內容與視覺元素。

採納使用者已給出的選擇,並在修訂配方時保留它們。在重新設計中,當 keep 選中現有項目時,保留並套用該項目。僅針對未解決的設計選擇提問,並將問題整合成可管理的訊息。在草擬全新或大幅改版的 README 之前,等待使用者做出這些選擇,除非使用者已委派決策權。如果使用者已提供足夠的方向或要求您自行決定,則使用合適的預設值繼續進行。選擇確定後,直接產出要求的交付成果,無需再次尋求批准。對於局部編輯,直接執行使用者的要求,無需啟動新的建構工作階段。

將以下精簡對話範例應用於目前專案。

提議順序為 S1 總覽 → S2 快速入門 → S3 架構。內容選擇為 S1 問題 + 範圍、S2 基本指令 與 S3 純文字元件圖。視覺選擇為 V1 截圖(位於 S1 之後,提議,無可用素材) 與 V2 架構圖(位於 S3 之後,提議)。選擇章節與順序、變更任何章節的內容,並個別選擇視覺元素。keep 接受特定的提議值,none 移除一個章節或視覺元素,skip 跳過一個可選項目,recommend 則委派決策。歡迎自訂文字。

使用者選擇 順序 S1, S3, S2 / S2 引導式 / V1 none / V2 keep / 其餘 keep。

產生的配方保留 S1 與 S3 的內容,為 S2 使用引導式快速入門,省略 V1,並將 V2 置於 S3 之後。解決任何剩餘的素材不確定性,而不重新討論已接受的選擇。區分提議素材與現有素材。僅在使用者要求的範圍與可用工具內製作或取得提議素材,否則省略素材並說明原因。

產出與檢查

按照所選的配方撰寫章節,並提供來自專案的具體佐證。在可行時安全地驗證指令。標記未經驗證的指令或遺失的資訊,並避免僅為了測試文件而執行具有破壞性或副作用影響的指令。檢查標題順序與連結、錨點、目標平台的 Markdown 渲染效果、程式碼區塊與語言標籤,以及相對素材路徑。為有意義的圖片提供資訊豐富的替代文字,並在使用視覺元素時檢查其在淺色與深色主題下的可讀性。保留所要求範圍外的現有內容。在回報結果時說明重大的資訊缺口與驗證限制。

相關技能