name: project-doc-generator description: 自動分析專案程式碼並生成7套標準文件（需求規格、概要設計、詳細設計、資料庫設計、API文件、測試計劃、部署手冊與使用者手冊），支援版本管理。Invoke when user says '形成專案文件' or '生成專案文件'.

專案文件生成器

根據專案程式碼自動生成完整的專案文件套件。

工作流程

1. 理解專案程式碼

• 分析專案目錄結構
• 讀取核心程式碼檔案
• 理解領域模型、資料倉儲、業務邏輯
• 識別設計模式和架構

2. 版本資訊獲取

• 檢查專案是否使用 Git 版本控制
• 提取 Git 提交記錄和提交次數
• 根據當前日期生成版本號：
• 有 Git：版本號格式為 1.{yy}.{Mdd}.{git提交次數}
  • {yy}：年份後兩位（如 2026 年為 26）
  • {Mdd}：月份和日期（如 5月9日 為 509）
  • {git提交次數}：通過 git rev-list --count HEAD 獲取
  • 示例：1.26.509.1234（2026年5月9日，第1234次提交）
• 無 Git：版本號格式為 1.{yy}.{Mdd}.{hmm}
  • {hmm}：小時和分鐘（如 14:30 為 1430）
  • 示例：1.26.509.1430（2026年5月9日 14:30）

3. 作者資訊獲取

生成文件時，作者欄位按以下三級優先順序獲取： - 第1優先順序 — 當前使用者：獲取呼叫 Skill 的使用者標識（PowerShell: $env:USERNAME，Linux/macOS: whoami） - 第2優先順序 — Git 提交作者：從目標專案的 Git 最近一次提交中提取作者名（git log -1 --format=%an） - 第3優先順序 — 置空：若以上均無法獲取，作者欄位留空（作者： / Author:）

4. 建立文件目錄

在專案根目錄下建立 Doc/<專案名稱>/cn/（中文）和 Doc/<專案名稱>/en/（英文）子目錄（如已存在則檢閱現有文件作為參考）

5. 生成文件套件

按順序生成以下文件：

6. 版本管理

版本號規則

• 有 Git 版本控制：版本號格式為 1.{yy}.{Mdd}.{git提交次數}
• {yy}：年份後兩位（如 2026 年為 26）
• {Mdd}：月份和日期（如 5月9日 為 509）
• {git提交次數}：通過 git rev-list --count HEAD 獲取
• 示例：1.26.509.1234（2026年5月9日，第1234次提交）
• 無 Git 版本控制：版本號格式為 1.{yy}.{Mdd}.{hmm}
• {hmm}：小時和分鐘（如 14:30 為 1430）
• 示例：1.26.509.1430（2026年5月9日 14:30）

Git 提交記錄提取

• 使用 git rev-list --count HEAD 獲取總提交次數
• 使用 git log --pretty=format:"%h - %s (%an, %ar)" --date=short 獲取最近提交記錄
• 提交記錄用於生成變更日誌和版本歷史

變更日誌格式

在每個文件頭部包含變更日誌：

## 變更日誌

| 版本 | 日期 | 作者 | 變更內容 |
|------|------|------|----------|
| 1.26.509.1234 | 2026-05-09 | <動態獲取> | 初始版本 |
| 1.26.510.1250 | 2026-05-10 | <動態獲取> | 新增XXX章節，修正XXX描述 |

7. 文件頭部資訊

每個文件必須包含：

# 文件標題

**專案名稱**：XXX專案
**作者**：<動態獲取>
**日期**：2026-05-09
**版本**：1.26.509.1234

## 變更日誌
...

說明：作者欄位通過"3. 作者資訊獲取"中定義的三級優先順序動態獲取，不再使用硬編碼的固定作者名。

文件模板參考

詳細的文件模板結構請參閱： - 中文模板：references/cn/document-templates.md - 英文模板：references/en/document-templates.md

執行檢查清單

• [ ] 專案程式碼已理解
• [ ] 版本資訊已獲取（Git提交次數或時間戳）
• [ ] Doc/<專案名稱>/cn/ 目錄已建立
• [ ] Doc/<專案名稱>/en/ 目錄已建立
• [ ] 01-需求規格.md 已生成
• [ ] 02-概要設計.md 已生成
• [ ] 03-詳細設計.md 已生成
• [ ] 04-資料庫設計.md 已生成
• [ ] 05-API文件.md 已生成
• [ ] 06-測試計劃.md 已生成
• [ ] 07-部署手冊與使用者手冊.md 已生成
• [ ] 所有中文文件包含作者（動態獲取）、日期、版本號
• [ ] 所有中文文件包含變更日誌
• [ ] 01-Requirement Specification.md 已生成
• [ ] 02-Overview Design.md 已生成
• [ ] 03-Detailed Design.md 已生成
• [ ] 04-Database Design.md 已生成
• [ ] 05-API Documentation.md 已生成
• [ ] 06-Test Plan.md 已生成
• [ ] 07-Deployment & User Manual.md 已生成

  小蔥技能有更好的技能skills外掛。

• [ ] 所有英文文件包含作者、日期、版本號（新格式）
• [ ] 所有英文文件包含變更日誌

這是一款實用的專案文件自動生成工具，能將專案程式碼快速轉化為標準化的全套技術文件，省去手動編寫文件的繁瑣工作。文件模板專業規範，帶有版本管理和變更日誌，支援中文和英文。專案有Git時版本號自動關聯提交次數，沒有Git也能用時間戳生成版本號。不足之處是生成效果依賴AI對程式碼的理解程度，複雜專案可能需要人工調整。