universal-dev-standards 3.5.1-beta.1 → 3.5.1-beta.11

package/bundled/locales/zh-TW/ai/options/commit-message/traditional-chinese.ai.yaml

@@ -0,0 +1,100 @@
+# 繁體中文提交格式 - AI 優化選項
+# 父項: commit-message
+
+id: traditional-chinese
+meta:
+  parent: commit-message
+  version: "1.0.0"
+  description: 使用繁體中文的提交訊息格式
+  language: zh-TW
+
+best_for:
+  - 台灣或香港團隊
+  - 使用繁體中文的專案
+  - 文件以繁體中文為主的專案
+
+format:
+  template: "<類型>(<範圍>): <主旨>"
+  note: 類型使用中文，範圍使用英文或中文
+
+types:
+  - type: 功能
+    english: feat
+    description: 新功能
+
+  - type: 修正
+    english: fix
+    description: 錯誤修正
+
+  - type: 重構
+    english: refactor
+    description: 程式碼重構
+
+  - type: 文件
+    english: docs
+    description: 文件更新
+
+  - type: 樣式
+    english: style
+    description: 格式調整
+
+  - type: 測試
+    english: test
+    description: 測試相關
+
+  - type: 效能
+    english: perf
+    description: 效能改善
+
+  - type: 建置
+    english: build
+    description: 建置系統
+
+  - type: 整合
+    english: ci
+    description: 持續整合
+
+  - type: 雜項
+    english: chore
+    description: 維護任務
+
+  - type: 安全
+    english: security
+    description: 安全修正
+
+rules:
+  - id: chinese-type
+    trigger: 撰寫提交標頭時
+    instruction: 使用中文類型（功能、修正、重構等）
+    priority: required
+
+  - id: chinese-subject
+    trigger: 撰寫主旨時
+    instruction: 以繁體中文撰寫主旨
+    priority: required
+
+  - id: chinese-body
+    trigger: 撰寫內文時
+    instruction: 以繁體中文撰寫內文
+    priority: required
+
+examples:
+  simple: "功能(認證): 新增 OAuth2 登入支援"
+  with_body: |
+    功能(認證): 新增 OAuth2 Google 登入支援
+
+    實作 Google OAuth2 認證流程供使用者登入。
+
+    - 整合 Google OAuth2 SDK
+    - 建立 OAuth 流程回呼端點
+    - 安全儲存更新權杖
+
+    關閉 #123
+  breaking: |
+    功能(api)!: 變更使用者端點回應格式
+
+    破壞性變更: 使用者 API 回應格式已變更
+
+    遷移指南：
+    1. 更新 API 客戶端移除 .data 包裝
+    2. 使用 created_at 取代 createdAt

package/bundled/locales/zh-TW/ai/options/documentation/api-docs.ai.yaml

@@ -0,0 +1,140 @@
+# API 文件 - AI 優化選項
+# 父項: documentation
+
+id: api-docs
+meta:
+  parent: documentation-structure
+  version: "1.0.0"
+  description: API 參考文件標準
+  language: zh-TW
+
+best_for:
+  - REST API
+  - GraphQL API
+  - SDK/函式庫文件
+  - 公開 API
+
+formats:
+  openapi:
+    name: OpenAPI (Swagger)
+    versions: ["3.0", "3.1"]
+    file_extension: [".yaml", ".json"]
+    best_for: REST API
+    tools:
+      - Swagger UI
+      - Redoc
+      - Stoplight
+
+  graphql:
+    name: GraphQL Schema
+    file_extension: [".graphql", ".gql"]
+    best_for: GraphQL API
+    tools:
+      - GraphQL Playground
+      - Apollo Studio
+
+  asyncapi:
+    name: AsyncAPI
+    versions: ["2.x", "3.x"]
+    best_for: 事件驅動 API
+    tools:
+      - AsyncAPI Studio
+
+documentation_elements:
+  required:
+    - 端點 URL
+    - HTTP 方法
+    - 請求參數
+    - 回應格式
+    - 錯誤碼
+    - 驗證方式
+
+  recommended:
+    - 程式碼範例（多種語言）
+    - 速率限制
+    - 分頁詳情
+    - 變更日誌/版本控制
+
+  optional:
+    - 線上測試主控台
+    - SDK
+    - Postman 集合
+
+rules:
+  - id: describe-all-endpoints
+    trigger: 建立 API 文件時
+    instruction: 記錄每個公開端點
+    priority: required
+
+  - id: include-examples
+    trigger: 記錄端點時
+    instruction: 包含請求和回應範例
+    priority: required
+
+  - id: document-errors
+    trigger: 記錄端點時
+    instruction: 列出所有可能的錯誤回應
+    priority: required
+
+  - id: version-api-docs
+    trigger: API 變更時
+    instruction: 保持文件與 API 版本同步
+    priority: required
+
+  - id: authentication-first
+    trigger: 建立 API 文件時
+    instruction: 在端點之前先記錄驗證方式
+    priority: recommended
+
+example_endpoint_doc: |
+  ## 建立使用者
+
+  建立新的使用者帳號。
+
+  **端點：** `POST /users`
+
+  **驗證：** 需要 Bearer token
+
+  ### 請求主體
+
+  | 欄位 | 類型 | 必填 | 說明 |
+  |------|------|------|------|
+  | name | string | 是 | 使用者全名 |
+  | email | string | 是 | 電子郵件地址 |
+
+  ### 回應
+
+  ```json
+  {
+    "id": "usr_123",
+    "name": "王小明",
+    "email": "xiaoming@example.com",
+    "createdAt": "2025-01-15T10:30:00Z"
+  }
+  ```
+
+  ### 錯誤
+
+  | 代碼 | 說明 |
+  |------|------|
+  | 400 | 無效的請求主體 |
+  | 409 | 電子郵件已存在 |
+
+tools:
+  generators:
+    - name: swagger-codegen
+      generates: 客戶端 SDK
+    - name: openapi-generator
+      generates: 客戶端/伺服器程式碼
+    - name: typedoc
+      generates: TypeScript 文件
+
+  hosting:
+    - name: Swagger UI
+      type: 自架
+    - name: Redoc
+      type: 自架
+    - name: ReadMe
+      type: SaaS
+    - name: Stoplight
+      type: SaaS

package/bundled/locales/zh-TW/ai/options/documentation/markdown-docs.ai.yaml

@@ -0,0 +1,89 @@
+# Markdown 文件 - AI 優化選項
+# 父項: documentation
+
+id: markdown-docs
+meta:
+  parent: documentation-structure
+  version: "1.0.0"
+  description: 純 Markdown 文件方法
+  language: zh-TW
+
+best_for:
+  - 開源專案
+  - GitHub/GitLab 託管的專案
+  - 開發者導向的文件
+  - 需要簡單、可攜式文件的專案
+
+structure:
+  root_files:
+    - name: README.md
+      required: true
+      purpose: 專案概覽、快速開始
+    - name: CONTRIBUTING.md
+      required: false
+      purpose: 貢獻指南
+    - name: CHANGELOG.md
+      required: false
+      purpose: 版本歷史
+    - name: LICENSE
+      required: true
+      purpose: 授權檔案
+
+  docs_folder:
+    location: docs/
+    naming: lowercase-kebab-case（小寫連字號）
+    common_files:
+      - getting-started.md（快速開始）
+      - installation.md（安裝）
+      - configuration.md（設定）
+      - api-reference.md（API 參考）
+      - troubleshooting.md（疑難排解）
+      - faq.md（常見問題）
+
+    subdirectories:
+      - name: guides/
+        purpose: 操作指南
+      - name: tutorials/
+        purpose: 逐步教學
+      - name: reference/
+        purpose: API 和設定參考
+      - name: ADR/
+        purpose: 架構決策記錄
+
+rules:
+  - id: root-uppercase
+    trigger: 建立根目錄檔案時
+    instruction: 根目錄文件使用大寫（README、CONTRIBUTING）
+    priority: required
+
+  - id: docs-lowercase-kebab
+    trigger: 建立 docs/ 檔案時
+    instruction: 使用小寫連字號命名（例如 getting-started.md）
+    priority: required
+
+  - id: link-relative
+    trigger: 在文件間連結時
+    instruction: 使用相對路徑進行內部連結
+    priority: required
+
+  - id: include-examples
+    trigger: 記錄功能時
+    instruction: 為所有功能包含程式碼範例
+    priority: recommended
+
+markdown_best_practices:
+  - 使用 ATX 風格標題（#、##、###）
+  - 標題前後空一行
+  - 使用帶語言標示的圍欄式程式碼區塊
+  - 保持每行在 120 字元以內
+  - 對重複的 URL 使用參考式連結
+
+tools:
+  - name: markdownlint
+    purpose: 檢查 markdown 檔案
+  - name: markdown-link-check
+    purpose: 檢查壞掉的連結
+  - name: docsify
+    purpose: 產生文件網站
+  - name: mkdocs
+    purpose: 靜態網站產生器

package/bundled/locales/zh-TW/ai/options/documentation/wiki-style.ai.yaml

@@ -0,0 +1,119 @@
+# Wiki 風格文件 - AI 優化選項
+# 父項: documentation
+
+id: wiki-style
+meta:
+  parent: documentation-structure
+  version: "1.0.0"
+  description: Wiki 風格協作文件
+  language: zh-TW
+
+best_for:
+  - 大型團隊
+  - 內部文件
+  - 知識庫
+  - 頻繁更新的內容
+  - 跨職能團隊
+
+platforms:
+  - name: Confluence
+    vendor: Atlassian
+    best_for: 使用 Jira 的企業團隊
+    features:
+      - 富文本編輯器
+      - 範本
+      - 空間/層級結構
+      - 權限控管
+
+  - name: Notion
+    vendor: Notion Labs
+    best_for: 新創公司、彈性需求
+    features:
+      - 資料庫
+      - 範本
+      - 巢狀頁面
+      - 評論
+
+  - name: GitHub Wiki
+    vendor: GitHub
+    best_for: 開源、開發者
+    features:
+      - Git 支援
+      - Markdown
+      - 隨儲存庫免費
+
+  - name: GitBook
+    vendor: GitBook
+    best_for: 公開文件
+    features:
+      - Git 同步
+      - 美觀介面
+      - API 文件支援
+
+structure:
+  top_level_spaces:
+    - name: 工程
+      content:
+        - 架構決策
+        - 技術標準
+        - 操作手冊
+    - name: 產品
+      content:
+        - 功能規格
+        - 路線圖
+        - 使用者研究
+    - name: 團隊
+      content:
+        - 入職文件
+        - 流程文件
+        - 會議紀錄
+
+  page_hierarchy:
+    - 概覽/索引頁
+    - 分類頁面
+    - 詳細頁面
+    - 相關連結
+
+rules:
+  - id: page-ownership
+    trigger: 建立 wiki 頁面時
+    instruction: 指派一位負責保持內容更新的擁有者
+    priority: required
+
+  - id: date-pages
+    trigger: 建立/更新頁面時
+    instruction: 包含最後更新日期
+    priority: required
+
+  - id: link-related
+    trigger: 建立頁面時
+    instruction: 連結到相關頁面以提高可發現性
+    priority: recommended
+
+  - id: review-quarterly
+    trigger: 每季審查時
+    instruction: 審查並更新過時的內容
+    priority: recommended
+
+  - id: archive-obsolete
+    trigger: 內容過時時
+    instruction: 封存而非刪除
+    priority: recommended
+
+comparison:
+  columns: [面向, Wiki, 儲存庫中的 Markdown, 外部文件網站]
+  rows:
+    - [編輯, 所見即所得/容易, 需要 Git 知識, 視情況]
+    - [版本控制, 內建, 基於 Git, 視平台]
+    - [協作, 優秀, 良好, 良好]
+    - [搜尋, 內建, GitHub 搜尋, 視情況]
+    - [存取控制, 細緻, 儲存庫層級, 視情況]
+    - [離線存取, 有限, 完整, 有限]
+
+best_practices:
+  - 為常見頁面類型建立範本
+  - 使用一致的命名慣例
+  - 移動頁面時設定重新導向
+  - 定期內容稽核
+  - 鼓勵評論和提問
+  - 頁面之間大量連結

package/bundled/locales/zh-TW/ai/options/git-workflow/gitflow.ai.yaml

@@ -0,0 +1,133 @@
+# GitFlow - AI 優化選項
+# 父項: git-workflow
+
+id: gitflow
+meta:
+  parent: git-workflow
+  version: "1.0.0"
+  description: 結構化的發布管理工作流程
+  language: zh-TW
+
+best_for:
+  - 排程發布（每月或更長）
+  - 多版本維護
+  - 大型團隊 (10+ 人)
+  - 企業環境
+
+branches:
+  - name: main
+    purpose: 正式發布的程式碼
+    lifetime: 永久
+    protected: true
+
+  - name: develop
+    purpose: 整合分支，下一版開發
+    lifetime: 永久
+    base: main
+
+  - name: feature/*
+    purpose: 新功能開發
+    lifetime: 短期
+    base: develop
+    merge_to: develop
+
+  - name: release/*
+    purpose: 發布準備和穩定化
+    lifetime: 中期（1-2 週）
+    base: develop
+    merge_to: [main, develop]
+
+  - name: hotfix/*
+    purpose: 緊急正式環境修正
+    lifetime: 非常短期（小時到天）
+    base: main
+    merge_to: [main, develop]
+
+rules:
+  - id: no-direct-main-commits
+    trigger: 提交程式碼時
+    instruction: 永不直接提交到 main；使用 release 或 hotfix 分支
+    priority: required
+
+  - id: feature-from-develop
+    trigger: 開始新功能時
+    instruction: 從 develop 建立功能分支
+    priority: required
+
+  - id: release-freeze
+    trigger: 建立發布分支時
+    instruction: 發布分支只允許錯誤修正，不加新功能
+    priority: required
+
+  - id: hotfix-dual-merge
+    trigger: 完成 hotfix 時
+    instruction: 合併 hotfix 到 main 和 develop
+    priority: required
+
+workflow:
+  feature:
+    - step: 建立功能分支
+      commands:
+        - git checkout develop
+        - git pull origin develop
+        - git checkout -b feature/{功能名稱}
+
+    - step: 開發功能
+      commands:
+        - "# 進行變更..."
+        - git add .
+        - git commit -m "feat: {描述}"
+
+    - step: 合併到 develop
+      commands:
+        - git checkout develop
+        - git merge --no-ff feature/{功能名稱}
+        - git branch -d feature/{功能名稱}
+
+  release:
+    - step: 建立發布分支
+      commands:
+        - git checkout develop
+        - git checkout -b release/v{版本}
+
+    - step: 準備發布
+      commands:
+        - "# 更新版本號"
+        - "# 更新 CHANGELOG"
+        - "# 最終測試和錯誤修正"
+
+    - step: 完成發布
+      commands:
+        - git checkout main
+        - git merge --no-ff release/v{版本}
+        - git tag -a v{版本} -m "Release v{版本}"
+        - git checkout develop
+        - git merge --no-ff release/v{版本}
+        - git branch -d release/v{版本}
+
+  hotfix:
+    - step: 建立 hotfix 分支
+      commands:
+        - git checkout main
+        - git checkout -b hotfix/{問題}
+
+    - step: 修正並完成
+      commands:
+        - "# 修正問題"
+        - git commit -m "fix: {描述}"
+        - git checkout main
+        - git merge --no-ff hotfix/{問題}
+        - git tag -a v{版本}
+        - git checkout develop
+        - git merge --no-ff hotfix/{問題}
+        - git branch -d hotfix/{問題}
+
+quick_reference:
+  branches:
+    columns: [分支, 用途, 來源, 合併到]
+    rows:
+      - [main, 正式發布, -, -]
+      - [develop, 整合, main, -]
+      - [feature/*, 新功能, develop, develop]
+      - [release/*, 發布準備, develop, "main, develop"]
+      - [hotfix/*, 緊急修正, main, "main, develop"]

package/bundled/locales/zh-TW/ai/options/git-workflow/github-flow.ai.yaml

@@ -0,0 +1,73 @@
+# GitHub Flow - AI 優化選項
+# 父項: git-workflow
+
+id: github-flow
+meta:
+  parent: git-workflow
+  version: "1.0.0"
+  description: 簡單的持續部署工作流程
+  language: zh-TW
+
+best_for:
+  - 持續部署
+  - 網頁應用程式
+  - 小到中型團隊 (5-15 人)
+
+branches:
+  - name: main
+    purpose: 永遠可部署的正式程式碼
+    lifetime: 永久
+
+  - name: feature/*
+    purpose: 新功能或修正
+    lifetime: 短期（通常 1-3 天）
+    base: main
+    merge_to: main
+
+rules:
+  - id: main-always-deployable
+    trigger: 合併到 main 時
+    instruction: 確保所有測試在合併前通過
+    priority: required
+
+  - id: short-lived-branches
+    trigger: 建立功能分支時
+    instruction: 保持分支短期（理想狀況少於 3 天）
+    priority: recommended
+
+  - id: pr-required
+    trigger: 合併變更時
+    instruction: 透過 Pull Request 合併所有變更
+    priority: required
+
+workflow:
+  - step: 建立分支
+    description: 從 main 建立功能分支
+    commands:
+      - git checkout main
+      - git pull origin main
+      - git checkout -b feature/{功能名稱}
+
+  - step: 進行變更
+    description: 開發並在本地測試
+    commands:
+      - "# 進行變更..."
+      - git add .
+      - git commit -m "feat: {描述}"
+
+  - step: 推送並建立 PR
+    description: 推送到遠端並開啟 Pull Request
+    commands:
+      - git push -u origin feature/{功能名稱}
+      - "# 在 GitHub/GitLab 上建立 Pull Request"
+
+  - step: 審查與合併
+    description: 取得審查並合併
+    commands:
+      - "# 取得程式碼審查"
+      - "# 通過 CI 後合併"
+
+  - step: 部署
+    description: 自動或手動部署到正式環境
+    commands:
+      - "# 從 main 自動部署"