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

package/bundled/locales/zh-CN/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-CN
+
+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-CN/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-CN
+
+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-CN/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-CN
+
+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-CN/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-CN
+
+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-CN/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-CN
+
+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-CN/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-CN
+
+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 自动部署"