skills/generate-readme-zh-tw/SKILL.md
自動分析目前專案結構與功能,產生一份結構清晰、工程導向的 README.md(繁體中文)。
npx skillsauth add CloudyWing/ai-dotfiles generate-readme-zh-twInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
讀取以下資訊(若存在):
*.csproj、*.sln、package.json、pyproject.toml、go.mod 等README.md(若已存在,採 Merge 模式補齊,不全文重寫)appsettings.json、.env.example、docker-compose*.yml 等.github/workflows/、.gitlab-ci.yml 等LICENSE依掃描結果分類:
.ai-agents 專案):提供結構說明與使用方式為主依專案類型組合適當的章節,使用以下結構為基礎:
# 專案名稱
> 一句話描述專案的核心功能與適用對象。
## 功能特色
- [功能 1]
- [功能 2]
## 系統需求
- [執行環境版本,如 .NET 9、Node.js 22+]
## 快速開始
### 安裝
[安裝指令或步驟]
### 執行
[啟動指令]
## 專案結構
[目錄結構說明,使用 tree 格式或表格]
## 設定
[環境變數或設定檔說明,敏感資訊以 `<YOUR_VALUE>` 標示]
## 使用方式
[核心功能的使用範例,包含程式碼區塊]
## 開發流程
### 測試
```bash
# 執行所有單元測試
[測試指令,如 dotnet test / npm test / pytest]
# 執行特定測試
[指令範例]
# 格式化程式碼
[格式化指令,如 dotnet format / npm run lint:fix]
# 建置專案
[建置指令,如 dotnet build / npm run build]
[PR 流程、分支命名慣例的簡要說明,若有的話]
[授權名稱與 LICENSE 連結,若 LICENSE 檔案存在]
**章節選用原則:**
- 無需每個章節都產出,視專案實際內容決定。
- 若某章節資訊無法從現有檔案取得,略去該章節(不寫「待補充」)。
- 若已有 `LICENSE`,必須加入「授權條款」章節。
- 若專案有可執行的測試、格式化或建置指令,必須加入「開發流程」章節。
### 4. 語言與格式規範
- 全文使用繁體中文(台灣用語),程式碼區塊與指令保持英文。
- 中英文混排時,中文字與英文/數字之間加一個半形空格。
- 技術術語保留英文(如 Docker、API、NuGet)。
- 標點符號使用全形(`。,:`),程式碼區塊內維持原樣。
### 5. 寫入結果
**已存在 README.md**:採 Merge 模式,依現有結構插入缺少的章節,保留使用者已寫的內容與風格。
**不存在 README.md**:建立完整新檔。
完成後告知使用者新增或更新的章節清單。
tools
產生或補齊 .gitattributes,統一行尾處理、二進位識別與 lock files 標記,保留既有自訂偏好。
development
產生或補齊前端 Lint 設定(Prettier + ESLint Flat Config),統一格式化與程式碼品質規則,保留既有自訂偏好。
testing
依據事實校閱報告修改技術文件:以事實層為不可違反的約束,由改檔者負責表達層的措辭與行文連貫。Use when the user asks to apply fact-check results to a document, or to edit a document based on a previously produced fact-check-report.md.
data-ai
多份資料檔整合流程。當需要將兩份以上的資料檔(如 JSON、CSV)合併、補齊闕漏欄位或去重成單一檔案時使用。以 dry-run、筆數核對與抽樣比對降低整合錯誤。