@aigne/doc-smith 0.8.11-beta.5 → 0.8.11-beta.7

package/docs/configuration-preferences.md

@@ -9,60 +9,75 @@ The following diagram illustrates how your feedback becomes a reusable rule that
 ```d2 The Preference Lifecycle
 direction: down
 
-feedback: {
-  label: "1. User provides feedback\nduring 'refine' or 'translate'"
-  shape: rectangle
+developer: {
+  label: "Developer"
+  shape: person
 }
 
-refiner: {
-  label: "2. Feedback Refiner Agent\nAnalyzes feedback"
+docsmith_system: {
+  label: "AIGNE DocSmith System"
   shape: rectangle
-}
 
-decision: {
-  label: "Is it a reusable policy?"
-  shape: diamond
+  cli: {
+    label: "CLI Command\n(refine / translate)"
+    shape: rectangle
+  }
+
+  agent: {
+    label: "Internal Analysis Agent"
+    shape: rectangle
+  }
+
+  decision: {
+    label: "Is feedback a\nreusable policy?"
+    shape: diamond
+  }
+
+  create_rule: {
+    label: "Create New Preference Rule"
+    shape: rectangle
+  }
 }
 
-pref_file: {
-  label: "3. preferences.yml\nRule is saved"
+preferences_file: {
+  label: ".aigne/doc-smith/preferences.yml"
   shape: cylinder
 }
 
-future_tasks: {
-  label: "4. Future Tasks\nSaved rules are applied"
-  shape: rectangle
+one_time_fix: {
+  label: "Apply as a one-time fix"
+  shape: oval
 }
 
-cli: {
-  label: "5. CLI Management\n('aigne doc prefs')"
-  shape: rectangle
-}
-
-feedback -> refiner: "Input"
-refiner -> decision: "Analyzes"
-decision -> pref_file: "Yes"
-decision -> "Discard (One-time fix)": "No"
-pref_file -> future_tasks: "Applies to"
-cli <-> pref_file: "Manages"
-
+developer -> docsmith_system.cli: "1. Provides feedback"
+docsmith_system.cli -> docsmith_system.agent: "2. Captures feedback"
+docsmith_system.agent -> docsmith_system.decision: "3. Analyzes"
+docsmith_system.decision -> docsmith_system.create_rule: "Yes"
+docsmith_system.create_rule -> preferences_file: "4. Saves rule to file"
+docsmith_system.decision -> one_time_fix: "No"
 ```
 
 ### How Preferences are Created
 
-When you provide feedback during the `refine` or `translate` stages, an internal agent analyzes your input. It determines if the feedback is a one-time fix (e.g., correcting a typo) or a reusable policy (e.g., "always write code comments in English"). If it represents a lasting instruction, it creates a new preference rule.
+When you provide feedback during the `refine` or `translate` stages, an internal agent analyzes your input. It determines if the feedback is a one-time fix (e.g., correcting a typo) or a reusable policy (e.g., "always write code comments in English"). If it represents a lasting instruction, it creates a new preference rule and saves it to your project's `preferences.yml` file.
 
 ### Rule Properties
 
 Each rule saved in `preferences.yml` has the following structure:
 
-<x-field data-name="id" data-type="string" data-desc="A unique, randomly generated identifier for the rule (e.g., pref_a1b2c3d4e5f6g7h8)."></x-field>
-<x-field data-name="active" data-type="boolean" data-desc="Indicates if the rule is currently enabled. Inactive rules are ignored during generation tasks."></x-field>
-<x-field data-name="scope" data-type="string" data-desc="Defines when the rule should be applied. Valid scopes are 'global', 'structure', 'document', or 'translation'."></x-field>
-<x-field data-name="rule" data-type="string" data-desc="The specific, distilled instruction that will be passed to the AI in future tasks."></x-field>
-<x-field data-name="feedback" data-type="string" data-desc="The original, natural language feedback provided by the user, preserved for reference."></x-field>
-<x-field data-name="createdAt" data-type="string" data-desc="The ISO 8601 timestamp indicating when the rule was created."></x-field>
-<x-field data-name="paths" data-type="string[]" data-required="false" data-desc="An optional list of file paths. If present, the rule only applies to content generated for these specific source files."></x-field>
+<x-field-group>
+  <x-field data-name="id" data-type="string" data-desc="A unique, randomly generated identifier for the rule (e.g., pref_a1b2c3d4e5f6g7h8)."></x-field>
+  <x-field data-name="active" data-type="boolean" data-desc="Indicates if the rule is currently enabled. Inactive rules are ignored during generation tasks."></x-field>
+  <x-field data-name="scope" data-type="string">
+    <x-field-desc markdown>Defines when the rule should be applied. Valid scopes are `global`, `structure`, `document`, or `translation`.</x-field-desc>
+  </x-field>
+  <x-field data-name="rule" data-type="string" data-desc="The specific, distilled instruction that will be passed to the AI in future tasks."></x-field>
+  <x-field data-name="feedback" data-type="string" data-desc="The original, natural language feedback provided by the user, preserved for reference."></x-field>
+  <x-field data-name="createdAt" data-type="string" data-desc="The ISO 8601 timestamp indicating when the rule was created."></x-field>
+  <x-field data-name="paths" data-type="string[]" data-required="false">
+    <x-field-desc markdown>An optional list of file paths. If present, the rule only applies to content generated for these specific source files.</x-field-desc>
+  </x-field>
+</x-field-group>
 
 ## Managing Preferences with the CLI
 
@@ -70,7 +85,7 @@ You can view and manage all your saved preferences using the `aigne doc prefs` c
 
 ### Listing All Preferences
 
-To see all saved preferences, both active and inactive, use the `--list` flag.
+To see a complete list of all saved preferences, both active and inactive, use the `--list` flag.
 
 ```bash List all preferences icon=lucide:terminal
 aigne doc prefs --list
@@ -96,13 +111,13 @@ The command displays a formatted list showing the status, scope, ID, and any pat
 
 ### Deactivating and Reactivating Preferences
 
-If you want to temporarily disable a rule without deleting it, you can toggle its active status using the `--toggle` flag. Running the command without an ID will launch an interactive mode, allowing you to select one or more preferences to toggle.
+If you need to temporarily disable a rule without deleting it, you can toggle its active status with the `--toggle` flag. Running the command without an ID will launch an interactive mode, allowing you to select one or more preferences to toggle.
 
 ```bash Toggle preferences interactively icon=lucide:terminal
 aigne doc prefs --toggle
 ```
 
-To toggle a specific rule directly, provide its ID using the `--id` flag. This corresponds to the `deactivateRule` function, which sets the rule's `active` property to `false`.
+To toggle a specific rule directly, provide its ID using the `--id` flag. This action changes the rule's `active` property.
 
 ```bash Toggle a specific preference icon=lucide:terminal
 aigne doc prefs --toggle --id pref_i9j0k1l2m3n4o5p6
@@ -110,7 +125,7 @@ aigne doc prefs --toggle --id pref_i9j0k1l2m3n4o5p6
 
 ### Removing Preferences
 
-To permanently delete one or more preferences, use the `--remove` flag. This action, which corresponds to the `removeRule` function, cannot be undone.
+To permanently delete one or more preferences, use the `--remove` flag. This action cannot be undone.
 
 For an interactive selection prompt, run the command without an ID.
 
@@ -118,7 +133,7 @@ For an interactive selection prompt, run the command without an ID.
 aigne doc prefs --remove
 ```
 
-To remove a specific rule directly by its ID, use the `--id` flag.
+To remove a specific rule directly, provide its ID using the `--id` flag.
 
 ```bash Remove a specific preference icon=lucide:terminal
 aigne doc prefs --remove --id pref_a1b2c3d4e5f6g7h8
@@ -126,4 +141,4 @@ aigne doc prefs --remove --id pref_a1b2c3d4e5f6g7h8
 
 ## Next Steps
 
-Managing preferences is a key part of tailoring DocSmith to your project's specific needs. For more customization options, explore the main [Configuration Guide](./configuration.md).
+Managing preferences is a key part of tailoring DocSmith to your project's specific needs. For more customization options, explore the main [Configuration Guide](./configuration.md).

package/docs/configuration-preferences.zh-TW.md

@@ -1,90 +1,105 @@
 # 管理偏好設定
 
-AIGNE DocSmith 旨在從您的回饋中學習。當您對生成的內容進行優化或更正時，DocSmith 可以將這些回饋轉換為持久性規則，稱為偏好設定。這些規則確保您特定的風格、結構要求和內容策略在未來的文件任務中得到一致的應用。所有偏好設定都儲存在專案根目錄下的 `.aigne/doc-smith/preferences.yml` 中，這是一個易於閱讀的 YAML 檔案。
+AIGNE DocSmith 的設計旨在從您的回饋中學習。當您優化或修正生成的內容時，DocSmith 可以將該回饋轉化為持久性規則，稱為偏好設定。這些規則確保您特定的風格、結構要求和內容策略在未來的文檔任務中得到一致應用。所有偏好設定都儲存在您專案根目錄下一個人類可讀的 YAML 檔案中，路徑為 `.aigne/doc-smith/preferences.yml`。
 
 ## 偏好設定的生命週期
 
-下圖說明了您的回饋如何成為一個可重複使用的規則，該規則可以應用於未來的任務，並可透過命令列進行管理。
+下圖說明了您的回饋如何成為一個可重複使用的規則，該規則可應用於未來的任務，並可透過命令列進行管理。
 
-```d2 The Preference Lifecycle
+```d2 偏好設定的生命週期
 direction: down
 
-feedback: {
-  label: "1. 使用者在 'refine' 或 'translate' 過程中提供回饋"
-  shape: rectangle
+developer: {
+  label: "開發者"
+  shape: person
 }
 
-refiner: {
-  label: "2. Feedback Refiner Agent\n分析回饋"
+docsmith_system: {
+  label: "AIGNE DocSmith 系統"
   shape: rectangle
-}
 
-decision: {
-  label: "這是一個可重複使用的策略嗎？"
-  shape: diamond
+  cli: {
+    label: "CLI 指令\n(refine / translate)"
+    shape: rectangle
+  }
+
+  agent: {
+    label: "內部分析 Agent"
+    shape: rectangle
+  }
+
+  decision: {
+    label: "回饋是否為\n可重複使用的策略？"
+    shape: diamond
+  }
+
+  create_rule: {
+    label: "建立新的偏好設定規則"
+    shape: rectangle
+  }
 }
 
-pref_file: {
-  label: "3. preferences.yml\n規則已儲存"
+preferences_file: {
+  label: ".aigne/doc-smith/preferences.yml"
   shape: cylinder
 }
 
-future_tasks: {
-  label: "4. 未來的任務\n已儲存的規則被應用"
-  shape: rectangle
+one_time_fix: {
+  label: "作為一次性修復應用"
+  shape: oval
 }
 
-cli: {
-  label: "5. CLI 管理\n('aigne doc prefs')"
-  shape: rectangle
-}
-
-feedback -> refiner: "輸入"
-refiner -> decision: "分析"
-decision -> pref_file: "是"
-decision -> "捨棄（一次性修復）": "否"
-pref_file -> future_tasks: "應用於"
-cli <-> pref_file: "管理"
-
+developer -> docsmith_system.cli: "1. 提供回饋"
+docsmith_system.cli -> docsmith_system.agent: "2. 捕捉回饋"
+docsmith_system.agent -> docsmith_system.decision: "3. 進行分析"
+docsmith_system.decision -> docsmith_system.create_rule: "是"
+docsmith_system.create_rule -> preferences_file: "4. 將規則儲存至檔案"
+docsmith_system.decision -> one_time_fix: "否"
 ```
 
 ### 如何建立偏好設定
 
-當您在 `refine` 或 `translate` 階段提供回饋時，一個內部 agent 會分析您的輸入。它會判斷該回饋是一次性的修復（例如，更正錯字）還是可重複使用的策略（例如，「總是使用英文撰寫程式碼註解」）。如果它代表一個持久性的指令，就會建立一個新的偏好設定規則。
+當您在 `refine` 或 `translate` 階段提供回饋時，一個內部 Agent 會分析您的輸入。它會判斷該回饋是一次性修復（例如，修正一個錯字）還是可重複使用的策略（例如，「程式碼註解必須以英文撰寫」）。如果它代表一個持久性的指令，它會建立一個新的偏好設定規則，並將其儲存到您專案的 `preferences.yml` 檔案中。
 
 ### 規則屬性
 
 儲存在 `preferences.yml` 中的每個規則都具有以下結構：
 
-<x-field data-name="id" data-type="string" data-desc="規則的唯一、隨機產生的識別碼（例如，pref_a1b2c3d4e5f6g7h8）。"></x-field>
-<x-field data-name="active" data-type="boolean" data-desc="表示該規則目前是否啟用。未啟用的規則在生成任務期間會被忽略。"></x-field>
-<x-field data-name="scope" data-type="string" data-desc="定義該規則應在何時應用。有效的範圍是 'global'、'structure'、'document' 或 'translation'。"></x-field>
-<x-field data-name="rule" data-type="string" data-desc="將在未來任務中傳遞給 AI 的具體、精煉的指令。"></x-field>
-<x-field data-name="feedback" data-type="string" data-desc="使用者提供的原始自然語言回饋，保留以供參考。"></x-field>
-<x-field data-name="createdAt" data-type="string" data-desc="表示規則建立時間的 ISO 8601 時間戳記。"></x-field>
-<x-field data-name="paths" data-type="string[]" data-required="false" data-desc="一個可選的檔案路徑列表。如果存在，該規則僅適用於為這些特定來源檔案生成的內容。"></x-field>
+<x-field-group>
+  <x-field data-name="id" data-type="string" data-desc="規則的唯一隨機生成識別碼（例如：pref_a1b2c3d4e5f6g7h8）。"></x-field>
+  <x-field data-name="active" data-type="boolean" data-desc="表示規則目前是否啟用。未啟用的規則在生成任務期間會被忽略。"></x-field>
+  <x-field data-name="scope" data-type="string">
+    <x-field-desc markdown>定義規則應在何時應用。有效的範圍為 `global`、`structure`、`document` 或 `translation`。</x-field-desc>
+  </x-field>
+  <x-field data-name="rule" data-type="string" data-desc="在未來任務中將傳遞給 AI 的具體、精煉的指令。"></x-field>
+  <x-field data-name="feedback" data-type="string" data-desc="使用者提供的原始自然語言回饋，保留以供參考。"></x-field>
+  <x-field data-name="createdAt" data-type="string" data-desc="表示規則建立時間的 ISO 8601 時間戳記。"></x-field>
+  <x-field data-name="paths" data-type="string[]" data-required="false">
+    <x-field-desc markdown>可選的檔案路徑列表。如果存在，此規則僅適用於為這些特定來源檔案生成的內容。</x-field-desc>
+  </x-field>
+</x-field-group>
 
 ## 使用 CLI 管理偏好設定
 
-您可以使用 `aigne doc prefs` 命令來查看和管理所有已儲存的偏好設定。這讓您可以列出、啟用、停用或永久移除規則。
+您可以使用 `aigne doc prefs` 指令來檢視和管理所有已儲存的偏好設定。這讓您可以列出、啟用、停用或永久移除規則。
 
 ### 列出所有偏好設定
 
-若要查看所有已儲存的偏好設定，包括啟用和未啟用的，請使用 `--list` 旗標。
+要查看所有已儲存偏好設定的完整列表（包括啟用和未啟用的），請使用 `--list` 標記。
 
-```bash List all preferences icon=lucide:terminal
+```bash 列出所有偏好設定 icon=lucide:terminal
 aigne doc prefs --list
 ```
 
-該命令會顯示一個格式化的列表，顯示每個規則的狀態、範圍、ID 和任何路徑限制。
+該指令會顯示一個格式化的列表，顯示每個規則的狀態、範圍、ID 以及任何路徑限制。
 
-```text Example Output icon=lucide:clipboard-list
+```text 輸出範例 icon=lucide:clipboard-list
 # 使用者偏好設定
 
 **格式說明：**
 - 🟢 = 啟用中的偏好設定，⚪ = 未啟用的偏好設定
 - [scope] = 偏好設定範圍 (global, structure, document, translation)
-- ID = 唯一的偏好設定識別碼
+- ID = 唯一偏好設定識別碼
 - Paths = 特定檔案路徑（如果適用）
 
 🟢 [structure] pref_a1b2c3d4e5f6g7h8 | Paths: overview.md
@@ -94,36 +109,36 @@ aigne doc prefs --list
    程式碼註解必須以英文撰寫。
 ```
 
-### 停用和重新啟用偏好設定
+### 停用與重新啟用偏好設定
 
-如果您想暫時停用某個規則而不刪除它，可以使用 `--toggle` 旗標來切換其啟用狀態。在沒有 ID 的情況下執行該命令將啟動互動模式，讓您可以選擇一個或多個偏好設定進行切換。
+如果您需要暫時停用一個規則而不刪除它，您可以使用 `--toggle` 標記來切換其啟用狀態。若執行指令時不帶 ID，將會啟動互動模式，讓您選擇一個或多個偏好設定進行切換。
 
-```bash Toggle preferences interactively icon=lucide:terminal
+```bash 以互動模式切換偏好設定 icon=lucide:terminal
 aigne doc prefs --toggle
 ```
 
-若要直接切換特定規則，請使用 `--id` 旗標提供其 ID。這對應於 `deactivateRule` 函式，該函式會將規則的 `active` 屬性設定為 `false`。
+要直接切換特定規則，請使用 `--id` 標記提供其 ID。此操作會更改規則的 `active` 屬性。
 
-```bash Toggle a specific preference icon=lucide:terminal
+```bash 切換特定偏好設定 icon=lucide:terminal
 aigne doc prefs --toggle --id pref_i9j0k1l2m3n4o5p6
 ```
 
 ### 移除偏好設定
 
-若要永久刪除一個或多個偏好設定，請使用 `--remove` 旗標。此操作對應於 `removeRule` 函式，且無法復原。
+要永久刪除一個或多個偏好設定，請使用 `--remove` 標記。此操作無法復原。
 
-若要進入互動式選擇提示，請在不帶 ID 的情況下執行此命令。
+若要進入互動式選擇提示，請在不帶 ID 的情況下執行該指令。
 
-```bash Remove preferences interactively icon=lucide:terminal
+```bash 以互動模式移除偏好設定 icon=lucide:terminal
 aigne doc prefs --remove
 ```
 
-若要透過 ID 直接移除特定規則，請使用 `--id` 旗標。
+要直接移除特定規則，請使用 `--id` 標記提供其 ID。
 
-```bash Remove a specific preference icon=lucide:terminal
+```bash 移除特定偏好設定 icon=lucide:terminal
 aigne doc prefs --remove --id pref_a1b2c3d4e5f6g7h8
 ```
 
 ## 後續步驟
 
-管理偏好設定是根據專案特定需求量身打造 DocSmith 的關鍵部分。若要了解更多自訂選項，請探索主要的 [設定指南](./configuration.md)。
+管理偏好設定是根據您專案的特定需求量身打造 DocSmith 的關鍵部分。如需更多自訂選項，請探索主要的[設定指南](./configuration.md)。

package/docs/configuration-preferences.zh.md

@@ -1,68 +1,83 @@
 # 管理偏好设置
 
-AIGNE DocSmith 旨在从您的反馈中学习。当您优化或更正生成的内容时，DocSmith 可以将该反馈转换为持久性规则，称为偏好设置。这些规则确保您特定的风格、结构要求和内容策略在未来的文档任务中得到一致的应用。所有偏好设置都存储在项目根目录下一个人类可读的 YAML 文件中，路径为 `.aigne/doc-smith/preferences.yml`。
+AIGNE DocSmith 旨在从您的反馈中学习。当您优化或纠正生成的内容时，DocSmith 可以将该反馈转换为持久性规则，称为偏好设置。这些规则确保您特定的风格、结构要求和内容策略在未来的文档任务中得到一致的应用。所有偏好设置都存储在位于您项目根目录下的一个人类可读的 YAML 文件中：`.aigne/doc-smith/preferences.yml`。
 
 ## 偏好设置的生命周期
 
-下图说明了您的反馈如何成为一个可重用的规则，该规则可以应用于未来的任务，并可以通过命令行进行管理。
+下图说明了您的反馈如何成为一个可重用的规则，该规则可以应用于未来的任务并通过命令行进行管理。
 
 ```d2 偏好设置的生命周期
 direction: down
 
-feedback: {
-  label: "1. 用户在“优化”或“翻译”期间\n提供反馈"
-  shape: rectangle
+developer: {
+  label: "开发者"
+  shape: person
 }
 
-refiner: {
-  label: "2. 反馈优化 Agent\n分析反馈"
+docsmith_system: {
+  label: "AIGNE DocSmith 系统"
   shape: rectangle
-}
 
-decision: {
-  label: "这是一个可重用的策略吗？"
-  shape: diamond
+  cli: {
+    label: "CLI 命令\n(refine / translate)"
+    shape: rectangle
+  }
+
+  agent: {
+    label: "内部分析 Agent"
+    shape: rectangle
+  }
+
+  decision: {
+    label: "反馈是否为\n可重用策略？"
+    shape: diamond
+  }
+
+  create_rule: {
+    label: "创建新偏好规则"
+    shape: rectangle
+  }
 }
 
-pref_file: {
-  label: "3. preferences.yml\n规则已保存"
+preferences_file: {
+  label: ".aigne/doc-smith/preferences.yml"
   shape: cylinder
 }
 
-future_tasks: {
-  label: "4. 未来的任务\n应用已保存的规则"
-  shape: rectangle
-}
-
-cli: {
-  label: "5. CLI 管理\n('aigne doc prefs')"
-  shape: rectangle
+one_time_fix: {
+  label: "作为一次性修复应用"
+  shape: oval
 }
 
-feedback -> refiner: "输入"
-refiner -> decision: "分析"
-decision -> pref_file: "是"
-decision -> "丢弃（一次性修复）": "否"
-pref_file -> future_tasks: "应用于"
-cli <-> pref_file: "管理"
-
+developer -> docsmith_system.cli: "1. 提供反馈"
+docsmith_system.cli -> docsmith_system.agent: "2. 捕获反馈"
+docsmith_system.agent -> docsmith_system.decision: "3. 分析"
+docsmith_system.decision -> docsmith_system.create_rule: "是"
+docsmith_system.create_rule -> preferences_file: "4. 将规则保存到文件"
+docsmith_system.decision -> one_time_fix: "否"
 ```
 
 ### 如何创建偏好设置
 
-当您在 `refine` 或 `translate` 阶段提供反馈时，一个内部 Agent 会分析您的输入。它会判断反馈是一次性修复（例如，更正拼写错误）还是可重用的策略（例如，“始终用英语编写代码注释”）。如果它代表一个持久的指令，它就会创建一个新的偏好设置规则。
+当您在 `refine` 或 `translate` 阶段提供反馈时，一个内部 Agent 会分析您的输入。它会判断该反馈是一次性修复（例如，纠正拼写错误）还是可重用策略（例如，“代码注释必须用英文编写”）。如果它代表一个持久性指令，Agent 就会创建一条新的偏好规则并将其保存到您项目的 `preferences.yml` 文件中。
 
 ### 规则属性
 
-保存在 `preferences.yml` 中的每个规则都具有以下结构：
-
-<x-field data-name="id" data-type="string" data-desc="规则的唯一、随机生成的标识符（例如，pref_a1b2c3d4e5f6g7h8）。"></x-field>
-<x-field data-name="active" data-type="boolean" data-desc="指示规则当前是否已启用。在生成任务期间，非活动规则将被忽略。"></x-field>
-<x-field data-name="scope" data-type="string" data-desc="定义规则应在何时应用。有效范围是 'global'、'structure'、'document' 或 'translation'。"></x-field>
-<x-field data-name="rule" data-type="string" data-desc="将在未来任务中传递给 AI 的具体、精炼的指令。"></x-field>
-<x-field data-name="feedback" data-type="string" data-desc="用户提供的原始自然语言反馈，保留以供参考。"></x-field>
-<x-field data-name="createdAt" data-type="string" data-desc="表示规则创建时间的 ISO 8601 时间戳。"></x-field>
-<x-field data-name="paths" data-type="string[]" data-required="false" data-desc="一个可选的文件路径列表。如果存在，该规则仅适用于为这些特定源文件生成的内容。"></x-field>
+保存在 `preferences.yml` 中的每条规则都具有以下结构：
+
+<x-field-group>
+  <x-field data-name="id" data-type="string" data-desc="规则的唯一、随机生成的标识符（例如，pref_a1b2c3d4e5f6g7h8）。"></x-field>
+  <x-field data-name="active" data-type="boolean" data-desc="指示规则当前是否已启用。未激活的规则在生成任务期间将被忽略。"></x-field>
+  <x-field data-name="scope" data-type="string">
+    <x-field-desc markdown>定义规则何时应用。有效范围是 `global`、`structure`、`document` 或 `translation`。</x-field-desc>
+  </x-field>
+  <x-field data-name="rule" data-type="string" data-desc="将在未来任务中传递给 AI 的具体、提炼后的指令。"></x-field>
+  <x-field data-name="feedback" data-type="string" data-desc="用户提供的原始自然语言反馈，保留以供参考。"></x-field>
+  <x-field data-name="createdAt" data-type="string" data-desc="指示规则创建时间的 ISO 8601 时间戳。"></x-field>
+  <x-field data-name="paths" data-type="string[]" data-required="false">
+    <x-field-desc markdown>一个可选的文件路径列表。如果存在，该规则仅适用于为这些特定源文件生成的内容。</x-field-desc>
+  </x-field>
+</x-field-group>
 
 ## 使用 CLI 管理偏好设置
 
@@ -70,39 +85,39 @@ cli <-> pref_file: "管理"
 
 ### 列出所有偏好设置
 
-要查看所有已保存的偏好设置（包括活动的和非活动的），请使用 `--list` 标志。
+要查看所有已保存的偏好设置（包括激活和未激活的）的完整列表，请使用 `--list` 标志。
 
 ```bash 列出所有偏好设置 icon=lucide:terminal
 aigne doc prefs --list
 ```
 
-该命令会显示一个格式化的列表，显示每个规则的状态、范围、ID 和任何路径限制。
+该命令会显示一个格式化的列表，其中显示了每条规则的状态、范围、ID 以及任何路径限制。
 
-```text 示例输出 icon=lucide:clipboard-list
+```text 输出示例 icon=lucide:clipboard-list
 # 用户偏好设置
 
 **格式说明：**
-- 🟢 = 活动偏好设置，⚪ = 非活动偏好设置
-- [scope] = 偏好设置范围 (global, structure, document, translation)
-- ID = 唯一偏好设置标识符
-- Paths = 特定文件路径（如果适用）
+- 🟢 = 激活的偏好设置, ⚪ = 未激活的偏好设置
+- [scope] = 偏好范围 (global, structure, document, translation)
+- ID = 唯一偏好标识符
+- Paths = 特定文件路径 (如果适用)
 
 🟢 [structure] pref_a1b2c3d4e5f6g7h8 | Paths: overview.md
-   在概述文档的末尾添加一个“后续步骤”部分。
+   在概览文档末尾添加一个“后续步骤”部分。
  
 ⚪ [document] pref_i9j0k1l2m3n4o5p6
-   代码注释必须用英语编写。
+   代码注释必须用英文编写。
 ```
 
 ### 停用和重新激活偏好设置
 
-如果您想暂时禁用某个规则而不删除它，可以使用 `--toggle` 标志来切换其活动状态。在不带 ID 的情况下运行该命令将启动交互模式，允许您选择一个或多个偏好设置进行切换。
+如果您需要暂时禁用某条规则而不删除它，可以使用 `--toggle` 标志切换其激活状态。在不带 ID 的情况下运行该命令将启动交互模式，允许您选择一个或多个偏好设置进行切换。
 
 ```bash 以交互方式切换偏好设置 icon=lucide:terminal
 aigne doc prefs --toggle
 ```
 
-要直接切换特定规则，请使用 `--id` 标志提供其 ID。这对应于 `deactivateRule` 函数，该函数将规则的 `active` 属性设置为 `false`。
+要直接切换特定规则，请使用 `--id` 标志提供其 ID。此操作会更改规则的 `active` 属性。
 
 ```bash 切换特定偏好设置 icon=lucide:terminal
 aigne doc prefs --toggle --id pref_i9j0k1l2m3n4o5p6
@@ -110,15 +125,15 @@ aigne doc prefs --toggle --id pref_i9j0k1l2m3n4o5p6
 
 ### 删除偏好设置
 
-要永久删除一个或多个偏好设置，请使用 `--remove` 标志。此操作对应于 `removeRule` 函数，且无法撤销。
+要永久删除一个或多个偏好设置，请使用 `--remove` 标志。此操作无法撤销。
 
-要进入交互式选择提示，请在不带 ID 的情况下运行该命令。
+要获得交互式选择提示，请在不带 ID 的情况下运行该命令。
 
 ```bash 以交互方式删除偏好设置 icon=lucide:terminal
 aigne doc prefs --remove
 ```
 
-要通过其 ID 直接删除特定规则，请使用 `--id` 标志。
+要直接删除特定规则，请使用 `--id` 标志提供其 ID。
 
 ```bash 删除特定偏好设置 icon=lucide:terminal
 aigne doc prefs --remove --id pref_a1b2c3d4e5f6g7h8
@@ -126,4 +141,4 @@ aigne doc prefs --remove --id pref_a1b2c3d4e5f6g7h8
 
 ## 后续步骤
 
-管理偏好设置是根据项目特定需求定制 DocSmith 的关键部分。要了解更多自定义选项，请探索主要的[配置指南](./configuration.md)。
+管理偏好设置是根据项目特定需求定制 DocSmith 的关键部分。有关更多自定义选项，请浏览主要的[配置指南](./configuration.md)。