よくある質問について
このページでは、annai（ソースコードからマニュアルを自動生成するツール）についてよく寄せられる質問と回答をまとめています。
設定のカスタマイズについて
マニュアルのサイト名を変更できますか？
はい、annai.config.json（annai の 設定ファイル）の siteName を変更します。
変更後に annai gen を実行すると、新しいサイト名が反映されます。
詳しくは 生成設定をカスタマイズする をご覧になれます。
品質チェックについて
品質チェックとは何ですか？
annai が生成したマニュアルページを、文体統一、技術用語の説明、ステップ構造、注意事項の記載、内部リンクの有無を含む7つの観点で自動採点する仕組みです。 100点満点で採点し、82点未満のページは自動で再生成を試みます。 詳しくは 生成ページの品質を確認する をご覧になれます。
品質チェックをスキップできますか？
はい、--no-quality-gate オプションを付けると、品質チェックを実行せずにマニュアルを生成できます。
annai gen --no-quality-gate を実行します。
品質チェックで警告が出たページはどうすればよいですか？
警告に表示されたファイルを開き、減点された項目を参考にして手動で修正します。 詳しくは 生成ページの品質を確認する をご覧になれます。
公開について
マニュアルを公開するには何が必要ですか？
Cloudflare（マニュアルの公開先サービス）のアカウントと、以下の2つの情報が必要です。
- API トークン（外部ツールからの操作を許可する認証キー）
- アカウント ID
取得方法は マニュアルを公開する で詳しく説明しています。
公開したマニュアルの URL はどうなりますか？
https://プロジェクト名.pages.dev という形式の URL になります。
プロジェクト名は annai.config.json の cloudflare.projectName で指定した値が使われます。
ソースコードを変更するたびに手動でデプロイする必要がありますか？
いいえ、GitHub Actions（ソースコードの変更を検知して処理を自動実行する仕組み）を設定すると、ソースコードの変更時にマニュアルの再生成とデプロイ（公開先サーバーへのアップロード）が自動で実行されます。 詳しくは CI/CDで自動更新を設定する をご覧になれます。
更新履歴について
更新履歴にはどのような変更が含まれますか？
以下の3種類の変更が対象です。
- 新機能の追加（変更メモが
feat:で始まるもの） - 不具合の修正（変更メモが
fix:で始まるもの） - 性能の改善（変更メモが
perf:で始まるもの）
コードの整理、設定変更、テストの追加といった内部的な変更は含まれません。 詳しくは 更新履歴を自動生成する をご覧になれます。
更新履歴に含める期間を限定できますか？
自動では限定できません。
生成後に user-manual/docs/changelog.mdx をテキストエディタで開き、不要な日付のセクションを手動で削除します。
その他
生成済みのマニュアルを手動で編集してもよいですか？
はい、user-manual/docs/ フォルダ内の MDX ファイルをテキストエディタで自由に編集できます。
ただし、annai gen（一括生成）を再度実行すると、手動の変更は上書きされます。
手動編集を保持したい場合は、annai gen --mode incremental（差分更新）を使います。
annai 自体のバージョンを更新するにはどうすればよいですか？
以下のコマンドを実行すると、最新バージョンに更新されます。
npm install -g annai@latest
困ったときは
上記の回答で問題が解決しない場合は、トラブルシューティング をご覧になれます。 具体的なエラーメッセージごとの対処方法を掲載しています。