majiayu000 ドキュメントレビューガイド
概要
ドキュメントの記載内容が技術的に正確かどうかを確認するスキルです。
レビュー観点
1. 技術的正確性
| チェック項目 | 確認方法 |
|---|---|
| 用語の正確性 | 公式ドキュメント、RFC等で確認 |
| 年代・歴史 | Web検索で複数ソースを確認 |
| 技術的な仕組み | 公式ドキュメント、ソースコードで確認 |
| バージョン情報 | 最新の公式情報を確認 |
2. 事実確認が必要な項目
┌─────────────────────────────────────────────────────────────┐
│ 特に確認が必要な記述 │
├─────────────────────────────────────────────────────────────┤
│ │
│ ・年代（「1997年にServlet登場」等） │
│ ・数値（「100倍速い」等の比較） │
│ ・人物・組織（「Sunが開発」等） │
│ ・技術仕様（「HTTPは〜」等） │
│ ・歴史的経緯（「CGIの問題を解決するために」等） │
│ │
└─────────────────────────────────────────────────────────────┘
3. 一貫性
- 同じ概念に異なる用語を使っていないか
- 図と本文で矛盾していないか
- 他のドキュメントとの整合性
レビュー手順
Step 1: ドキュメントを読む
# 対象ファイルを読む
Read <file_path>
Step 2: 事実確認が必要な箇所を特定
以下のような記述をピックアップ:
- 具体的な年代
- 技術的な仕様・仕組み
- 歴史的な経緯
- 比較や数値
Step 3: Web検索で裏付け
WebSearch で以下を確認:
- 公式ドキュメント
- RFC/仕様書
- 複数の信頼できるソース
Step 4: レビュー結果を報告
## レビュー結果
### 確認した項目
| 記述 | 確認結果 | ソース |
|------|---------|--------|
| 「1997年にServlet登場」 | ✅ 正確 | Oracle公式、Wikipedia |
| 「CGIは1993年頃から」 | ✅ 正確 | NCSA文書 |
### 修正が必要な箇所
| 箇所 | 問題 | 修正案 |
|------|------|--------|
| 〇〇 | △△が不正確 | □□に修正 |
### 確認できなかった項目
- 〇〇（ソースが見つからず）
よく確認する情報源
公式ドキュメント
| 技術 | 公式ソース |
|---|---|
| Java/Servlet | Oracle、Jakarta EE |
| Spring Boot | spring.io |
| HTTP | RFC 7230-7235, MDN |
| OAuth/OIDC | RFC 6749, openid.net |
信頼できる二次ソース
- Wikipedia（ただし一次ソースも確認）
- MDN Web Docs
- Stack Overflow（高評価の回答）
レビュー対象の例
学習コンテンツ（content_11_learning）
documentation/docs/content_11_learning/
├── 22-frameworks/
│ ├── 06-java-servlet.md
│ ├── 07-spring-boot.md
│ ├── 08-servlet-container.md
│ └── 09-cgi-to-servlet.md
これらは技術的な説明が多いため、特に事実確認が重要。
使用例
/review-documentation documentation/docs/content_11_learning/22-frameworks/09-cgi-to-servlet.md
または
/review-documentation 09-cgi-to-servlet.md
出力フォーマット
# ドキュメントレビュー: [ファイル名]
## 概要
- 対象: [ファイルパス]
- レビュー日: [日付]
## 確認結果
### ✅ 正確な記述
| 記述 | 確認ソース |
|------|-----------|
| ... | ... |
### ⚠️ 要確認・修正推奨
| 記述 | 問題点 | 修正案 | ソース |
|------|--------|--------|--------|
| ... | ... | ... | ... |
### ❓ 確認できなかった項目
- ...
## 総評
[全体的な評価コメント]