マニュアルの品質を確認するには
このページでは、annai（ソースコードからユーザー向けマニュアルを自動生成するツール）が生成したページの品質レポートを確認し、必要に応じて改善します。
手順
-
マニュアルを生成します。品質チェック（品質ゲート（生成されたページを自動採点し、基準未満のページを検出する仕組み）による検査）は生成時に自動で実行されます。
annai gen -
生成が完了すると、ターミナル（コマンドを入力する画面）に品質レポートが表示されます。「合格」と表示されたページは品質基準（82点以上）を満たしています。「警告（注意が必要な状態を示すメッセージ）」と表示されたページは、減点された観点と減点幅を確認します。
-
警告のあるページは、出力先フォルダ内の該当ファイルをテキストエディタで開き、減点の観点に応じて内容を修正します。主な修正ポイントは以下の通りです。
減点の観点 対応方法 文体統一 常体の文末（「〜しました。」ではない「〜した。」や「〜できる。」ではない「〜する。」）を敬体（「〜します。」「〜です。」）に書き換えます ステップ構造 手順を番号付きリスト（1. 2. 3.）で3件以上記述します エラー対処記載 注意ブロックで注意事項や対処法を追加します
ここまでの手順が完了すると、すべてのページが品質基準を満たした状態になります。
警告
品質チェックを省略したい場合は annai gen --no-quality-gate を実行します。
すべてのページに警告が出る場合は、解析対象のソースコードが少ない可能性があります。annai.config.json の sourcePath や sourceExtensions の設定を見直します。