このガイドでは、update コマンドを使用して既存のドキュメントを修正する方法について説明します。ドキュメントのコンテンツを更新したり、図を追加または更新したり、フィードバックを通じて図を削除したりできます。
基本的な使い方
対話モード
引数なしでコマンドを実行すると、対話モードに入ります。
aigne doc updateドキュメントを選択し、フィードバックを提供して更新します。
コマンドラインモード
コマンドラインフラグを使用してドキュメントを直接更新します。
aigne doc update --docs /overview --feedback "コア機能についてより詳細な説明を追加してください。"図の更新
フィードバックを提供することで、ドキュメント内の図を更新できます。このツールは、既存の図の更新や新しい図の追加をサポートしています。
特定の図を更新する
図を更新するためのフィードバックを提供します。
aigne doc update --docs /overview --feedback "新しいアーキテクチャを示すように図を更新してください"すべての図を更新する
--diagram フラグを使用して、図を含むドキュメントをフィルタリングして選択します。
aigne doc update --diagramまたは、--diagram-all を使用して、図を含むすべてのドキュメントを自動的に更新します。
aigne doc update --diagram-all図を削除する
フィードバックを提供して図を削除します。
aigne doc update --docs /overview --feedback "図を削除してください"図のスタイル
DocSmith は複数の図スタイルをサポートしています。フィードバックでスタイルを指定するか、デフォルトのスタイルを設定できます。サポートされているスタイルは次のとおりです。
モダン
現代的なデザイン要素を持つ、クリーンでプロフェッショナルなスタイル。
標準フローチャート
従来の記号を使用した伝統的なフローチャートスタイル。
手書き風
自然で有機的な線を持つスケッチ風のスタイル。
擬人化
鮮やかで人間のような特徴を持つ、擬人化された要素。
フラットデザイン
影や3D効果のないフラットなデザイン。
ミニマリスト
最大限の明瞭さを備えた最小限の要素。
3D
奥行きと遠近感のある三次元効果。
コマンドパラメータ
| パラメータ | 説明 | 必須 |
|---|---|---|
--docs | 更新するドキュメントのパスを指定します。複数回使用できます。 | オプション |
--feedback | 行うべき変更に関するテキスト指示を提供します。 | オプション |
--reset | 既存のコンテンツを無視して、ドキュメントを最初から再作成します。 | オプション |
--glossary | 用語集ファイルへのパス (@/path/to/glossary.md) を指定します。 | オプション |
--diagram | 図を含むドキュメントのみを表示し、ユーザーが更新するものを選択できるようにフィルタリングします。 | オプション |
--diagram-all | 図を含むすべてのドキュメントを自動選択し、ユーザーの選択なしで更新します。 | オプション |