レビューの観点

共有ツールを読むときに何を見るか、何を指摘に含めないか、どう書くか

📅 作成: 2026-09-19 / 更新: 2026-09-23

ai-chat-lite レビューワ

目次

  1. 観点の一覧
  2. 指摘に含めないもの
  3. 指摘の書き方
  4. 観点を足した経緯

観点の一覧

観点を足すときはこの表に足す。置き場を 2 つにしない。1 回の手順は共有ツールの定期レビューにある。

観点見るもの
ドキュメント と 実装 資料に書かれた仕様と、実装(src/・CLI のオプション・API の口)の食い違い。CLI は -h の実物を取って突き合わせる
ドキュメント同士 目次と実際の見出し、コマンド一覧とヘルプ出力、オプション名・既定値。同じ資料の中に同じ定義が 2 か所ある箇所は特に食い違う
スキーマ 設計書の DDL・列の表と、マイグレーション SQL(src/scripts/20_migrate/)の差
HTML と Markdown 生成された Markdown の内容のずれ、リンク切れ、作成日・更新日の不一致
番号と連番 課題 ID・計画書のファイル名・章番号の重複や欠番
資料の参照関係 「設計から参照する」などの決めごとと、実際のリンクの有無
決めごと と 実装 課題(issues.html)で「済」になった決定と、実装の向きが逆になっていないか。逆なら両方を並べて出す。実装が正とは限らない。決めごとの側を変えるのも解消の 1 つで、どちらにするかは相手の判断
同じ定義の重複 同じ DDL・同じ表・同じ文が資料の 2 か所以上にあるか。一括置換の目印が両方に当たって片方が壊れる、片方だけ直って食い違う、が実際に起きた
共通ルールとの食い違い 相手の資料が共通ルールの決めごとと逆のことを案内していないか。指すときは見出し名だけを挙げ、ルールの本文は貼らない
コードレビュー 不具合・境界条件・エラー処理の穴。とくに「黙って違う結果を返す」経路(exit 0 で中身が違う、例外や Exit が catch を貫通する、片方向だけの検査)。CLI が 2 本あるものは同じ入力で動きが揃うか
課題の状態と実装 issues.html の 未 / 着手 / 済 と、やることのチェックを現物と突き合わせる。済なのに直っていない(症状が入れ替わっただけ)、未なのに済んでいる、件数・内訳が中身と合わない
テストの品質と漏れ 直しに回帰テストがあるか。テスト名と本文の一致、写しだけを守って本体を踏まない、期待値ゼロ・常に真の判定・片方向の比較、失敗を成功として扱うランチャー、本番データや実在の個人名の使用、冪等性。実行はせず読んで判断する
セキュリティと伏せ字 コード・資料・テストデータ・スクリプト・生成物に、伏せるべきもの(個人名・メールアドレス・ユーザー名・ホスト名・トークン・実体パス)が残っていないか。認証なしの管理系の口、外部入力の検証、画面への挿入、ログに出る生パス、一時ファイルの置き場、上書きの原子性。指摘には実値を書かず種類と場所だけ書く
利用者の失敗事例の逆引き public で他プロジェクトが報告した失敗を起点に、原因の置き場(資料・実装・共通ルール・使う側)と、再発を防ぐ手当て(資料・案内・課題)の有無を現物で確かめる。資料に書いてあっても踏まれているなら、書いてある場所と言い方を疑う
利用側への影響 共有ツールの変更(新オプション・挙動の変更・クラス名の追加)が、他プロジェクトの手順・USAGE・共通ルールの記述を古くしていないか
直近の変更の追随 前回以降のコミットごとに、資料・課題・テスト・「変わったこと」への反映を見る。直したつもりで別の理由でまだ動かない形と、同じ形の穴が別の場所に残っていないかを疑う
前回指摘の解消確認 前回の指摘を現物で「解消/未解消/別の理由で動かない/採らないと決めた」に分ける。結果で保存ファイルの章 3「相手の対応」を更新する
README が持ちすぎていないか 手順・運用の決めごと・観点が README にある。正は共通ルールか計画書の側にあり、README のものは写し。写しを持つ側が取り残される
増え続ける記録の置き場 レビューや変更の一覧など、回ごとに増えるものが README にある。索引はそのフォルダに置き、README からは 1 本のリンクにする
リポジトリの外を指すリンク ../ で別プロジェクトを指すリンク。ローカルでは開けるが、GitHub でも Pages でも切れる
ルール変更への追随 共通ルールが変わった後、それ以前に作られたファイルが古い形のまま残っていないか。見た目が壊れないので気づけない
章番号での参照 「章 3 の順 8」のような番号での参照。章を増減すると黙ってずれる。手順の参照先が別の章を指す
指摘と兆候の結びつけ 過去に出した指摘・受けた懸念と、いま見えている別の兆候が同じ原因を指していないか。別々の報告として流さず、結びつけてから判断する

指摘に含めないもの

書式や仕様が変わった直後は、古い形の文字列が多く残る。次のものは記録なので、そのままが正しい。

種類例
実測ログの貼り付け課題や調査に貼られた、その時点の出力
旧と新の対比「旧: …」「新: …」と並べて違いを示している箇所
処理の途中の値変換の各段階をコメントで示した中間の形
別の仕組みの出力サーバーとは別のスクリプトが独自の書式で書くログ
意図した旧形式のテストデータ旧形式から新形式への変換を検証するための入力

指摘の書き方

守ること中身
場所を書くファイルパスと行番号。読み手が自分で現物を確かめられるようにする
食い違いを書くどちらが何と言っているかを両方書く。片方だけでは判断できない
直し方は書かない直すかどうか・どう直すかは相手側の判断
食い違いが無かった所も書く確認済みの範囲が分かる。同じ所を何度も見ずに済む
前回の解消を先に書く「前回の N 件のうち M 件は解消を確認」を冒頭に置く。未修正の分は再送せず、相手から番号を聞かれたときだけ場所を答える
実測を添えるコマンドの実物の出力(-h・recent・API の応答)を取ってから書く。資料と資料の比較だけで判断しない
ルールの本文を貼らない貼った本文はその場で古くなる。見出し名と、変わった点だけを伝える

観点を足した経緯

2026-09-09 に 8 つを足した。この表は経緯であって一覧ではない。観点そのものは章 1 にある。

足した観点なぜ足したか
コードレビュー 資料との突き合わせだけでは「黙って違う結果を返す」経路(exit 0 で中身が違う、Exit が catch を貫通する、片方向だけの検査)を拾えなかった。レビュー #19・#20 の high はすべてこの形
課題の状態と実装 「済」と記録されたが exit 2 が exit 1 に変わっただけのものがあった(#20 の high)。記録の状態と現物を突き合わせる
テストの品質と漏れ 直しに回帰テストが無い・テストが写しだけを守って本体を踏まない・期待値ゼロ・片方向比較、が両ツールで繰り返し出た
セキュリティと伏せ字 共通ルールの伏せ字はコード・資料・テストデータ・ログにも及ぶ。認証なしの管理系と本文の挿入(XSS)が実際にあった(#19)。実値は書かず、種類と場所だけ指摘する
利用者の失敗事例の逆引き public で報告された失敗(初回の待受けの取りこぼし、chapters の href、-r のクォート)は、資料に書いてあっても踏まれている。報告を起点に、原因の置き場(資料・実装・ルール・使う側)と手当ての有無を確かめる
利用側への影響 共有ツールの変更(新オプション、初回 wait の挙動)は、他プロジェクトの手順と共通ルールを古くする。変更のたびに使う側の記述が追いついているかを見る
直近の変更の追随 コミット単位で、資料・課題・テスト・「変わったこと」への反映を見る。直したつもりで別の理由で動かない形を疑う
前回指摘の解消確認 相手の「直した」は鵜呑みにしない。観点として独立させ、保存ファイルの章 3「相手の対応」を更新する起点にする