M
ドキュメント変更の品質を一括チェック・修正
by mkei29
mainブランチから変更されたMarkdownファイルを自動で検出。 .dodo.yamlへの登録漏れを検知し、修正提案を自動出力。 フロントマター(ファイルの先頭に書く設定情報)の不備を自動検出・補完。 スペルミスや文法エラー、句読点の誤りを検出して修正。 最後に整合性チェックを実行して、すべてのエラーが解消されたことを確認。 ドキュメント執筆者で、品質管理を自動化したい人 ナレッジベース・マニュアル管理者で、掲載ミスを防ぎたい人 チームで複数のドキュメントを運用しており、統一性を保ちたい人 エンジニアで、ドキュメント修正をコード変更と同時に検証したい人 3フェーズで実行:PHASE 1ではgit diff --name-status mainで新規Markdownファイルを抽出し、.dodo.yamlのpagesセクションで明示的登録またはmatchパターンカバレッジを検証。未登録ファイルへの追加提案も出力。PHASE 2では変更ファイルごとにフロントマター検証(必須フィールド:title, path, description の有無確認と不足時補完)と誤字脱字検出(スペルミス・文法・句読点エラーをコードブロック・技術用語は除外して検査)を実行。PHASE 3ではdodo checkを実行し、エラーがある場合は原因特定と修正を繰り返して完全解消まで実行。出力レポートには新規ファイル登録状況、レビューファイル一覧、ファイルごと修正内容、dodo check結果、全体統計を記載。
レビュードキュメント