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

package/docs/configuration.zh-TW.md

@@ -1,96 +1,69 @@
 # 設定
 
-正確的設定對於根據專案的特定需求客製化文件產生過程至關重要。AIGNE DocSmith 使用一個主要設定檔和一個命令列介面來管理您的設定。這種設定方式確保產生的文件能準確反映您的專案目標、目標受眾和結構需求。
+正確的設定是引導 AIGNE DocSmith 工具產生符合您專案特定需求文件的基礎。此過程涉及透過一個中央設定檔來定義專案層級的設定，並管理個人偏好設定以微調產生過程。
 
-本節概述了如何設定此工具。有關逐步說明，請參閱以下詳細指南：
+本節將概覽如何設定此工具。有關詳細的逐步說明，請參考下方連結的具體指南。
 
-<x-cards>
-  <x-card data-title="初始設定" data-icon="lucide:settings-2" data-href="/configuration/initial-setup">了解如何執行互動式設定來建立您的 config.yaml 檔案。這是任何新專案的建議第一步。</x-card>
-  <x-card data-title="管理偏好設定" data-icon="lucide:list-checks" data-href="/configuration/managing-preferences">了解如何檢視、啟用、停用或刪除已儲存的偏好設定，以隨著時間的推移來完善文件產生過程。</x-card>
+<x-cards data-columns="2">
+  <x-card data-title="初始設定" data-icon="lucide:settings-2" data-href="/configuration/initial-setup">
+    遵循互動式設定指南來建立主要的 `config.yaml` 檔案。這是任何新文件專案的必要第一步。
+  </x-card>
+  <x-card data-title="管理偏好設定" data-icon="lucide:user-cog" data-href="/configuration/managing-preferences">
+    了解如何檢視、啟用、停用或刪除個人偏好設定。這些設定可讓您應用特定規則來補充主要的專案設定。
+  </x-card>
 </x-cards>
 
-## `config.yaml` 檔案
-
-所有專案層級的設定都儲存在名為 `config.yaml` 的檔案中，該檔案位於您專案內的 `.aigne/doc-smith/` 目錄中。`aigne doc init` 指令會透過一個互動式過程為您建立此檔案。您也可以隨時使用文字編輯器手動修改此檔案以調整設定。
-
-以下是一個 `config.yaml` 檔案的範例，其中包含解釋每個區塊的註解。
-
-```yaml Example config.yaml icon=logos:yaml
-# 用於文件發布的專案資訊
-projectName: AIGNE DocSmith
-projectDesc: AIGNE DocSmith is a powerful, AI-driven documentation generation tool built on the AIGNE Framework. It automates the creation of detailed, structured, and multi-language documentation directly from your source code.
-projectLogo: https://docsmith.aigne.io/image-bin/uploads/9645caf64b4232699982c4d940b03b90.svg
-
-# =============================================================================
-# 文件設定
-# =============================================================================
-
-# 目的：您希望讀者達成的最主要成果是什麼？
-# 可用選項（取消註解並根據需要修改）：
-#   getStarted       - 快速入門：幫助新使用者在 30 分鐘內從零到上手
-#   completeTasks    - 完成特定任務：引導使用者完成常見的工作流程和使用案例
-#   findAnswers      - 快速尋找答案：為所有功能和 API 提供可搜尋的參考資料
-#   understandSystem - 了解系統：解釋其運作方式及設計決策的原因
-#   solveProblems    - 解決問題：幫助使用者進行故障排除並修復問題
-#   mixedPurpose     - 綜合目的：涵蓋多種需求的綜合性文件
-documentPurpose:
-  - getStarted
-  - completeTasks
-
-# 目標受眾：誰會最常閱讀這份文件？
-# 可用選項（取消註解並根據需要修改）：
-#   endUsers         - 終端使用者（非技術人員）：使用產品但不寫程式的人
-#   developers       - 整合開發者：將此產品加入其專案的工程師
-#   devops           - DevOps/基礎設施：部署、監控、維護系統的團隊
-#   decisionMakers   - 技術決策者：評估或規劃實施的架構師、領導者
-#   supportTeams     - 支援團隊：幫助他人使用產品的人員
-#   mixedTechnical   - 混合技術受眾：開發者、DevOps 和技術使用者
-targetAudienceTypes:
-  - endUsers
-
-# 讀者知識水平：讀者在閱讀文件時通常具備哪些知識？
-# 可用選項（取消註解並根據需要修改）：
-#   completeBeginners    - 完全初學者：對此領域/技術完全陌生
-#   domainFamiliar       - 熟悉領域，工具新手：了解問題領域，但對此特定解決方案不熟
-#   experiencedUsers     - 有經驗的使用者：需要參考資料/進階主題的常規使用者
-#   emergencyTroubleshooting - 緊急/故障排除：出現問題，需要快速修復
-#   exploringEvaluating  - 探索/評估：試圖了解這是否符合他們的需求
-readerKnowledgeLevel: completeBeginners
-
-# 文件深度：文件應該要多詳盡？
-# 可用選項（取消註解並根據需要修改）：
-#   essentialOnly      - 僅涵蓋必要內容：涵蓋 80% 的使用案例，保持簡潔
-#   balancedCoverage   - 平衡的涵蓋範圍：具有足夠深度和實用範例 [建議]
-#   comprehensive      - 全面詳盡：涵蓋所有功能、邊界案例和進階情境
-#   aiDecide           - 讓 AI 決定：分析程式碼複雜度並建議適當的深度
-documentationDepth: comprehensive
-
-# 自訂規則：定義特定的文件產生規則與要求
-rules: |
-  Avoid using vague or empty words that don't provide measurable or specific details, such as 'intelligently', 'seamlessly', 'comprehensive', or 'high-quality'. Focus on concrete, verifiable facts and information.
-  Focus on concrete, verifiable facts and information.
-  Must cover all subcommands of DocSmith
-
-# 目標受眾：描述您的特定目標受眾及其特徵
-targetAudience: |
-
-locale: en
-translateLanguages:
-  - zh
-  - zh-TW
-  - ja
-docsDir: ./docs  # 儲存產生文件的目錄
-sourcesPath:  # 要分析的原始碼路徑
-  - ./README.md
-  - ./CHANGELOG.md
-  - ./aigne.yaml
-  - ./agents
-  - ./media.md
-  - ./.aigne/doc-smith/config.yaml
-```
+## 了解 `config.yaml` 檔案
+
+`config.yaml` 檔案是您文件專案的唯一可信來源。它在初始設定過程中產生，並包含 AI 用於分析您的原始碼及產生內容的所有核心指令。一個設定正確的檔案可確保輸出內容是為您預期的受眾、目的和風格量身打造。
+
+以下是您會在 `config.yaml` 檔案中找到的關鍵參數的詳細說明。
+
+### 核心設定參數
+
+<x-field-group>
+  <x-field data-name="projectName" data-type="string" data-required="true">
+    <x-field-desc markdown>您專案的正式名稱。此名稱將用於整份文件的標題和其他元資料中。</x-field-desc>
+  </x-field>
+  <x-field data-name="projectDesc" data-type="string" data-required="true">
+    <x-field-desc markdown>用一句話簡潔描述您專案的目的和功能。</x-field-desc>
+  </x-field>
+  <x-field data-name="projectLogo" data-type="string" data-required="false">
+    <x-field-desc markdown>指向您專案標誌圖片的 URL。此圖片將用於已發佈文件網站的品牌識別。</x-field-desc>
+  </x-field>
+  <x-field data-name="documentPurpose" data-type="array" data-required="true">
+    <x-field-desc markdown>定義文件的主要目標。範例包含用於入門指南的 `getStarted` 或用於程序說明的 `completeTasks`。</x-field-desc>
+  </x-field>
+  <x-field data-name="targetAudienceTypes" data-type="array" data-required="true">
+    <x-field-desc markdown>指定預期的讀者。範例包含針對非技術人員的 `endUsers` 或針對工程師的 `developers`。</x-field-desc>
+  </x-field>
+  <x-field data-name="readerKnowledgeLevel" data-type="string" data-required="true">
+    <x-field-desc markdown>描述目標受眾的預期技術知識和背景，例如 `completeBeginners`。</x-field-desc>
+  </x-field>
+  <x-field data-name="documentationDepth" data-type="string" data-required="true">
+    <x-field-desc markdown>控制產生內容的詳細程度。選項範圍從 `essentialOnly` 到 `comprehensive`。</x-field-desc>
+  </x-field>
+  <x-field data-name="rules" data-type="string" data-required="false">
+    <x-field-desc markdown>一組自訂指令、指南或限制，供 AI 在內容產生過程中遵循。</x-field-desc>
+  </x-field>
+  <x-field data-name="locale" data-type="string" data-required="true">
+    <x-field-desc markdown>文件的主要語言代碼，例如 `en` 代表英文。</x-field-desc>
+  </x-field>
+  <x-field data-name="translateLanguages" data-type="array" data-required="false">
+    <x-field-desc markdown>應將主要文件翻譯成的語言代碼列表，例如 `zh` (中文) 或 `ja` (日文)。</x-field-desc>
+  </x-field>
+  <x-field data-name="docsDir" data-type="string" data-required="true">
+    <x-field-desc markdown>儲存所產生文件檔案的本機目錄路徑。</x-field-desc>
+  </x-field>
+  <x-field data-name="sourcesPath" data-type="array" data-required="true">
+    <x-field-desc markdown>工具應分析以產生文件的來源檔案、目錄或 glob 模式的列表。</x-field-desc>
+  </x-field>
+</x-field-group>
 
 ## 總結
 
-完成設定後，此工具將清楚了解您的專案、受眾和文件目標，從而產生更準確、更相關的內容。
+一個定義完善的設定對於產出準確、相關且有效的文件至關重要。透過完成初始設定並了解 `config.yaml` 檔案，您為所有的文件任務奠定了堅實的基礎。
 
-若要開始設定您的專案，請前往 [初始設定](./configuration-initial-setup.md) 指南。
+若要繼續設定您的專案，請參考以下指南：
+*   **[初始設定](./configuration-initial-setup.md)**：建立您專案的 `config.yaml` 檔案。
+*   **[管理偏好設定](./configuration-managing-preferences.md)**：使用個人規則自訂工具的行為。

package/docs/configuration.zh.md

@@ -1,96 +1,69 @@
 # 配置
 
-合理的配置对于根据项目的具体需求定制文档生成过程至关重要。AIGNE DocSmith 使用一个主配置文件和命令行界面来管理您的设置。这种设置确保了生成的文档能够准确反映您的项目目标、目标受众和结构要求。
+正确的配置是指导 AIGNE DocSmith 工具生成符合项目特定需求的文档的基础。该过程涉及通过中央配置文件定义项目级设置，以及管理个人偏好以微调生成过程。
 
-本节概述了如何配置该工具。有关分步说明，请参阅以下详细指南：
+本节概述了如何配置该工具。有关详细的分步说明，请参阅下面链接的具体指南。
 
-<x-cards>
-  <x-card data-title="初始设置" data-icon="lucide:settings-2" data-href="/configuration/initial-setup">了解如何运行交互式设置来创建您的 config.yaml 文件。这是任何新项目的推荐第一步。</x-card>
-  <x-card data-title="管理偏好设置" data-icon="lucide:list-checks" data-href="/configuration/managing-preferences">了解如何查看、启用、禁用或删除已保存的偏好设置，以便随着时间的推移优化文档生成过程。</x-card>
+<x-cards data-columns="2">
+  <x-card data-title="初始设置" data-icon="lucide:settings-2" data-href="/configuration/initial-setup">
+    遵循交互式设置指南创建主 `config.yaml` 文件。这是任何新文档项目必不可少的第一步。
+  </x-card>
+  <x-card data-title="管理偏好设置" data-icon="lucide:user-cog" data-href="/configuration/managing-preferences">
+    了解如何查看、启用、禁用或删除个人偏好设置。这些设置允许您应用特定规则来补充主项目配置。
+  </x-card>
 </x-cards>
 
-## `config.yaml` 文件
-
-所有项目级别的设置都存储在名为 `config.yaml` 的文件中，该文件位于您项目中的 `.aigne/doc-smith/` 目录内。`aigne doc init` 命令通过一个交互式过程为您创建此文件。您也可以随时使用文本编辑器手动修改此文件以调整设置。
-
-以下是一个 `config.yaml` 文件的示例，其中包含解释每个部分的注释。
-
-```yaml Example config.yaml icon=logos:yaml
-# 用于文档发布的项目信息
-projectName: AIGNE DocSmith
-projectDesc: AIGNE DocSmith 是一款功能强大、由 AI 驱动的文档生成工具，构建于 AIGNE 框架之上。它可以直接从您的源代码中自动创建详细、结构化和多语言的文档。
-projectLogo: https://docsmith.aigne.io/image-bin/uploads/9645caf64b4232699982c4d940b03b90.svg
-
-# =============================================================================
-# 文档配置
-# =============================================================================
-
-# 目的：您希望读者实现的主要成果是什么？
-# 可用选项（取消注释并根据需要修改）：
-#   getStarted       - 快速入门：帮助新用户在 30 分钟内从零开始上手
-#   completeTasks    - 完成特定任务：引导用户了解常见工作流程和用例
-#   findAnswers      - 快速查找答案：为所有功能和 API 提供可搜索的参考
-#   understandSystem - 理解系统：解释其工作原理以及做出设计决策的原因
-#   solveProblems    - 解决问题：帮助用户排查和修复问题
-#   mixedPurpose     - 多种目的混合：涵盖多种需求的综合文档
-documentPurpose:
-  - getStarted
-  - completeTasks
-
-# 目标受众：谁会最常阅读这些文档？
-# 可用选项（取消注释并根据需要修改）：
-#   endUsers         - 最终用户（非技术人员）：使用产品但不编码的人
-#   developers       - 集成开发者：将此添加到其项目中的工程师
-#   devops           - DevOps/基础设施：部署、监控、维护系统的团队
-#   decisionMakers   - 技术决策者：评估或规划实施的架构师、负责人
-#   supportTeams     - 支持团队：帮助他人使用产品的人
-#   mixedTechnical   - 混合技术受众：开发者、DevOps 和技术用户
-targetAudienceTypes:
-  - endUsers
-
-# 读者知识水平：读者通常具备哪些知识？
-# 可用选项（取消注释并根据需要修改）：
-#   completeBeginners    - 完全初学者：完全不熟悉该领域/技术
-#   domainFamiliar       - 熟悉领域，但工具是新的：了解问题领域，但对这个特定解决方案不熟悉
-#   experiencedUsers     - 经验丰富的用户：需要参考/高级主题的常规用户
-#   emergencyTroubleshooting - 紧急/故障排除：出现问题，需要快速修复
-#   exploringEvaluating  - 探索/评估：试图了解这是否满足他们的需求
-readerKnowledgeLevel: completeBeginners
-
-# 文档深度：文档应有多全面？
-# 可用选项（取消注释并根据需要修改）：
-#   essentialOnly      - 仅包含基本内容：覆盖 80% 的用例，保持简洁
-#   balancedCoverage   - 平衡覆盖：具有适当深度和实际示例 [推荐]
-#   comprehensive      - 全面：覆盖所有功能、边缘情况和高级场景
-#   aiDecide           - 让 AI 决定：分析代码复杂性并建议适当的深度
-documentationDepth: comprehensive
-
-# 自定义规则：定义具体的文档生成规则和要求
-rules: |
-  避免使用模糊或空洞的词语，这些词语无法提供可衡量或具体的细节，例如‘智能地’、‘无缝地’、‘全面地’或‘高质量地’。专注于具体、可验证的事实和信息。
-  专注于具体、可验证的事实和信息。
-  必须覆盖 DocSmith 的所有子命令
-
-# 目标受众：描述您的具体目标受众及其特征
-targetAudience: |
-
-locale: en
-translateLanguages:
-  - zh
-  - zh-TW
-  - ja
-docsDir: ./docs  # 保存生成文档的目录
-sourcesPath:  # 要分析的源代码路径
-  - ./README.md
-  - ./CHANGELOG.md
-  - ./aigne.yaml
-  - ./agents
-  - ./media.md
-  - ./.aigne/doc-smith/config.yaml
-```
+## 理解 `config.yaml` 文件
+
+`config.yaml` 文件是您文档项目的主要可信来源。它在初始设置过程中生成，包含了 AI 用来分析源代码和生成内容的所有核心指令。正确配置的文件可确保输出内容符合您预期的受众、目的和风格。
+
+以下是您将在 `config.yaml` 文件中找到的关键参数的分解说明。
+
+### 核心配置参数
+
+<x-field-group>
+  <x-field data-name="projectName" data-type="string" data-required="true">
+    <x-field-desc markdown>您项目的官方名称。该名称将用于整个文档的标题和其他元数据中。</x-field-desc>
+  </x-field>
+  <x-field data-name="projectDesc" data-type="string" data-required="true">
+    <x-field-desc markdown>关于您项目目的和功能的简明单句描述。</x-field-desc>
+  </x-field>
+  <x-field data-name="projectLogo" data-type="string" data-required="false">
+    <x-field-desc markdown>指向您项目徽标图像的 URL。该 URL 将用于已发布文档网站的品牌塑造。</x-field-desc>
+  </x-field>
+  <x-field data-name="documentPurpose" data-type="array" data-required="true">
+    <x-field-desc markdown>定义文档的主要目标。示例包括用于入门指南的 `getStarted` 或用于流程说明的 `completeTasks`。</x-field-desc>
+  </x-field>
+  <x-field data-name="targetAudienceTypes" data-type="array" data-required="true">
+    <x-field-desc markdown>指定预期的读者。示例包括非技术人员的 `endUsers` 或工程师的 `developers`。</x-field-desc>
+  </x-field>
+  <x-field data-name="readerKnowledgeLevel" data-type="string" data-required="true">
+    <x-field-desc markdown>描述目标受众假定的技术知识和背景，例如 `completeBeginners`。</x-field-desc>
+  </x-field>
+  <x-field data-name="documentationDepth" data-type="string" data-required="true">
+    <x-field-desc markdown>控制生成内容的详细程度。选项范围从 `essentialOnly` 到 `comprehensive`。</x-field-desc>
+  </x-field>
+  <x-field data-name="rules" data-type="string" data-required="false">
+    <x-field-desc markdown>一组供 AI 在内容生成过程中遵循的自定义指令、指南或约束。</x-field-desc>
+  </x-field>
+  <x-field data-name="locale" data-type="string" data-required="true">
+    <x-field-desc markdown>文档的主要语言代码，例如 `en` 代表英语。</x-field-desc>
+  </x-field>
+  <x-field data-name="translateLanguages" data-type="array" data-required="false">
+    <x-field-desc markdown>主要文档应翻译成的语言代码列表，例如 `zh`（中文）或 `ja`（日语）。</x-field-desc>
+  </x-field>
+  <x-field data-name="docsDir" data-type="string" data-required="true">
+    <x-field-desc markdown>用于保存生成的文档文件的本地目录路径。</x-field-desc>
+  </x-field>
+  <x-field data-name="sourcesPath" data-type="array" data-required="true">
+    <x-field-desc markdown>工具为生成文档而应分析的源文件、目录或 glob 模式的列表。</x-field-desc>
+  </x-field>
+</x-field-group>
 
 ## 总结
 
-完成配置后，该工具将清楚地了解您的项目、受众和文档目标，从而生成更准确、更相关的内容。
+定义良好的配置对于生成准确、相关且有效的文档至关重要。通过完成初始设置并理解 `config.yaml` 文件，您为所有文档任务奠定了坚实的基础。
 
-要开始设置您的项目，请继续阅读[初始设置](./configuration-initial-setup.md)指南。
+要继续配置您的项目，请参阅以下指南：
+*   **[初始设置](./configuration-initial-setup.md)**：创建您项目的 `config.yaml` 文件。
+*   **[管理偏好设置](./configuration-managing-preferences.md)**：使用个人规则自定义工具的行为。

package/docs/getting-started.ja.md

@@ -1,20 +1,20 @@
 # はじめに
 
-このガイドでは、AIGNE DocSmithをインストールし、最初のドキュメントセットを生成するためのステップバイステップの手順を説明します。このプロセスは分かりやすく設計されており、短時間で完了できます。
+このガイドでは、AIGNE DocSmithをインストールし、最初のドキュメント一式を生成するための手順をステップバイステップで説明します。このプロセスは分かりやすいように設計されており、数分で完了できます。
 
 ## 前提条件
 
 インストールを進める前に、お使いのシステムが以下の要件を満たしていることを確認してください。
 
-*   **Node.js**: バージョン20以降が必要です。DocSmithはNode.jsのインストールに含まれているNode Package Manager (npm) を使用してインストールされます。Node.jsをインストールするには、公式の[Node.jsウェブサイト](https://nodejs.org/)にアクセスし、お使いのオペレーティングシステムの手順に従ってください。ターミナルを開き、`node -v`と`npm -v`を実行することでインストールを確認できます。
+*   **Node.js**: バージョン20以降が必要です。DocSmithはNode Package Manager (npm) を使用してインストールされ、これはNode.jsのインストールに含まれています。Node.jsをインストールするには、公式の[Node.jsウェブサイト](https://nodejs.org/)にアクセスし、お使いのオペレーティングシステムの手順に従ってください。ターミナルを開き、`node -v`と`npm -v`を実行することでインストールを確認できます。
 
-*   **APIキー**: 開始にあたりAPIキーは不要です。デフォルトでは、DocSmithはAIによる生成のためにAIGNE Hubサービスを使用します。これにより、直接的な設定なしで様々な大規模言語モデルを利用できます。
+*   **APIキー**: 開始にあたりAPIキーは不要です。デフォルトでは、DocSmithはAIを利用した生成のためにAIGNE Hubサービスを使用します。これにより、直接的な設定なしで様々な大規模言語モデルを利用できます。
 
 ## インストール
 
-このツールは、AIGNEコマンドラインインターフェース(CLI)の一部として配布されています。
+このツールは、AIGNEコマンドラインインターフェース（CLI）の一部として配布されます。インストールプロセスは、2つの簡単なステップで構成されています。
 
-### ステップ1：AIGNE CLIをインストールする
+### ステップ1：AIGNE CLIのインストール
 
 システムにAIGNE CLIをグローバルにインストールするには、ターミナルで以下のコマンドを実行します。
 
@@ -22,23 +22,23 @@
 npm install -g @aigne/cli
 ```
 
-このコマンドはパッケージをダウンロードしてインストールし、どのディレクトリからでも`aigne`コマンドを利用できるようにします。
+このコマンドはnpmレジストリからパッケージをダウンロードしてインストールし、ターミナルのどのディレクトリからでも`aigne`コマンドが利用できるようになります。
 
-### ステップ2：インストールを確認する
+### ステップ2：インストールの確認
 
-インストールが完了したら、ドキュメンテーションツールのヘルプコマンドを実行して確認します。
+インストールが完了したら、ドキュメントツールのヘルプコマンドを実行して確認できます。
 
 ```bash title="インストールの確認"
 aigne doc --help
 ```
 
-このコマンドにより、利用可能なDocSmithのコマンドとオプションのリストが表示され、インストールが成功したことを確認できます。
+このコマンドは、利用可能なDocSmithのコマンドとそのオプションのリストを表示するはずです。これにより、インストールが成功したことが確認できます。
 
 ## 最初のドキュメントを生成する
 
-以下の手順に従って、プロジェクトを分析し、完全なドキュメントセットを生成します。
+以下の手順に従って、プロジェクトを分析し、ドキュメント一式を生成します。
 
-### ステップ1：プロジェクトディレクトリに移動する
+### ステップ1：プロジェクトディレクトリへの移動
 
 ターミナルを開き、`cd`コマンドを使用して、ドキュメントを作成したいプロジェクトのルートにカレントディレクトリを変更します。
 
@@ -46,43 +46,62 @@ aigne doc --help
 cd /path/to/your/project
 ```
 
-### ステップ2：生成コマンドを実行する
+### ステップ2：生成コマンドの実行
 
-主要な`generate`コマンドを実行します。この単一のコマンドが、ドキュメント作成プロセス全体を処理します。
+主要な`generate`コマンドを実行します。この単一のコマンドが、分析からコンテンツ生成までのドキュメント作成プロセス全体を処理します。
 
 ```bash title="生成コマンドの実行"
 aigne doc generate
 ```
 
-### ステップ3：対話式セットアップを完了する
+### ステップ3：対話式セットアップの完了
 
-プロジェクトで初めて`generate`コマンドを実行すると、DocSmithは1回限りの対話式セットアッププロセスを開始します。ドキュメントの主な目的、対象読者、言語など、ドキュメントの設定に関する一連の質問が表示されます。設定を保存するために、`.aigne/doc-smith`ディレクトリに`config.yaml`ファイルが作成されます。
+プロジェクトで初めて`generate`コマンドを実行すると、DocSmithは一度限りの対話式セットアッププロセスを開始します。一連の質問を通じて、ドキュメントの主な目的、対象読者、言語などの設定を行います。
+
+![対話式セットアッププロセスのスクリーンショット](../assets/screenshots/doc-complete-setup.png)
+
+回答は`.aigne/doc-smith`ディレクトリにある`config.yaml`ファイルに保存されます。このファイルは、必要に応じて後で手動で編集できます。
 
 ### ステップ4：生成を待つ
 
 セットアップが完了すると、DocSmithは自動的に以下のアクションを実行します。
 
-1.  **コードベースの分析**: ソースファイルをスキャンして、プロジェクトの構造とロジックを理解します。
-2.  **構造の計画**: セクションやトピックを含む、ドキュメントの論理的な計画を作成します。
-3.  **コンテンツの生成**: 分析と設定に基づいてドキュメントのコンテンツを記述します。
+1.  **コードベースの分析**: ソースファイルをスキャンして、プロジェクトの構造、機能、ロジックを理解します。
+2.  **構造の計画**: セクションやトピックを概説し、ドキュメントの論理的な計画を作成します。
+3.  **コンテンツの生成**: 分析と設定に基づいてドキュメントのコンテンツを作成します。
+
+完了すると確認メッセージが表示され、生成されたファイルはセットアップ時に指定された出力ディレクトリ（デフォルトでは`.aigne/doc-smith/docs`）に配置されます。
+
+![生成成功メッセージのスクリーンショット](../assets/screenshots/doc-generated-successfully.png)
+
+## 全コマンドの確認
+
+DocSmithは、ドキュメントのライフサイクル全体を管理するための一連のコマンドを提供します。以下の表は、利用可能なすべてのコマンドとその機能の一覧です。
 
-完了すると確認メッセージが表示され、生成されたファイルはセットアップ時に指定された出力ディレクトリ（例：`.aigne/doc-smith/docs`）に配置されます。
+| コマンド | 説明 |
+| :---------- | :------------------------------------------------------------------------------------------------------------ |
+| `generate` | コードベースを分析し、設定に基づいてドキュメント一式を生成します。 |
+| `update` | 既存のドキュメントの特定の部分を対話形式で選択し、多くの場合新しいフィードバックを加えて再生成します。 |
+| `translate` | 既存のドキュメントを、`zh`や`ja`など、サポートされている12言語のいずれかに翻訳します。 |
+| `publish` | 生成されたドキュメントをライブプラットフォームに公開し、URL経由でアクセスできるようにします。 |
+| `init` | 対話式のセットアップウィザードを開始して、`config.yaml`設定ファイルを作成または上書きします。 |
+| `prefs` | `config.yaml`ファイルから現在の設定を表示します。 |
 
 ## 次のステップ
 
-最初のドキュメントセットの生成が成功しました。ドキュメントを管理し、強化するための一般的な次のステップは以下の通りです。
+最初のドキュメント一式の生成が成功しました。ドキュメントを管理し、強化するための一般的な次のステップは以下の通りです。
 
 <x-cards data-columns="2">
   <x-card data-title="ドキュメントの更新" data-icon="lucide:refresh-cw" data-href="/guides/updating-documentation">
-    コードの変更や新しい要件に基づいて、ドキュメントの特定の部分を修正または再生成します。
+    コードの変更や新しい要件に基づいて、ドキュメントの特定のセクションを修正または再生成します。
   </x-card>
   <x-card data-title="ドキュメントの翻訳" data-icon="lucide:languages" data-href="/guides/translating-documentation">
     ドキュメントを中国語、スペイン語、ドイツ語など、サポートされている12言語のいずれかに翻訳します。
   </x-card>
   <x-card data-title="ドキュメントの公開" data-icon="lucide:rocket" data-href="/guides/publishing-your-docs">
-    ドキュメントをオンラインで公開し、チームや一般の人が利用できるようにします。
+    ドキュメントをオンラインで利用可能にし、チームや一般の人がアクセスできるようにします。
   </x-card>
   <x-card data-title="設定の確認" data-icon="lucide:settings" data-href="/configuration/initial-setup">
-    初期セットアップ時に作成されたconfig.yamlファイルを確認・修正して、設定を調整します。
+    初期設定時に作成されたconfig.yamlファイルを確認・修正して、設定を調整します。
   </x-card>
-</x-cards>
+</x-cards>

package/docs/getting-started.md

@@ -1,6 +1,6 @@
 # Getting Started
 
-This guide provides a step-by-step procedure for installing AIGNE DocSmith and generating your first set of documentation. The process is designed to be straightforward and can be completed quickly.
+This guide provides a step-by-step procedure for installing AIGNE DocSmith and generating your first set of documentation. The process is designed to be straightforward and can be completed in a few minutes.
 
 ## Prerequisites
 
@@ -12,7 +12,7 @@ Before proceeding with the installation, ensure your system meets the following
 
 ## Installation
 
-The tool is distributed as part of the AIGNE command-line interface (CLI).
+The tool is distributed as part of the AIGNE command-line interface (CLI). The installation process consists of two simple steps.
 
 ### Step 1: Install the AIGNE CLI
 
@@ -22,17 +22,17 @@ To install the AIGNE CLI globally on your system, execute the following command
 npm install -g @aigne/cli
 ```
 
-This command downloads and installs the package, making the `aigne` command available from any directory.
+This command downloads and installs the package from the npm registry, making the `aigne` command available from any directory in your terminal.
 
 ### Step 2: Verify the Installation
 
-After the installation is complete, verify it by running the help command for the documentation tool:
+After the installation is complete, you can verify it by running the help command for the documentation tool:
 
 ```bash title="Verify Installation"
 aigne doc --help
 ```
 
-This command should display a list of available DocSmith commands and options, confirming that the installation was successful.
+This command should display a list of available DocSmith commands and their options, which confirms that the installation was successful.
 
 ## Generating Your First Documents
 
@@ -48,7 +48,7 @@ cd /path/to/your/project
 
 ### Step 2: Run the Generate Command
 
-Execute the primary `generate` command. This single command handles the entire documentation creation process.
+Execute the primary `generate` command. This single command handles the entire documentation creation process from analysis to content generation.
 
 ```bash title="Run Generate Command"
 aigne doc generate
@@ -56,17 +56,36 @@ aigne doc generate
 
 ### Step 3: Complete the Interactive Setup
 
-The first time you run the `generate` command in a project, DocSmith will initiate a one-time interactive setup process. You will be asked a series of questions to configure your documentation preferences, such as its primary purpose, target audience, and language. A `config.yaml` file will be created in the `.aigne/doc-smith` directory to store your settings.
+The first time you run the `generate` command in a project, DocSmith will initiate a one-time interactive setup process. You will be guided through a series of questions to configure your documentation preferences, such as its primary purpose, target audience, and language.
+
+![Screenshot of the interactive setup process](../assets/screenshots/doc-complete-setup.png)
+
+Your answers are saved to a `config.yaml` file located in the `.aigne/doc-smith` directory. This file can be manually edited later if needed.
 
 ### Step 4: Await Generation
 
 Once the setup is complete, DocSmith will perform the following actions automatically:
 
-1.  **Analyze Codebase**: It scans your source files to understand the project's structure and logic.
-2.  **Plan Structure**: It creates a logical plan for the documentation, including sections and topics.
+1.  **Analyze Codebase**: It scans your source files to understand the project's structure, functions, and logic.
+2.  **Plan Structure**: It creates a logical plan for the documentation, outlining sections and topics.
 3.  **Generate Content**: It writes the documentation content based on the analysis and your configuration.
 
-Upon completion, a confirmation message will appear, and the generated files will be located in the output directory specified during setup (e.g., `.aigne/doc-smith/docs`).
+Upon completion, a confirmation message will appear, and the generated files will be located in the output directory specified during setup (by default, `.aigne/doc-smith/docs`).
+
+![Screenshot of the success message after generation](../assets/screenshots/doc-generated-successfully.png)
+
+## Exploring All Commands
+
+DocSmith provides a set of commands to manage the full lifecycle of your documentation. The table below lists all available commands and their functions.
+
+| Command     | Description                                                                                                   |
+| :---------- | :------------------------------------------------------------------------------------------------------------ |
+| `generate`  | Analyzes the codebase and generates a complete set of documentation based on the configuration.               |
+| `update`    | Interactively selects and regenerates specific parts of existing documentation, often with new feedback.      |
+| `translate` | Translates existing documentation into one or more of the 12 supported languages, such as `zh` or `ja`.       |
+| `publish`   | Publishes the generated documentation to a live platform, making it accessible via a URL.                     |
+| `init`      | Starts the interactive setup wizard to create or overwrite the `config.yaml` configuration file.              |
+| `prefs`     | Displays the current configuration settings from the `config.yaml` file.                                      |
 
 ## What's Next?