メインコンテンツへスキップ

インタラクティブモード

コマンドラインのオプションに圧倒されていませんか？このガイドでは、ドキュメント作成プロセスのあらゆるステップを簡素化する対話型インターフェース、インタラクティブモードの使い方を説明します。このガイドを読み終える頃には、シンプルで自然な言語の指示を使って、ドキュメントの生成、更新、翻訳、公開ができるようになります。

インタラクティブモードは、特定のコマンドとそのパラメータを覚える必要をなくし、ガイド付きのワークフローを提供するため、ドキュメント管理に推奨される方法です。

インタラクティブセッションの開始

インタラクティブモードを起動するには、プロジェクトのルートディレクトリから chat コマンドを実行します。

aigne doc chat

bash
aigne doc chat

このコマンドはインタラクティブセッションを開始し、アシスタントが指示を促します。

主要な機能

インタラクティブモードは、いくつかの主要な機能を単一の対話型インターフェースに統合することで、ドキュメント作成のライフサイクル全体を効率化します。目標を平易な言葉で述べると、アシスタントが必要なステップを実行します。

ドキュメント生成

プロジェクトのソースコードを分析し、完全なドキュメント構造と初期コンテンツを作成します。

更新と修正

フィードバックやソースコードの最近の変更に基づいて、特定のドキュメントやセクション全体を修正します。

コンテンツの翻訳

グローバルな読者に対応するため、ドキュメントを複数のサポートされている言語に翻訳します。

ドキュメント公開

ガイド付きのプロセスに従ってドキュメントを公開し、オンラインで利用できるようにします。

対話方法

アシスタントとの対話には、主に2つの方法があります。

  1. 自然言語による指示

    達成したいタスクを説明します。アシスタントはあなたのリクエストを解釈し、適切なワークフローを開始します。例えば、「このプロジェクトのドキュメントを生成して」や「インストールガイドをドイツ語とフランス語に翻訳して」と入力できます。

  2. 直接コマンド

    update や publish のように、特定の機能のコマンド名をチャットプロンプトに直接入力して呼び出すこともできます。

利用可能なコマンド

インタラクティブモードは、その主要な機能に対応する一連のコマンドを理解します。これらの機能は自然言語でトリガーできますが、コマンドを直接使用することも可能です。

コマンド説明
generateソースファイルから新しいドキュメントの構造とコンテンツを作成するワークフローを開始します。
updateコードの変更やユーザーのフィードバックに基づいて既存のドキュメントを修正するプロセスを開始します。
translateドキュメントを1つ以上のサポートされている言語に翻訳するプロセスを開始します。
publishドキュメントをオンラインで公開する手順をガイドします。
initプロジェクトの初期設定ファイル (docsmith.config.js) の作成を支援します。
clear生成されたファイル、設定、キャッシュデータをプロジェクトから削除します。
prefs保存されているドキュメント生成の設定を表示・管理できます。
evaluate生成されたドキュメントの品質と完全性を評価し、レポートを提供します。
historyドキュメントに行われた更新と変更の履歴を表示します。
exitインタラクティブチャットセッションを終了し、標準のターミナルプロンプトに戻ります。

対話例

以下のやり取りは、チャットアシスタントを使用して新しいドキュメントを生成する典型的なワークフローを示しています。

text
あなた:
> このプロジェクトのドキュメントを作成したいです。

AIアシスタント:
承知しました。現在のディレクトリでドキュメント生成プロセスを開始します。
まず、プロジェクトを分析してドキュメントの構造を提案します。これには少し時間がかかる場合があります...
...
分析が完了しました。提案された構造を作成しました。コンテンツを生成する前に確認しますか？ (yes/no)

あなた:
> yes

AIアシスタント:
（提案されたドキュメント構造がここに表示され、確認できます。）
...
「API認証のガイドを追加して」や「インストールガイドとセットアップガイドを統合して」などの変更をリクエストできます。構造が正しければ、「continue」と入力してください。

あなた:
> continue

AIアシスタント:
了解しました。それでは、各ドキュメントのコンテンツ生成に進みます。プロジェクトの規模によっては、時間がかかる場合があります。

この対話は、アシスタントが分析、レビュー、コンテンツ生成を通じてユーザーをガイドし、簡単なテキストベースの応答のみを要求する方法を示しています。

まとめ

インタラクティブモードは、ドキュメントを管理するための体系的でガイド付きの方法を提供します。ツールの全機能を単一の対話型インターフェースに集約し、正確で効率的なワークフローを保証します。

インタラクティブモードの実際の適用例については、ドキュメント生成ガイドで段階的なウォークスルーを参照してください。