SKILL.md
readonlyread-only
name
readme-blueprint-generator
description
智慧型 README.md 生成提示,能分析專案文件結構並建立完整的儲存庫文件。掃描 .github/copilot 目錄檔案與 copilot-instructions.md,擷取專案資訊、技術棧、架構、開發流程、編碼標準與測試方法,同時產生結構良好的 Markdown 文件,包含適當格式、交叉引用與開發者導向內容。
README 生成提示
透過分析 .github/copilot 目錄中的文件與 copilot-instructions.md,為此儲存庫產生一份完整的 README.md。請遵循以下步驟:
-
掃描 .github/copilot 資料夾中的所有檔案,例如:
- Architecture
- Code_Exemplars
- Coding_Standards
- Project_Folder_Structure
- Technology_Stack
- Unit_Tests
- Workflow_Analysis
-
同時檢閱 .github 資料夾中的 copilot-instructions.md 檔案
-
建立包含以下章節的 README.md:
專案名稱與說明
- 從文件中擷取專案名稱與主要用途
- 包含對專案功能的簡潔描述
技術棧
- 列出使用的主要技術、語言與框架
- 若可取得,包含版本資訊
- 主要從 Technology_Stack 檔案取得此資訊
專案架構
- 提供架構的高階概覽
- 若文件中有描述,可考慮加入簡單圖表
- 從 Architecture 檔案取得資訊
快速開始
- 根據技術棧包含安裝說明
- 加入設定與配置步驟
- 包含任何必要條件
專案結構
- 資料夾組織的簡要概覽
- 從 Project_Folder_Structure 檔案取得資訊
主要功能
- 列出專案的主要功能與特性
- 從各文件檔案中擷取
開發流程
- 總結開發流程
- 若可取得,包含分支策略資訊
- 從 Workflow_Analysis 檔案取得資訊
編碼標準
- 總結主要的編碼標準與慣例
- 從 Coding_Standards 檔案取得資訊
測試
- 說明測試方法與工具
- 從 Unit_Tests 檔案取得資訊
貢獻
- 貢獻專案的指南
- 參考程式碼範例作為指引
- 從 Code_Exemplars 與 copilot-instructions 取得資訊
授權
- 若可取得,包含授權資訊
使用適當的 Markdown 格式來排版 README,包括:
- 清晰的標題與子標題
- 適當的程式碼區塊
- 列表以提升可讀性
- 連結至其他文件檔案
- 若資訊可取得,加入建置狀態、版本等徽章
保持 README 簡潔但資訊豐富,專注於新開發者或使用者需要了解的專案相關資訊。






