Fowel

Fowelとは？

Fowelは、プルリクエストのドキュメント変更をレビューするGitHub Appです。変更がマージされる前に、ドキュメントの問題（不正確または古い情報、不足した文脈、不明確な記述、壊れた例など）を検知するよう、インラインコメントとまとめレビューを自動投稿します。

Fowelの主な目的は、コードレビューに加えて自動化されたドキュメント品質チェックを追加することです。MarkdownやMDXなどのドキュメントファイルを対象に、複数の品質要素で評価し、開発者とレビュアーがワークフローの早い段階で問題を修正できるようにします。

PRごとのドキュメントレビュー用GitHub App: FowelをGitHubリポジトリにインストールすると、プルリクエストにドキュメント変更が含まれる場合にレビューを実行します。
ドキュメントファイルの自動検知: PRでMarkdown、MDX、その他のドキュメントファイルが変更された場合に自動検知するため、レビュアーが手動でチェック対象を選択する必要はありません。
インラインコメント＋まとめレビュー: プルリクエストに詳細なインラインコメントと全体レビューを投稿し、レビュー中に問題を可視化します。
複数品質要素でのドキュメント監査: 内容の正確性、開発者体験/オンボーディングフロー、構造と情報アーキテクチャ、コードサンプル（実行可能性とエラー処理を含む）、明瞭さとスタイル、完全性をチェックします。
自動レビューと手動レビューの両対応: 自動実行と手動トリガーの両方をサポートします。

GitHub Appをインストール: ワンクリックインストールでリポジトリにFowelを追加します。ウェブサイトによると、設定ファイル、CI変更、セットアップスクリプトは不要です。
ドキュメント変更を含むプルリクエストを作成: ブランチにドキュメント更新をプッシュしてPRを開きます。Fowelがドキュメントファイルを自動検知します。
PRでFowelのフィードバックを確認: Fowelが投稿したインラインコメントとまとめを確認します。問題（例: 古い記述、不足したエラードキュメント、壊れたコードサンプル）を修正し、必要に応じてPRを更新します。

マージ前の古い手順検知: チームがAPIドキュメントやガイドを更新する際、コードレビューだけでは見逃されやすい矛盾や誤った手順をFowelが指摘します。
「初回成功までの時間」を改善するオンボーディングフロー: ドキュメントの開発者体験を評価し、セットアップ文脈の不足による離脱を防ぎ、初回のAPI呼び出しまで到達しやすくします。
リファレンスドキュメントの品質検証: エンドポイントやAPIリファレンスページで、ナビゲーション、構造、命名、クロスリンク、完全性が開発者の詳細参照をサポートしているかをチェックします。
壊れたり誤解を招くコードサンプルの検知: 例が古くなったり必要なエラー処理が欠けている場合、実行可能性と構文の正しさを検証し、開発者が失敗するスニペットをコピー/ペーストしないようにします。
エラー/文脈ドキュメント不足によるサポート負担軽減: パラメータ、認証情報、エラーレスポンスに関するドキュメント変更で、情報が存在し十分に明確かを確認し、「推測」や繰り返し質問を防ぎます。

FowelはMarkdownファイルのみレビューしますか？
いいえ。プルリクエストに含まれるMarkdown、MDX、その他のドキュメントファイルを自動検知します。

結果はどこに表示されますか？
Fowelはプルリクエストにインラインコメントとまとめレビューを投稿します。

レビューは自動のみですか、手動も可能ですか？
両方対応: 自動レビューと手動トリガーをサポートします。

Fowelはドキュメントの何をチェックしますか？
内容の正確性、開発者体験、構造と情報アーキテクチャ、コードサンプル、明瞭さとスタイル、完全性など、複数の品質要素でドキュメント監査を行います。

Fowelはコードレビューを置き換えますか？
ウェブサイトでは、プルリクエストワークフローの追加ドキュメント品質チェックとして位置づけられており、コードレビュアーが指摘しにくいドキュメント問題に特化してコードレビューを補完します。

社内ドキュメントレビュー工程（チェックリストやピアレビュー）：チームは品質チェックリストを使った人間レビューに頼れます。Fowelに比べて自動化が少なく、通常問題を後で検知します。
静的ドキュメントリンター：ドキュメントリンターはフォーマットや基本的な正しさのルールを強制できますが、Fowelで説明される多角的なドキュメント監査や文脈付きインライン・レビューは一般的に提供しません。
ビルトイン検証付きAPIドキュメントプラットフォーム：APIドキュメント生成ツールは特定のソースでドキュメントずれを減らせますが、Fowelで説明される文章品質、オンボーディングフロー、構造、例の実行可能性をレビューしません。
汎用プルリクエストレビュー自動化：広範なCIやPR自動化はビルドやテストの破損をフラグできますが、ドキュメントの正確性、明瞭さ、完全性に特化していません。