@aigne/doc-smith 0.8.11-beta → 0.8.11-beta.1

package/docs/features-update-and-refine.zh-TW.md

@@ -0,0 +1,138 @@
+# 更新與優化
+
+讓文件與不斷演進的程式碼庫保持同步是一項關鍵任務。AIGNE DocSmith 提供了直接且靈活的方法來讓您的內容保持最新，無論是透過基於程式碼變更的自動更新，還是透過精確、由回饋意見驅動的優化。
+
+本指南涵蓋如何：
+
+- 在您的原始碼變更時自動更新文件。
+- 使用針對性的回饋意見重新生成特定文件。
+- 調整整體文件結構。
+
+### 文件更新工作流程
+
+下圖說明了更新文件的不同路徑：
+
+```d2 更新工作流程
+direction: down
+
+Start: {
+  shape: circle
+  label: "開始"
+}
+
+Code-Change: {
+  label: "原始碼或\n設定檔變更"
+  shape: rectangle
+}
+
+Content-Tweak: {
+  label: "需要內容\n改善？"
+  shape: rectangle
+}
+
+Structure-Tweak: {
+  label: "需要結構\n改善？"
+  shape: rectangle
+}
+
+Start -> Code-Change
+Start -> Content-Tweak
+Start -> Structure-Tweak
+
+Code-Change -> Generate-Command: "aigne doc generate"
+
+Generate-Command -> Change-Detection: {
+  label: "變更偵測"
+  shape: diamond
+}
+Change-Detection -> Auto-Regen: "重新生成\n受影響文件"
+
+Content-Tweak -> Update-Command: "aigne doc update\n--feedback"
+Update-Command -> Manual-Regen: "重新生成\n特定文件"
+
+Structure-Tweak -> Generate-Feedback-Command: "aigne doc generate\n--feedback"
+Generate-Feedback-Command -> Replan: "重新規劃文件\n結構"
+
+End: {
+  shape: circle
+  label: "文件已更新"
+}
+
+Auto-Regen -> End
+Manual-Regen -> End
+Replan -> End
+```
+
+---
+
+## 透過變更偵測自動更新
+
+當您執行 `aigne doc generate` 命令時，DocSmith 會分析您的程式碼庫，偵測自上次執行以來的任何變更，並僅重新生成受影響的文件。此過程可節省時間並減少不必要的 API 呼叫。
+
+```shell icon=lucide:terminal
+# DocSmith 將偵測變更並僅更新必要部分
+aigne doc generate
+```
+
+![DocSmith 偵測變更並僅重新生成所需文件。](https://docsmith.aigne.io/image-bin/uploads/21a76b2f65d14d16a49c13d800f1e2c1.png)
+
+### 強制完整重新生成
+
+如果您需要從頭開始重新生成所有文件，忽略任何快取或先前的狀態，請使用 `--forceRegenerate` 標記。這在進行重大的設定變更後，或當您想確保一個完全全新的建置時非常有用。
+
+```shell icon=lucide:terminal
+# 從頭開始重新生成所有文件
+aigne doc generate --forceRegenerate
+```
+
+---
+
+## 優化單一文件
+
+若要在沒有相應程式碼變更的情況下改善特定文件，`aigne doc update` 命令允許您提供針對內容優化的具體指示。
+
+您可以用兩種方式使用此命令：互動式或直接透過命令列參數。
+
+### 互動模式
+
+若要獲得引導式體驗，請在不帶任何參數的情況下執行此命令。DocSmith 將會顯示一個選單，讓您選擇要更新的文件。選擇後，系統會提示您輸入回饋意見。
+
+```shell icon=lucide:terminal
+# 開始互動式更新流程
+aigne doc update
+```
+
+![以互動方式選擇您想更新的文件。](https://docsmith.aigne.io/image-bin/uploads/75e9cf9823bb369c3d2b5a2e2da4ac06.png)
+
+### 直接透過命令列更新
+
+為了更快速的工作流程或撰寫腳本，您可以使用標記直接指定文件和回饋意見。這允許進行精確、非互動式的更新。
+
+```shell icon=lucide:terminal
+# 帶有回饋意見以更新特定文件
+aigne doc update --docs overview.md --feedback "Add a more detailed FAQ section at the end."
+```
+
+`update` 命令的主要參數：
+
+| 參數 | 說明 |
+| ---------- | ------------------------------------------------------------------------------------------------ |
+| `--docs` | 您想更新的文件的路徑。您可以多次使用此標記進行批次更新。 |
+| `--feedback` | 重新生成內容時要使用的具體指示。 |
+
+---
+
+## 優化整體結構
+
+除了優化單一文件的內容，您還可以調整整體的文件結構。如果某個部分缺失或現有組織可以改進，您可以向 `generate` 命令提供回饋意見。
+
+此命令指示 DocSmith 根據您的新輸入重新評估整個文件計畫。
+
+```shell icon=lucide:terminal
+# 帶有特定回饋意見以重新生成文件結構
+aigne doc generate --feedback "Remove the 'About' section and add a detailed 'API Reference'."
+```
+
+這種方法最適合對文件的目錄進行高層次的變更，而非逐行的內容編輯。
+
+有了這些工具，您可以維護與您的專案一同演進的準確文件。一旦您的內容被優化，您就可以將其提供給全球的受眾。請在[翻譯文件](./features-translate-documentation.md)指南中了解如何操作。

package/docs/features-update-and-refine.zh.md

@@ -1,6 +1,6 @@
 # 更新与优化
 
-保持文档与不断演进的代码库同步是一项至关重要的任务。AIGNE DocSmith 提供了直接而灵活的方法来确保内容保持最新，无论是通过基于代码变更的自动更新，还是通过由反馈驱动的精确优化。
+让文档与不断演进的代码库保持同步是一项至关重要的任务。AIGNE DocSmith 提供了直接而灵活的方法来保持您的内容最新，无论是通过基于代码变更的自动更新，还是通过精确的、由反馈驱动的优化。
 
 本指南将介绍如何：
 
@@ -10,7 +10,7 @@
 
 ### 文档更新工作流
 
-下图说明了更新文档可采用的不同路径：
+下图说明了更新文档可以采用的不同路径：
 
 ```d2 Update Workflows
 direction: down
@@ -67,18 +67,18 @@ Replan -> End
 
 ## 通过变更检测自动更新
 
-当您运行 `aigne doc generate` 命令时，DocSmith 会分析您的代码库，检测自上次运行以来的所有变更，并仅重新生成受影响的文档。这一过程可以节省时间并减少不必要的 API 调用。
+当您运行 `aigne doc generate` 命令时，DocSmith 会分析您的代码库，检测自上次运行以来的任何变更，并仅重新生成受影响的文档。这个过程可以节省时间并减少不必要的 API 调用。
 
 ```shell icon=lucide:terminal
-# DocSmith 将检测变更并仅更新必要部分
+# DocSmith 将检测变更并仅更新必要的内容
 aigne doc generate
 ```
 
-![DocSmith 检测变更并仅重新生成所需文档。](https://docsmith.aigne.io/image-bin/uploads/21a76b2f65d14d16a49c13d800f1e2c1.png)
+![DocSmith 会检测变更并仅重新生成所需的文档。](https://docsmith.aigne.io/image-bin/uploads/21a76b2f65d14d16a49c13d800f1e2c1.png)
 
 ### 强制完全重新生成
 
-如果您需要从头开始重新生成所有文档，忽略任何缓存或先前的状态，请使用 `--forceRegenerate` 标志。这在进行重大配置更改后，或当您希望确保构建一个全新的版本时非常有用。
+如果您需要从头开始重新生成所有文档，忽略任何缓存或先前的状态，请使用 `--forceRegenerate` 标志。这在进行重大配置更改后或当您希望确保完全重新构建时非常有用。
 
 ```shell icon=lucide:terminal
 # 从头开始重新生成所有文档
@@ -89,50 +89,50 @@ aigne doc generate --forceRegenerate
 
 ## 优化单个文档
 
-如果想在没有相应代码变更的情况下改进特定文档，可以使用 `aigne doc update` 命令提供有针对性的内容优化指令。
+要在没有相应代码变更的情况下改进特定文档，`aigne doc update` 命令允许您为内容优化提供有针对性的指令。
 
-您可以通过两种方式使用此命令：交互式模式或直接通过命令行参数。
+您可以通过两种方式使用此命令：交互式或直接通过命令行参数。
 
 ### 交互模式
 
-如需引导式体验，请直接运行该命令，不带任何参数。DocSmith 将会展示一个菜单，供您选择要更新的文档。选择后，系统将提示您输入反馈。
+要获得引导式体验，请在不带任何参数的情况下运行该命令。DocSmith 将会显示一个菜单，供您选择要更新的文档。选择后，系统将提示您输入反馈。
 
 ```shell icon=lucide:terminal
-# 启动交互式更新流程
+# 启动交互式更新过程
 aigne doc update
 ```
 
-![以交互方式选择您希望更新的文档。](https://docsmith.aigne.io/image-bin/uploads/75e9cf9823bb369c3d2b5a2e2da4ac06.png)
+![交互式选择您希望更新的文档。](https://docsmith.aigne.io/image-bin/uploads/75e9cf9823bb369c3d2b5a2e2da4ac06.png)
 
 ### 直接通过命令行更新
 
-为了实现更快的工作流或用于脚本编写，您可以使用标志直接指定文档和反馈。这支持精确的非交互式更新。
+为了实现更快的工作流或脚本编写，您可以使用标志直接指定文档和反馈。这允许进行精确的非交互式更新。
 
 ```shell icon=lucide:terminal
 # 使用反馈更新特定文档
-aigne doc update --docs overview.md --feedback "在末尾添加一个更详细的 FAQ 部分。"
+aigne doc update --docs overview.md --feedback "在末尾添加更详细的常见问题解答部分。"
 ```
 
 `update` 命令的关键参数：
 
-| Parameter  | Description                                                                                      |
+| 参数  | 描述                                                                                      |
 | ---------- | ------------------------------------------------------------------------------------------------ |
-| `--docs`     | 您希望更新的文档路径。您可以多次使用此标志进行批量更新。 |
-| `--feedback` | 重新生成内容时要使用的具体指令。                       |
+| `--docs`     | 您想要更新的文档的路径。您可以多次使用此标志进行批量更新。 |
+| `--feedback` | 重新生成内容时使用的具体指令。                       |
 
 ---
 
 ## 优化整体结构
 
-除了优化单个文档的内容，您还可以调整整体文档结构。如果缺少某个部分或现有组织结构有待改进，您可以向 `generate` 命令提供反馈。
+除了优化单个文档的内容外，您还可以调整整体文档结构。如果缺少某个部分或现有组织结构可以改进，您可以向 `generate` 命令提供反馈。
 
-该命令会指示 DocSmith 根据您的新输入重新评估整个文档计划。
+此命令指示 DocSmith 根据您的新输入重新评估整个文档计划。
 
 ```shell icon=lucide:terminal
 # 使用特定反馈重新生成文档结构
-aigne doc generate --feedback "删除‘关于’部分，并添加一个详细的‘API 参考’。"
+aigne doc generate --feedback "删除‘关于’部分，并添加详细的‘API 参考’。"
 ```
 
-这种方法最适合对文档的目录进行高层级的更改，而不是逐行编辑内容。
+这种方法最适合对文档目录进行高层级更改，而不是逐行编辑内容。
 
-借助这些工具，您可以维护与项目共同演进的准确文档。内容优化后，您可以将其提供给全球用户。具体方法请参阅[翻译文档](./features-translate-documentation.md)指南。
+借助这些工具，您可以维护与项目一同演进的准确文档。内容优化后，您可以将其提供给全球受众。在 [翻译文档](./features-translate-documentation.md) 指南中了解如何操作。

package/docs/features.ja.md

@@ -0,0 +1,52 @@
+# コア機能
+
+AIGNE DocSmithは、ドキュメントのライフサイクルを管理するための一連のコマンドを提供します。初期作成からグローバルな配布までをサポートします。このプロセスは、ドキュメントの生成、改良、翻訳、公開という標準的なワークフローに整理されています。
+
+```d2
+direction: down
+
+Generate: {
+  label: "1. 生成\naigne doc generate"
+  shape: rectangle
+  description: "ソースコードから完全なドキュメントセットを作成します。"
+}
+
+Refine: {
+  label: "2. 更新と改良\naigne doc update"
+  shape: rectangle
+  description: "ドキュメントをコードと同期させ、的を絞ったフィードバックを適用します。"
+}
+
+Translate: {
+  label: "3. 翻訳\naigne doc translate"
+  shape: rectangle
+  description: "グローバルな読者のために、コンテンツを複数の言語にローカライズします。"
+}
+
+Publish: {
+  label: "4. 公開\naigne doc publish"
+  shape: rectangle
+  description: "ドキュメントをパブリックまたはプライベートなプラットフォームにデプロイします。"
+}
+
+Generate -> Refine -> Translate -> Publish
+```
+
+以下のセクションで、DocSmithの主な機能について説明します。
+
+<x-cards data-columns="2">
+  <x-card data-title="ドキュメントの生成" data-icon="lucide:file-plus-2" data-href="/features/generate-documentation">
+    単一のコマンドを使用して、ソースコードから完全なドキュメントセットを作成します。
+  </x-card>
+  <x-card data-title="更新と改良" data-icon="lucide:edit" data-href="/features/update-and-refine">
+    ドキュメントをコードの変更と同期させたり、的を絞ったフィードバックで特定のドキュメントを再生成したりします。
+  </x-card>
+  <x-card data-title="ドキュメントの翻訳" data-icon="lucide:languages" data-href="/features/translate-documentation">
+    コンテンツを複数のサポートされている言語に翻訳し、プロジェクトを世界中のユーザーに利用可能にします。
+  </x-card>
+  <x-card data-title="ドキュメントの公開" data-icon="lucide:send" data-href="/features/publish-your-docs">
+    生成されたドキュメントを公式のDocSmithプラットフォームまたは自己ホスト型のインスタンスに公開します。
+  </x-card>
+</x-cards>
+
+これらの機能は、ドキュメント作成のための構造化されたワークフローを提供します。利用可能なすべてのコマンドとそのオプションの詳細なリストについては、[CLIコマンドリファレンス](./cli-reference.md)を参照してください。

package/docs/features.zh-TW.md

@@ -0,0 +1,52 @@
+# 核心功能
+
+AIGNE DocSmith 提供了一組指令來管理您的文件生命週期，從初始建立到全球發布。整個過程被組織成一個標準化的工作流程：產生、優化、翻譯和發布您的文件。
+
+```d2
+direction: down
+
+Generate: {
+  label: "1. 產生\naigne doc generate"
+  shape: rectangle
+  description: "從您的原始碼建立一套完整的文件。"
+}
+
+Refine: {
+  label: "2. 更新與優化\naigne doc update"
+  shape: rectangle
+  description: "保持文件與程式碼同步，並應用針對性的回饋。"
+}
+
+Translate: {
+  label: "3. 翻譯\naigne doc translate"
+  shape: rectangle
+  description: "將內容本地化為多種語言，以服務全球受眾。"
+}
+
+Publish: {
+  label: "4. 發布\naigne doc publish"
+  shape: rectangle
+  description: "將您的文件部署到公開或私有平台。"
+}
+
+Generate -> Refine -> Translate -> Publish
+```
+
+在以下章節中探索 DocSmith 的主要功能：
+
+<x-cards data-columns="2">
+  <x-card data-title="產生文件" data-icon="lucide:file-plus-2" data-href="/features/generate-documentation">
+    使用單一指令從您的原始碼建立一套完整的文件。
+  </x-card>
+  <x-card data-title="更新與優化" data-icon="lucide:edit" data-href="/features/update-and-refine">
+    讓您的文件與程式碼變更保持同步，或根據針對性的回饋重新產生特定文件。
+  </x-card>
+  <x-card data-title="翻譯文件" data-icon="lucide:languages" data-href="/features/translate-documentation">
+    將您的內容翻譯成多種支援的語言，讓您的專案能接觸到全球受眾。
+  </x-card>
+  <x-card data-title="發布您的文件" data-icon="lucide:send" data-href="/features/publish-your-docs">
+    將您產生的文件發布到官方 DocSmith 平台或您自己託管的實例。
+  </x-card>
+</x-cards>
+
+這些功能為文件提供了一個結構化的工作流程。有關所有可用指令及其選項的詳細清單，請參閱 [CLI 指令參考](./cli-reference.md)。

package/docs/features.zh.md

@@ -1,6 +1,6 @@
 # 核心功能
 
-AIGNE DocSmith 提供了一系列命令来管理您的文档生命周期，从初始创建到全球分发。该过程被组织成一个标准工作流：生成、优化、翻译和发布您的文档。
+AIGNE DocSmith 提供了一组命令来管理您的文档生命周期，从初始创建到全球分发。该过程被组织成一个标准工作流：生成、优化、翻译和发布您的文档。
 
 ```d2
 direction: down
@@ -8,7 +8,7 @@ direction: down
 Generate: {
   label: "1. 生成\naigne doc generate"
   shape: rectangle
-  description: "从您的源代码创建一整套文档。"
+  description: "从您的源代码创建一套完整的文档。"
 }
 
 Refine: {
@@ -32,21 +32,21 @@ Publish: {
 Generate -> Refine -> Translate -> Publish
 ```
 
-在以下各节中探索 DocSmith 的主要功能：
+在以下部分中探索 DocSmith 的主要功能：
 
 <x-cards data-columns="2">
   <x-card data-title="生成文档" data-icon="lucide:file-plus-2" data-href="/features/generate-documentation">
-    使用单个命令从您的源代码创建一整套文档。
+    使用单个命令从您的源代码创建一套完整的文档。
   </x-card>
   <x-card data-title="更新与优化" data-icon="lucide:edit" data-href="/features/update-and-refine">
-    保持您的文档与代码更改同步，或根据有针对性的反馈重新生成特定文档。
+    使您的文档与代码更改保持同步，或根据有针对性的反馈重新生成特定文档。
   </x-card>
   <x-card data-title="翻译文档" data-icon="lucide:languages" data-href="/features/translate-documentation">
-    将您的内容翻译成多种支持的语言，使您的项目能够面向全球受众。
+    将您的内容翻译成多种支持的语言，使您的项目能够触达全球受众。
   </x-card>
   <x-card data-title="发布您的文档" data-icon="lucide:send" data-href="/features/publish-your-docs">
-    将您生成的文档发布到官方 DocSmith 平台或您自己的自托管实例。
+    将您生成的文档发布到官方 DocSmith 平台或您自己自托管的实例。
   </x-card>
 </x-cards>
 
-这些功能为文档管理提供了一个结构化的工作流。要获取所有可用命令及其选项的详细列表，请参阅 [CLI 命令参考](./cli-reference.md)。
+这些功能为文档工作提供了一个结构化的工作流。有关所有可用命令及其选项的详细列表，请参阅 [CLI 命令参考](./cli-reference.md)。

package/docs/getting-started.ja.md

@@ -0,0 +1,123 @@
+# はじめに
+
+このガイドでは、AIGNE DocSmithをインストールし、プロジェクトを設定し、ソースコードから完全なドキュメント一式を生成するためのステップバイステップのウォークスルーを提供します。
+
+## ステップ1: 前提条件
+
+始める前に、システムにNode.jsとそのパッケージマネージャーであるnpmがインストールされていることを確認してください。DocSmithは、Node.js環境で実行されるコマンドラインツールです。
+
+### Node.jsのインストール
+
+以下に、さまざまなオペレーティングシステムにNode.jsをインストールするための簡単な手順を示します。
+
+**Windows**
+1.  公式の[Node.jsウェブサイト](https://nodejs.org/)からインストーラーをダウンロードします。
+2.  `.msi`インストーラーを実行し、インストールウィザードの手順に従います。
+
+**macOS**
+
+推奨される方法は[Homebrew](https://brew.sh/)を使用することです:
+
+```bash Terminal icon=lucide:apple
+# Install Homebrew if you don't have it
+/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+
+# Install Node.js
+brew install node
+```
+
+または、[Node.jsウェブサイト](https://nodejs.org/)から`.pkg`インストーラーをダウンロードすることもできます。
+
+**Linux**
+
+Ubuntu/Debianベースのシステムの場合:
+
+```bash Terminal icon=lucide:laptop
+sudo apt update
+curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash -
+sudo apt-get install -y nodejs
+```
+
+CentOS/RHEL/Fedoraベースのシステムの場合:
+
+```bash Terminal icon=lucide:laptop
+curl -fsSL https://rpm.nodesource.com/setup_lts.x | sudo bash -
+sudo yum install nodejs
+```
+
+### 確認
+
+インストール後、ターミナルでこれらのコマンドを実行して、Node.jsとnpmが利用可能であることを確認します:
+
+```bash Terminal
+node --version
+npm --version
+```
+
+## ステップ2: AIGNE CLIのインストール
+
+The DocSmithツールは、AIGNEコマンドラインインターフェース(CLI)に含まれています。npmを使用してAIGNE CLIの最新バージョンをグローバルにインストールします:
+
+```bash Terminal icon=logos:npm
+npm i -g @aigne/cli
+```
+
+インストールが完了したら、ドキュメンテーションツールのヘルプコマンドを実行して確認します:
+
+```bash Terminal
+aigne doc -h
+```
+
+このコマンドはDocSmithのヘルプメニューを表示し、使用準備が整っていることを確認します。
+
+## ステップ3: ドキュメントの生成
+
+CLIがインストールされたら、単一のコマンドでドキュメントを生成できます。ターミナルでプロジェクトのルートディレクトリに移動し、次を実行します:
+
+```bash Terminal icon=lucide:sparkles
+aigne doc generate
+```
+
+### 自動設定
+
+プロジェクトでこのコマンドを初めて実行すると、DocSmithは設定が存在しないことを検出し、対話式のセットアップウィザードを自動的に起動します。
+
+![generateコマンドを実行するとセットアップウィザードが開始されます](https://docsmith.aigne.io/image-bin/uploads/0c45a32667c5250e54194a61d9495965.png)
+
+ドキュメントの特性を定義するための一連の質問が表示されます。これには以下が含まれます:
+
+- 主な目的とスタイル。
+- 対象読者。
+- 主要言語と翻訳用の追加言語。
+- AIが分析するためのソースコードのパス。
+- 生成されたドキュメントの出力ディレクトリ。
+
+![プロンプトに答えてプロジェクトのセットアップを完了します](https://docsmith.aigne.io/image-bin/uploads/fbedbfa256036ad6375a6c18047a75ad.png)
+
+設定が完了すると、DocSmithはソースコードの分析、ドキュメント構造の計画、コンテンツの生成に進みます。
+
+![DocSmithが構造を計画し、ドキュメントを生成しています](https://docsmith.aigne.io/image-bin/uploads/d0766c19380a02eb8a6f8ce86a838849.png)
+
+## ステップ4: 出力の確認
+
+生成プロセスが終了すると、ターミナルに確認メッセージが表示されます。
+
+![ドキュメント生成成功のメッセージ](https://docsmith.aigne.io/image-bin/uploads/0967443611408ad9d0042793d590b8fd.png)
+
+新しいドキュメントは、セットアッププロセス中に指定した出力ディレクトリで利用可能になりました。デフォルトの場所は `.aigne/doc-smith/docs` です。
+
+## 次のステップ
+
+最初のドキュメントセットを生成したので、他の機能を試すことができます:
+
+<x-cards>
+  <x-card data-title="コア機能" data-icon="lucide:box" data-href="/features">
+    ドキュメントの更新からオンラインでの公開まで、主要なコマンドと機能を探ります。
+  </x-card>
+  <x-card data-title="設定ガイド" data-icon="lucide:settings" data-href="/configuration">
+    config.yamlファイルを編集して、ドキュメントのスタイル、対象読者、言語を微調整する方法を学びます。
+  </x-card>
+  <x-card data-title="CLIコマンドリファレンス" data-icon="lucide:terminal" data-href="/cli-reference">
+    利用可能なすべての `aigne doc` コマンドとそのオプションの完全なリファレンスを取得します。
+  </x-card>
+</x-cards>

package/docs/getting-started.zh-TW.md

@@ -0,0 +1,123 @@
+# 入門指南
+
+本指南將逐步引導您安裝 AIGNE DocSmith、設定專案，並從您的原始碼產生一套完整的說明文件。
+
+## 步驟 1：先決條件
+
+在開始之前，請確保您的系統上已安裝 Node.js 及其套件管理器 npm。DocSmith 是一個在 Node.js 環境中執行的命令列工具。
+
+### 安裝 Node.js
+
+以下是在各種作業系統上安裝 Node.js 的簡要說明。
+
+**Windows**
+1.  從 [Node.js 官方網站](https://nodejs.org/) 下載安裝程式。
+2.  執行 `.msi` 安裝程式並依照安裝精靈的步驟進行。
+
+**macOS**
+
+建議的方法是使用 [Homebrew](https://brew.sh/)：
+
+```bash Terminal icon=lucide:apple
+# 如果您尚未安裝 Homebrew，請先安裝
+/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+
+# 安裝 Node.js
+brew install node
+```
+
+或者，您也可以從 [Node.js 網站](https://nodejs.org/) 下載 `.pkg` 安裝程式。
+
+**Linux**
+
+對於基於 Ubuntu/Debian 的系統：
+
+```bash Terminal icon=lucide:laptop
+sudo apt update
+curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash -
+sudo apt-get install -y nodejs
+```
+
+對於基於 CentOS/RHEL/Fedora 的系統：
+
+```bash Terminal icon=lucide:laptop
+curl -fsSL https://rpm.nodesource.com/setup_lts.x | sudo bash -
+sudo yum install nodejs
+```
+
+### 驗證
+
+安裝完成後，請在您的終端機中執行以下指令，以驗證 Node.js 和 npm 是否可用：
+
+```bash Terminal
+node --version
+npm --version
+```
+
+## 步驟 2：安裝 AIGNE CLI
+
+DocSmith 工具包含在 AIGNE 命令列介面 (CLI) 中。請使用 npm 全域安裝最新版本的 AIGNE CLI：
+
+```bash Terminal icon=logos:npm
+npm i -g @aigne/cli
+```
+
+安裝完成後，請執行說明文件的說明指令來驗證：
+
+```bash Terminal
+aigne doc -h
+```
+
+此指令將顯示 DocSmith 的說明選單，確認其已準備就緒可供使用。
+
+## 步驟 3：產生您的說明文件
+
+安裝 CLI 後，您只需一個指令即可產生文件。請在終端機中導覽至您專案的根目錄並執行：
+
+```bash Terminal icon=lucide:sparkles
+aigne doc generate
+```
+
+### 自動設定
+
+當您首次在專案中執行此指令時，DocSmith 會偵測到尚無設定，並自動啟動一個互動式設定精靈。
+
+![執行 generate 指令會啟動設定精靈](https://docsmith.aigne.io/image-bin/uploads/0c45a32667c5250e54194a61d9495965.png)
+
+系統將會提示您一系列問題，以定義說明文件的特性，包括：
+
+- 主要目的與風格。
+- 預期的目標讀者。
+- 主要語言及任何用於翻譯的其他語言。
+- 供 AI 分析的原始碼路徑。
+- 產生文件的輸出目錄。
+
+![回答提示以完成專案設定](https://docsmith.aigne.io/image-bin/uploads/fbedbfa256036ad6375a6c18047a75ad.png)
+
+設定完成後，DocSmith 將會開始分析您的原始碼、規劃文件結構並產生內容。
+
+![DocSmith 正在規劃結構並產生文件](https://docsmith.aigne.io/image-bin/uploads/d0766c19380a02eb8a6f8ce86a838849.png)
+
+## 步驟 4：檢閱您的輸出
+
+產生過程結束後，您的終端機中將會顯示一則確認訊息。
+
+![成功產生說明文件的訊息](https://docsmith.aigne.io/image-bin/uploads/0967443611408ad9d0042793d590b8fd.png)
+
+您新的說明文件現在位於您在設定過程中指定的輸出目錄中。預設位置是 `.aigne/doc-smith/docs`。
+
+## 接下來呢？
+
+現在您已經產生了第一份文件，可以探索其他功能：
+
+<x-cards>
+  <x-card data-title="核心功能" data-icon="lucide:box" data-href="/features">
+    探索主要指令與功能，從更新文件到線上發布。
+  </x-card>
+  <x-card data-title="設定指南" data-icon="lucide:settings" data-href="/configuration">
+    了解如何透過編輯 config.yaml 檔案來微調您文件的風格、目標讀者和語言。
+  </x-card>
+  <x-card data-title="CLI 指令參考" data-icon="lucide:terminal" data-href="/cli-reference">
+    取得所有可用的 `aigne doc` 指令及其選項的完整參考。
+  </x-card>
+</x-cards>