@aigne/doc-smith 0.8.12-beta.8 → 0.8.12

package/docs/configuration-initial-setup.md

@@ -1,198 +0,0 @@
-# Initial Setup
-
-This document provides a step-by-step guide to the interactive setup process for AIGNE DocSmith. This procedure is initiated automatically the first time you run the `aigne doc generate` command, or it can be started manually. The objective is to create a `config.yaml` file that stores your preferences for generating documentation.
-
-## How to Start the Setup Process
-
-To begin the configuration manually, navigate to your project's root directory in a terminal and execute the following command:
-
-```bash
-aigne doc init
-```
-
-This command launches an interactive questionnaire to configure your documentation settings. The process consists of 10 steps designed to tailor the generated documentation to your specific requirements.
-
-## Configuration Steps
-
-The setup process will prompt you with a series of questions. The following sections detail each step.
-
-### Step 1: Define Documentation Purpose
-
-The first step is to define the primary goals of your documentation. This selection influences the tone, structure, and focus of the generated content.
-
-**Prompt:** `📝 [1/10]: What should your documentation help readers achieve?`
-
-You can select one or more options from the following list:
-
-| Option | Name | Description |
-| :--- | :--- | :--- |
-| `getStarted` | Get started quickly | Help new users go from zero to working in <30 minutes. |
-| `completeTasks` | Complete specific tasks | Guide users through common workflows and use cases. |
-| `findAnswers` | Find answers fast | Provide a searchable reference for all features and APIs. |
-| `understandSystem` | Understand the system | Explain how it works and the reasoning behind design decisions. |
-| `solveProblems` | Solve problems | Help users troubleshoot and fix issues. |
-| `mixedPurpose` | Mix of above | Cover multiple needs. |
-
-### Step 2: Identify Target Audience
-
-Next, specify the primary readers of your documentation. This helps to adjust the language and technical depth appropriately.
-
-**Prompt:** `👥 [2/10]: Who will be reading your documentation?`
-
-You may select multiple audiences from this list:
-
-| Option | Name | Description |
-| :--- | :--- | :--- |
-| `endUsers` | End users (non-technical) | People who use the product but do not code. |
-| `developers` | Developers integrating | Engineers adding this to their projects. |
-| `devops` | DevOps/Infrastructure | Teams deploying, monitoring, and maintaining systems. |
-| `decisionMakers` | Technical decision makers | Architects or leads evaluating the technology. |
-| `supportTeams` | Support teams | People helping others use the product. |
-| `mixedTechnical` | Mixed technical audience | A combination of developers, DevOps, and other technical users. |
-
-### Step 3: Specify Reader Knowledge Level
-
-Indicate the assumed knowledge level of your audience. This ensures the content is presented at an appropriate level, avoiding information that is either too basic or too complex.
-
-**Prompt:** `🧠 [3/10]: How much do readers already know about your project?`
-
-Select the option that best describes your readers:
-
-| Option | Name | Description |
-| :--- | :--- | :--- |
-| `completeBeginners` | Complete beginners | New to the domain or technology entirely. |
-| `domainFamiliar` | Domain-familiar, tool-new | Know the problem space but are new to this specific solution. |
-| `experiencedUsers` | Experienced users | Regular users who need reference material or advanced topics. |
-| `emergencyTroubleshooting` | Emergency/troubleshooting | Users who need to fix a problem quickly. |
-| `exploringEvaluating` | Exploring/evaluating | Users trying to determine if the tool fits their needs. |
-
-### Step 4: Set Documentation Depth
-
-Choose how detailed the documentation should be. This parameter determines the scope and level of detail in the generated content.
-
-**Prompt:** `📊 [4/10]: How detailed should your documentation be?`
-
-Select one of the following levels:
-
-| Option | Name | Description |
-| :--- | :--- | :--- |
-| `essentialOnly` | Essential only | Covers the most common 80% of use cases concisely. |
-| `balancedCoverage` | Balanced coverage | Provides good depth with practical examples. |
-| `comprehensive` | Comprehensive | Covers all features, edge cases, and advanced scenarios. |
-| `aiDecide` | Let AI decide | The tool analyzes code complexity to suggest an appropriate depth. |
-
-### Step 5: Select Primary Language
-
-Choose the main language for your documentation. The system will detect your operating system's language and suggest it as the default.
-
-**Prompt:** `🌐 [5/10]: What's your main documentation language?`
-
-You can select from a list of 12 supported languages, including English, Chinese (Simplified), and Spanish.
-
-### Step 6: Choose Translation Languages
-
-Select any additional languages into which you want the documentation to be translated.
-
-**Prompt:** `🔄 [6/10]: Which languages should we translate to?`
-
-You can choose multiple languages from the supported options, excluding the primary language selected in the previous step.
-
-### Step 7: Define Documentation Directory
-
-Specify the folder where the generated documentation files will be saved.
-
-**Prompt:** `📁 [7/10]: Where should we save your documentation?`
-
-The default path is `.aigne/doc-smith/docs`. You can accept this default or provide a different path.
-
-### Step 8: Specify Content Sources
-
-Indicate which files and folders the tool should analyze to generate documentation. You can add multiple paths and use glob patterns for more specific file matching.
-
-**Prompt:** `🔍 [8/10]: Content Sources`
-
-You will be prompted to enter file paths, folder paths, or glob patterns (e.g., `src/**/*.js`). If no paths are provided, the tool will analyze the entire project directory by default.
-
-### Step 9: Provide Custom Rules
-
-This optional step allows you to provide specific instructions or constraints for the AI to follow during content generation.
-
-**Prompt:** `📋 [9/10]: Any custom rules or requirements for your documentation? (Optional, press Enter to skip)`
-
-You can input any requirements, such as tone, style, or content to exclude. For example: "Focus on technical accuracy and avoid marketing terminology."
-
-### Step 10: Configure Media Settings
-
-Set a minimum width for images to be included in the documentation. This helps filter out low-resolution images or icons.
-
-**Prompt:** `🖼️ [10/10]: Minimum image width (in pixels) to include in documentation:`
-
-The default value is `800`. You can enter a different positive number to adjust the filter.
-
-## The `config.yaml` File
-
-After you answer all the questions, DocSmith saves your responses to a configuration file named `config.yaml`, located in the `.aigne/doc-smith/` directory of your project. This file acts as the blueprint for all future documentation generation and can be manually edited at any time.
-
-Below is an example of a generated `config.yaml` file:
-
-```yaml config.yaml icon=logos:yaml
-# Project information for documentation publishing
-projectName: AIGNE DocSmith
-projectDesc: AIGNE DocSmith is a powerful, AI-driven documentation generation tool...
-projectLogo: ../assets/screenshots/9645caf64b4232699982c4d940b03b90.svg
-
-# =============================================================================
-# Documentation Configuration
-# =============================================================================
-
-# Purpose: What's the main outcome you want readers to achieve?
-documentPurpose:
-  - getStarted
-  - completeTasks
-
-# Target Audience: Who will be reading this most often?
-targetAudienceTypes:
-  - endUsers
-
-# Reader Knowledge Level: What do readers typically know when they arrive?
-readerKnowledgeLevel: completeBeginners
-
-# Documentation Depth: How comprehensive should the documentation be?
-documentationDepth: comprehensive
-
-# Custom Rules: Define specific documentation generation rules and requirements
-rules: |
-  Avoid using vague or empty words that don't provide measurable or specific details...
-
-# Target Audience: Describe your specific target audience and their characteristics
-targetAudience: |
-  
-# Language settings
-locale: en
-translateLanguages:
-  - zh
-  - zh-TW
-  - ja
-
-# Paths
-docsDir: ./docs  # Directory to save generated documentation
-sourcesPath:  # Source code paths to analyze
-  - ./README.md
-  - ./agents
-
-# =============================================================================
-# Media Settings
-# =============================================================================
-media:
-  minImageWidth: 800
-```
-
-## Summary and Next Steps
-
-Once the setup is complete, you will see a confirmation message.
-
-![Setup Complete](../assets/screenshots/doc-complete-setup.png)
-
-With your initial configuration saved, you are now prepared to create your documentation.
-
-*   To proceed, consult the [Generating Documentation](./guides-generating-documentation.md) guide for instructions on running the generation process.

package/docs/configuration-initial-setup.zh-TW.md

@@ -1,179 +0,0 @@
-# 初始設定
-
-本指南將逐步引導您完成 AIGNE DocSmith 的互動式設定流程。此流程會在您首次執行 `generate` 指令時啟動，也可以手動開始。其目的是建立一個 `config.yaml` 檔案，用來儲存您產生文件的偏好設定。
-
-## 開始流程
-
-若要手動開始設定，請在終端機中導覽至您的專案根目錄，並執行以下指令：
-
-```bash
-aigne doc init
-```
-
-此指令會啟動一個互動式問卷，引導您完成文件設定。
-
-## 設定步驟
-
-設定流程包含九個問題，旨在根據您的特定需求量身打造文件。
-
-### 步驟 1：定義文件目的
-
-首先，系統會請您定義文件的主要目標。這項選擇會影響所產生內容的語氣、結構和重點。
-
-**提示：** `📝 [1/9]：您的文件應幫助讀者達成什麼目標？`
-
-您可以從下表中選取多個選項：
-
-| 選項 | 名稱 | 描述 |
-| :--- | :--- | :--- |
-| `getStarted` | 快速入門 | 幫助新使用者在 30 分鐘內從零到上手。 |
-| `completeTasks` | 完成特定任務 | 引導使用者完成常見的工作流程和使用案例。 |
-| `findAnswers` | 快速尋找答案 | 為所有功能和 API 提供可搜尋的參考資料。 |
-| `understandSystem` | 了解系統 | 解釋其運作方式以及設計決策背後的原因。 |
-| `solveProblems` | 解決問題 | 幫助使用者進行疑難排解和修復問題。 |
-| `mixedPurpose` | 以上混合 | 全面涵蓋多種需求。 |
-
-### 步驟 2：識別目標讀者
-
-接著，請指定文件的主要讀者是誰。這有助於適當地調整語言和技術深度。
-
-**提示：** `👥 [2/9]：誰會閱讀您的文件？`
-
-您可以選取以下一種或多種讀者群：
-
-| 選項 | 名稱 | 描述 |
-| :--- | :--- | :--- |
-| `endUsers` | 終端使用者（非技術人員） | 使用產品但不寫程式的人。 |
-| `developers` | 進行整合的開發者 | 將此產品加入其專案的工程師。 |
-| `devops` | DevOps/基礎架構人員 | 部署、監控和維護系統的團隊。 |
-| `decisionMakers` | 技術決策者 | 評估此技術的架構師或主管。 |
-| `supportTeams` | 支援團隊 | 協助他人使用產品的人員。 |
-| `mixedTechnical` | 混合技術背景的讀者 | 開發者、DevOps 和其他技術使用者的組合。 |
-
-### 步驟 3：提供自訂規則
-
-這個選填步驟讓您可以提供特定的指示或限制，供 AI 在內容生成過程中遵循。
-
-**提示：** `📋 [3/9]：您的文件是否有任何自訂規則或要求？（選填，按 Enter 鍵跳過）`
-
-您可以輸入任何特定要求，例如語氣、風格或要排除的內容。例如：「避免使用行銷語言，並專注於技術準確性。」
-
-### 步驟 4：指定讀者知識水平
-
-請指出您讀者群的預設知識水平。這能確保內容的難易度適中，不會過於基礎或過於複雜。
-
-**提示：** `🧠 [4/9]：讀者對您的專案已經了解多少？`
-
-請選擇最能描述您讀者的選項：
-
-| 選項 | 名稱 | 描述 |
-| :--- | :--- | :--- |
-| `completeBeginners` | 完全的初學者 | 完全不熟悉該領域或技術。 |
-| `domainFamiliar` | 熟悉領域，但對工具陌生 | 了解問題領域，但對此解決方案是新手。 |
-| `experiencedUsers` | 有經驗的使用者 | 需要參考資料或進階主題的常規使用者。 |
-| `emergencyTroubleshooting` | 緊急/疑難排解 | 需要快速解決問題的使用者。 |
-| `exploringEvaluating` | 探索/評估 | 試圖判斷此工具是否符合其需求的使用者。 |
-
-### 步驟 5：設定文件深度
-
-選擇文件的詳細程度。這決定了所產生內容的範圍和詳細程度。
-
-**提示：** `📊 [5/9]：您的文件應該多詳細？`
-
-請選擇以下其中一個詳細程度：
-
-| 選項 | 名稱 | 描述 |
-| :--- | :--- | :--- |
-| `essentialOnly` | 僅含必要內容 | 簡潔地涵蓋 80% 最常見的使用案例。 |
-| `balancedCoverage` | 均衡的涵蓋範圍 | 提供具備實用範例的良好深度。 |
-| `comprehensive` | 全面詳盡 | 涵蓋所有功能、邊界案例和進階情境。 |
-| `aiDecide` | 讓 AI 決定 | 工具會分析程式碼的複雜度，以建議適當的深度。 |
-
-### 步驟 6：選擇主要語言
-
-選擇文件的主要語言。系統會偵測您作業系統的語言，並建議其為預設語言。
-
-**提示：** `🌐 [6/9]：您的主要文件語言是什麼？`
-
-系統將會顯示一份包含 12 種支援語言的清單，包括英語、簡體中文和西班牙語。
-
-### 步驟 7：選擇翻譯語言
-
-選擇您希望將文件翻譯成的其他語言。
-
-**提示：** `🔄 [7/9]：我們應該將文件翻譯成哪些語言？`
-
-您可以從支援的選項清單中選擇多種語言，不包括您在上一步驟中選擇的主要語言。
-
-### 步驟 8：定義輸出目錄
-
-指定儲存所產生文件檔案的資料夾。
-
-**提示：** `📁 [8/9]：我們應該將您的文件儲存在哪裡？`
-
-預設路徑為 `.aigne/doc-smith/docs`。您可以接受此路徑或提供不同的路徑。
-
-### 步驟 9：指定內容來源
-
-指出工具應分析哪些檔案和資料夾以產生文件。您可以新增多個路徑，並使用 glob 模式進行進階篩選。
-
-**提示：** `🔍 [9/9]：內容來源`
-
-系統會提示您輸入檔案路徑、資料夾路徑或 glob 模式（例如 `src/**/*.js`）。如果您未提供任何路徑，工具預設會分析整個專案目錄。
-
-## 產生的設定檔
-
-完成問卷後，DocSmith 會將您的回答儲存到位於 `.aigne/doc-smith/` 目錄中名為 `config.yaml` 的設定檔。此檔案將作為未來所有文件產生的藍圖，並且可以隨時手動編輯。
-
-以下是一個產生的 `config.yaml` 檔案範例：
-
-```yaml config.yaml title="config.yaml"
-# 文件發布的專案資訊
-projectName: AIGNE DocSmith
-projectDesc: AIGNE DocSmith is a powerful, AI-driven documentation generation tool...
-projectLogo: https://docsmith.aigne.io/image-bin/uploads/9645caf64b4232699982c4d940b03b90.svg
-
-# =============================================================================
-# 文件設定
-# =============================================================================
-
-# 目的：您希望讀者達成的最主要成果是什麼？
-documentPurpose:
-  - getStarted
-  - completeTasks
-
-# 目標讀者：誰最常閱讀此文件？
-targetAudienceTypes:
-  - endUsers
-
-# 讀者知識水平：讀者在閱讀文件時通常具備哪些知識？
-readerKnowledgeLevel: completeBeginners
-
-# 文件深度：文件應該多全面？
-documentationDepth: comprehensive
-
-# 自訂規則：定義特定的文件產生規則和要求
-rules: |
-  Avoid using vague or empty words...
-
-# 目標讀者：描述您的特定目標讀者及其特徵
-targetAudience: |
-  
-# 語言設定
-locale: en
-translateLanguages:
-  - zh
-  - ja
-
-# 目錄和來源路徑設定
-docsDir: ./docs  # 儲存所產生文件的目錄
-sourcesPath:  # 要分析的原始碼路徑
-  - ./README.md
-  - ./agents
-```
-
-## 後續步驟
-
-初始設定完成後，您現在可以開始建立文件了。
-
-*   請前往 [產生文件](./guides-generating-documentation.md) 指南，了解如何執行產生流程。

package/docs/configuration-initial-setup.zh.md

@@ -1,179 +0,0 @@
-# 初始设置
-
-本指南将分步介绍 AIGNE DocSmith 的交互式设置过程。此过程在您首次运行 `generate` 命令时启动，也可以手动启动。其目的是创建一个 `config.yaml` 文件，用于存储您生成文档的偏好设置。
-
-## 启动过程
-
-要手动开始配置，请在终端中导航到项目的根目录并执行以下命令：
-
-```bash
-aigne doc init
-```
-
-此命令会启动一个交互式问卷，引导您完成文档设置的配置。
-
-## 配置步骤
-
-设置过程包括九个问题，旨在根据您的具体需求定制文档。
-
-### 步骤 1：定义文档目的
-
-首先，您需要定义文档的主要目标。此选择会影响生成内容的基调、结构和重点。
-
-**提示：** `📝 [1/9]：您的文档应帮助读者实现什么目标？`
-
-您可以从下面的列表中选择多个选项：
-
-| 选项 | 名称 | 描述 |
-| :--- | :--- | :--- |
-| `getStarted` | 快速入门 | 帮助新用户在 30 分钟内从零开始上手。 |
-| `completeTasks` | 完成特定任务 | 指导用户完成常见工作流和用例。 |
-| `findAnswers` | 快速查找答案 | 为所有功能和 API 提供可搜索的参考。 |
-| `understandSystem` | 理解系统 | 解释其工作原理及设计决策背后的原因。 |
-| `solveProblems` | 解决问题 | 帮助用户排查和修复问题。 |
-| `mixedPurpose` | 以上混合 | 全面覆盖多种需求。 |
-
-### 步骤 2：确定目标受众
-
-接下来，指定谁将是您文档的主要读者。这有助于适当地调整语言和技术深度。
-
-**提示：** `👥 [2/9]：谁将是您文档的读者？`
-
-您可以选择以下一个或多个受众：
-
-| 选项 | 名称 | 描述 |
-| :--- | :--- | :--- |
-| `endUsers` | 最终用户（非技术人员） | 使用产品但不编码的人员。 |
-| `developers` | 集成开发者 | 将此产品添加到其项目中的工程师。 |
-| `devops` | DevOps/基础设施 | 部署、监控和维护系统的团队。 |
-| `decisionMakers` | 技术决策者 | 评估该技术的架构师或负责人。 |
-| `supportTeams` | 支持团队 | 帮助他人使用产品的人员。 |
-| `mixedTechnical` | 混合技术受众 | 开发人员、DevOps 和其他技术用户的组合。 |
-
-### 步骤 3：提供自定义规则
-
-此可选步骤允许您提供具体说明或约束，供 AI 在内容生成过程中遵循。
-
-**提示：** `📋 [3/9]：对您的文档有任何自定义规则或要求吗？（可选，按 Enter 键跳过）`
-
-您可以输入任何具体要求，例如语气、风格或要排除的内容。例如：“避免使用营销性语言，专注于技术准确性。”
-
-### 步骤 4：指定读者知识水平
-
-指明您受众的假定知识水平。这能确保内容难度适中，既不会过于基础，也不会过于复杂。
-
-**提示：** `🧠 [4/9]：读者对您的项目了解多少？`
-
-选择最能描述您读者的选项：
-
-| 选项 | 名称 | 描述 |
-| :--- | :--- | :--- |
-| `completeBeginners` | 完全初学者 | 完全不熟悉该领域或技术。 |
-| `domainFamiliar` | 熟悉领域，不熟悉工具 | 了解问题领域，但对该解决方案不熟悉。 |
-| `experiencedUsers` | 经验丰富的用户 | 需要参考或高级主题的常规用户。 |
-| `emergencyTroubleshooting` | 紧急/故障排查 | 需要快速解决问题的用户。 |
-| `exploringEvaluating` | 探索/评估 | 试图确定该工具是否满足其需求的用户。 |
-
-### 步骤 5：设置文档深度
-
-选择文档的详细程度。这决定了生成内容的范围和细节水平。
-
-**提示：** `📊 [5/9]：您的文档应该有多详细？`
-
-选择以下详细级别之一：
-
-| 选项 | 名称 | 描述 |
-| :--- | :--- | :--- |
-| `essentialOnly` | 仅包含核心内容 | 简明扼要地覆盖 80% 的最常见用例。 |
-| `balancedCoverage` | 平衡覆盖 | 提供良好深度和实用示例。 |
-| `comprehensive` | 全面详尽 | 覆盖所有功能、边缘案例和高级场景。 |
-| `aiDecide` | 由 AI 决定 | 工具会分析代码复杂度以建议合适的深度。 |
-
-### 步骤 6：选择主要语言
-
-选择您文档的主要语言。系统将检测您操作系统的语言并建议其为默认语言。
-
-**提示：** `🌐 [6/9]：您的主要文档语言是什么？`
-
-系统将为您呈现一个包含 12 种受支持语言的列表，包括英语、中文（简体）和西班牙语。
-
-### 步骤 7：选择翻译语言
-
-选择您希望将文档翻译成的其他语言。
-
-**提示：** `🔄 [7/9]：我们应该翻译成哪些语言？`
-
-您可以从支持的选项列表中选择多种语言，不包括您在上一步中选择的主要语言。
-
-### 步骤 8：定义输出目录
-
-指定保存生成的文档文件的文件夹。
-
-**提示：** `📁 [8/9]：我们应该将您的文档保存在哪里？`
-
-默认路径是 `.aigne/doc-smith/docs`。您可以接受此路径或提供其他路径。
-
-### 步骤 9：指定内容源
-
-指明工具应分析哪些文件和文件夹以生成文档。您可以添加多个路径，并使用 glob 模式进行高级筛选。
-
-**提示：** `🔍 [9/9]：内容源`
-
-系统将提示您输入文件路径、文件夹路径或 glob 模式（例如，`src/**/*.js`）。如果您不提供任何路径，工具将默认分析整个项目目录。
-
-## 生成的配置文件
-
-完成问卷后，DocSmith 会将您的回答保存到 `.aigne/doc-smith/` 目录中一个名为 `config.yaml` 的配置文件中。该文件将作为未来所有文档生成的蓝图，并可随时手动编辑。
-
-以下是生成的 `config.yaml` 文件示例：
-
-```yaml config.yaml title="config.yaml"
-# 用于文档发布的项目信息
-projectName: AIGNE DocSmith
-projectDesc: AIGNE DocSmith is a powerful, AI-driven documentation generation tool...
-projectLogo: https://docsmith.aigne.io/image-bin/uploads/9645caf64b4232699982c4d940b03b90.svg
-
-# =============================================================================
-# 文档配置
-# =============================================================================
-
-# 目的：您希望读者实现的主要成果是什么？
-documentPurpose:
-  - getStarted
-  - completeTasks
-
-# 目标受众：谁会最常阅读本文档？
-targetAudienceTypes:
-  - endUsers
-
-# 读者知识水平：读者通常具备哪些知识？
-readerKnowledgeLevel: completeBeginners
-
-# 文档深度：文档应达到何种程度的全面性？
-documentationDepth: comprehensive
-
-# 自定义规则：定义具体的文档生成规则和要求
-rules: |
-  Avoid using vague or empty words...
-
-# 目标受众：描述您的具体目标受众及其特征
-targetAudience: |
-  
-# 语言设置
-locale: en
-translateLanguages:
-  - zh
-  - ja
-
-# 目录和源路径配置
-docsDir: ./docs  # 保存生成文档的目录
-sourcesPath:  # 要分析的源代码路径
-  - ./README.md
-  - ./agents
-```
-
-## 后续步骤
-
-完成初始配置后，您现在可以开始创建文档了。
-
-*   继续阅读 [生成文档](./guides-generating-documentation.md) 指南，了解如何运行生成过程。

package/docs/configuration-managing-preferences.ja.md

@@ -1,100 +0,0 @@
-# プリファレンスの管理
-
-ドキュメントを生成または更新する際に、`--feedback` フラグを使用してフィードバックを提供できます。このフィードバックは「プリファレンス」として保存され、将来のセッションで再利用されることで、AIが以前の指示との一貫性を維持するようになります。`aigne doc prefs` コマンドは、これらの保存されたプリファレンスを直接管理する方法を提供します。
-
-このガイドでは、保存されたプリファレンスのリスト表示、削除、およびアクティブ状態の切り替え方法について詳しく説明します。
-
-## 保存されたプリファレンスの表示
-
-保存されているすべてのプリファレンスを確認するには、`--list` フラグを使用します。このコマンドは、各プリファレンスをそのステータス、スコープ、一意のID、および内容とともに表示します。
-
-```bash
-aigne doc prefs --list
-```
-
-### 出力の理解
-
-リストは、各プリファレンスルールに関する明確な情報を提供するようにフォーマットされています：
-
-*   **ステータス**: プリファレンスがアクティブか非アクティブかを示します。
-    *   `🟢`: アクティブ。ルールはドキュメント生成中に適用されます。
-    *   `⚪`: 非アクティブ。ルールは保存されていますが、無視されます。
-*   **スコープ**: プリファレンスが適用されるコンテキスト（例：`global`、`document`）。
-*   **ID**: プリファレンスの一意の識別子で、削除や切り替えに使用されます。
-*   **パス**: プリファレンスが特定のファイルにのみ適用される場合、そのパスがここにリストされます。
-*   **ルール内容**: プリファレンスルール自体のテキストです。
-
-**出力例：**
-
-```
-# ユーザープリファレンス
-
-**フォーマットの説明：**
-- 🟢 = アクティブなプリファレンス, ⚪ = 非アクティブなプリファレンス
-- [scope] = プリファレンスのスコープ (global, structure, document, translation)
-- ID = 一意のプリファレンス識別子
-- Paths = 特定のファイルパス（該当する場合）
-
-🟢 [document] 2af5c | Paths: /guides/generating-documentation.md
-   具体的で検証可能な事実と情報に焦点を当てること。測定可能または具体的な情報を提供しない、曖昧または空虚な言葉の使用は避けること...
-
-⚪ [global] 8b1e2
-   ドキュメント全体でフォーマルかつアカデミックなトーンを使用すること。
-
-```
-
-## プリファレンスの削除
-
-プリファレンスが不要になった場合、`--remove` フラグを使用して完全に削除できます。IDを指定するか、インタラクティブメニューを通じてプリファレンスを削除できます。
-
-### インタラクティブモード
-
-リストからプリファレンスを選択するには、IDなしでコマンドを実行します。これにより、削除したい項目をチェックできるインタラクティブなプロンプトが開きます。
-
-```bash
-aigne doc prefs --remove
-```
-
-チェックリストが表示され、1つ以上のプリファレンスを選択できます。これは、正しい項目を確実に削除するための推奨される方法です。
-
-### ダイレクトモード
-
-削除したいプリファレンスの一意のIDがすでにわかっている場合は、`--id` フラグを使用してそれらを指定できます。削除する項目が確かな場合は、この方法がより高速です。
-
-```bash
-# 単一のプリファレンスを削除
-aigne doc prefs --remove --id 2af5c
-
-# 複数のプリファレンスを削除
-aigne doc prefs --remove --id 2af5c --id 8b1e2
-```
-
-## プリファレンスの切り替え
-
-プリファレンスを完全に削除する代わりに、一時的に有効または無効にすることができます。これは、ルールを失うことなく特定のタスクのために一時停止したい場合に便利です。プリファレンスのアクティブ状態を変更するには、`--toggle` フラグを使用します。
-
-### インタラクティブモード
-
-IDなしでコマンドを実行すると、削除コマンドと同様のインタラクティブなチェックリストが起動します。
-
-```bash
-aigne doc prefs --toggle
-```
-
-有効化または無効化したいプリファレンスを選択できます。ステータスアイコン（`🟢`/`⚪`）が更新され、新しい状態が反映されます。
-
-### ダイレクトモード
-
-特定のプリファレンスを直接切り替えるには、`--id` フラグを使用します。
-
-```bash
-# 単一のプリファレンスを切り替え
-aigne doc prefs --toggle --id 2af5c
-
-# 複数のプリファレンスを切り替え
-aigne doc prefs --toggle --id 2af5c --id 8b1e2
-```
-
----
-
-プリファレンスを管理することで、ドキュメント生成プロセスをきめ細かく制御し、出力がプロジェクトの特定の要件やスタイルに一貫して沿うようにすることができます。