144 lines
3.4 KiB
Markdown
144 lines
3.4 KiB
Markdown
# review — 汎用レビューレポートテンプレート
|
||
|
||
> **用途**: レビュームーブメントの出力レポート（全レビュータイプの基本形）
|
||
> **バリエーション**: アーキテクチャ / AI / QA / フロントエンド
|
||
|
||
---
|
||
|
||
## テンプレート（基本形）
|
||
|
||
```markdown
|
||
# {レビュー名}
|
||
|
||
## 結果: APPROVE / REJECT
|
||
|
||
## サマリー
|
||
{1-2文で結果を要約}
|
||
|
||
## {観点リスト}
|
||
{カスタマイズ: チェックリストまたはテーブル形式}
|
||
|
||
## 問題点（REJECTの場合）
|
||
| # | {カテゴリ列} | 場所 | 問題 | 修正案 |
|
||
|---|-------------|------|------|--------|
|
||
| 1 | {カテゴリ} | `src/file.ts:42` | 問題の説明 | 修正方法 |
|
||
```
|
||
|
||
---
|
||
|
||
## バリエーション
|
||
|
||
### A. アーキテクチャレビュー
|
||
|
||
```markdown
|
||
# アーキテクチャレビュー
|
||
|
||
## 結果: APPROVE / REJECT
|
||
|
||
## サマリー
|
||
{1-2文で結果を要約}
|
||
|
||
## 確認した観点
|
||
- [x] 構造・設計
|
||
- [x] コード品質
|
||
- [x] 変更スコープ
|
||
- [x] テストカバレッジ
|
||
- [x] デッドコード
|
||
- [x] 呼び出しチェーン検証
|
||
|
||
## 問題点（REJECTの場合）
|
||
| # | スコープ | 場所 | 問題 | 修正案 |
|
||
|---|---------|------|------|--------|
|
||
| 1 | スコープ内 | `src/file.ts:42` | 問題の説明 | 修正方法 |
|
||
|
||
スコープ: 「スコープ内」（今回修正可能）/ 「スコープ外」（既存問題・非ブロッキング）
|
||
|
||
## 既存問題（参考・非ブロッキング）
|
||
- {既存問題の記録。今回の変更と無関係な問題}
|
||
```
|
||
|
||
### B. AI生成コードレビュー
|
||
|
||
```markdown
|
||
# AI生成コードレビュー
|
||
|
||
## 結果: APPROVE / REJECT
|
||
|
||
## サマリー
|
||
{1文で結果を要約}
|
||
|
||
## 検証した項目
|
||
| 観点 | 結果 | 備考 |
|
||
|------|------|------|
|
||
| 仮定の妥当性 | ✅ | - |
|
||
| API/ライブラリの実在 | ✅ | - |
|
||
| コンテキスト適合 | ✅ | - |
|
||
| スコープ | ✅ | - |
|
||
|
||
## 問題点（REJECTの場合）
|
||
| # | カテゴリ | 場所 | 問題 |
|
||
|---|---------|------|------|
|
||
| 1 | 幻覚API | `src/file.ts:23` | 存在しないメソッド |
|
||
```
|
||
|
||
### C. QAレビュー
|
||
|
||
```markdown
|
||
# QAレビュー
|
||
|
||
## 結果: APPROVE / REJECT
|
||
|
||
## サマリー
|
||
{1-2文で結果を要約}
|
||
|
||
## 確認した観点
|
||
| 観点 | 結果 | 備考 |
|
||
|------|------|------|
|
||
| テストカバレッジ | ✅ | - |
|
||
| テスト品質 | ✅ | - |
|
||
| エラーハンドリング | ✅ | - |
|
||
| ドキュメント | ✅ | - |
|
||
| 保守性 | ✅ | - |
|
||
|
||
## 問題点（REJECTの場合）
|
||
| # | カテゴリ | 問題 | 修正案 |
|
||
|---|---------|------|--------|
|
||
| 1 | テスト | 問題の説明 | 修正方法 |
|
||
```
|
||
|
||
### D. フロントエンドレビュー
|
||
|
||
```markdown
|
||
# フロントエンドレビュー
|
||
|
||
## 結果: APPROVE / REJECT
|
||
|
||
## サマリー
|
||
{1-2文で結果を要約}
|
||
|
||
## 確認した観点
|
||
| 観点 | 結果 | 備考 |
|
||
|------|------|------|
|
||
| コンポーネント設計 | ✅ | - |
|
||
| 状態管理 | ✅ | - |
|
||
| パフォーマンス | ✅ | - |
|
||
| アクセシビリティ | ✅ | - |
|
||
| 型安全性 | ✅ | - |
|
||
|
||
## 問題点（REJECTの場合）
|
||
| # | 場所 | 問題 | 修正案 |
|
||
|---|------|------|--------|
|
||
| 1 | `src/file.tsx:42` | 問題の説明 | 修正方法 |
|
||
```
|
||
|
||
---
|
||
|
||
## 認知負荷軽減ルール（全バリエーション共通）
|
||
|
||
```
|
||
**認知負荷軽減ルール:**
|
||
- APPROVE + 問題なし → サマリーのみ（5行以内）
|
||
- APPROVE + 軽微な提案 → サマリー + 改善提案（15行以内）
|
||
- REJECT → 問題点を表形式で（30行以内）
|
||
```
|