マニュアルを一括生成するには
このページでは、annai(ソースコードからユーザー向けマニュアルを自動生成するツール)を使い、マニュアル一式を生成します。
手順
-
ターミナル(コマンドを入力する画面)を開き、annai.config.json があるプロジェクトのフォルダへ移動します。
-
以下のコマンドを入力し、キーボードの Enter(実行)キーを押します。
annai gen -
処理が完了するまで待ちます。annai がソースコードを解析し、マニュアル一式を自動で生成します。
-
ターミナルに「完了」と表示されたら、出力先フォルダ(初期設定では
./user-manual)の中身を確認します。
ここまでの手順が完了すると、出力先フォルダにマニュアル一式が生成された状態になります。
警告
「認証が切れています」というメッセージが表示された場合は、claude login を実行して再認証します。
その後、annai gen --mode incremental で中断箇所から再開できます。
「レートリミットに達しました」というメッセージが表示された場合は、数分間待ってから同じコマンドで再開します。