ドキュメントレビュー & スライド反映
docs/01-introduction.md から docs/06-codensity.md までの文章クオリティを包括的にレビューし、必要に応じて修正とスライド反映を行う。
引数 $ARGUMENTS が指定された場合、その観点に重点を置いてレビューする。
レビュー観点
以下のすべてを検査する。引数で絞り込みがある場合はその観点を優先しつつ、他の重大な問題も報告する。
1. ロジックと文章量のバランス
- •重要な概念に十分な説明があるか(薄い箇所)
- •不要に長い説明がないか(厚すぎる箇所)
- •コード例と散文のバランス
2. 展開・構成
- •各章内の節の順序は論理的か
- •クライマックスの位置は適切か
- •章間の遷移は自然か
- •水平線や見出しによる不自然な断裂がないか
3. AI っぽさ
重要: AI っぽさは固定の概念ではない。 過去に指摘されたパターン(特定の接続詞、テンプレート的な章冒頭など)をチェックリストとして機械的に適用してはならない。AI の文体は急速に変化し、昨日の「AI っぽい」は明日には陳腐化する。
レビュー時には以下のプロセスを踏む:
- •まず Web 検索で「AI generated text characteristics {current year}」「AI文章 見分け方 最新」等を調べ、現時点で認識されている AI 文体の特徴を把握する
- •その知見をもとに文章を読み、人間の書き手なら選ばないであろう表現パターンを探す
- •発見したパターンは「なぜそれが不自然か」の理由とともに報告する(パターン名だけでなく)
観点の例(あくまで出発点であり、これに限定しない):
- •文章全体のリズムや語彙選択の均質性
- •構造の機械的な反復(章ごとに同じ骨格を持つなど)
- •過剰に整理された印象(人間の文章には適度な「揺らぎ」がある)
- •読者への語りかけ方の不自然さ
4. 冗長性
- •同一論点の不要な反復(章をまたいだ繰り返し)
- •まとめ表と直後の散文が同内容になっていないか
- •同じフレーズの多用
5. 語彙・用語
専門用語の選択と運用は文書の信頼性に直結する。以下の3層で検査する。
a. 定義と初出
- •専門用語の初出時に定義または原語が示されているか(例: 「具象化(reify)」)
- •読者が知らない可能性のある用語に、必要十分な導入があるか
- •既存の確立された用語があるのに造語・意訳を使っていないか
b. 一貫性(表記揺れ)
- •同一概念に複数の表記が混在していないか(例: 構成子/構築子/コンストラクタ)
- •一つの用語が文脈によって異なる意味で使われていないか
- •検査手順: 主要な術語を Grep で全章横断検索し、表記の揺れを機械的に洗い出す
c. 適切性
- •借用元の分野で確立された意味と齟齬がないか(例: 「リフレーミング」は心理学用語)
- •不必要に難解な語を使っていないか(例: 読者層に対して「離散的」より「個々の」が適切)
- •逆に、専門分野で確立された用語を不用意に平易化していないか
6. 正確性・細部
- •技術的な正確性
- •コード例と説明の整合性
- •不要な括弧内補足
- •blockquote の用途が適切か(補足情報 vs 本文で扱うべき内容)
レビュー手順
- •
docs/01-introduction.mdからdocs/06-codensity.mdまで全文を読む - •語彙検査: 文書中の主要な術語を抽出し、Grep で全章横断検索して表記揺れ・定義漏れを洗い出す
- •上記すべての観点で問題を洗い出す
- •問題を 章ごとにグループ化 し、具体的な行番号・引用とともに報告する
- •優先度を付ける(最優先 / 推奨 / 軽微)
修正フェーズ(ユーザーの承認後)
ユーザーが修正を依頼した場合:
- •ドキュメントを修正する
- •
slides/slides.mdに反映が必要な変更を特定し、スライドも修正する - •
npx @marp-team/marp-cli slides/slides.md --images png --image-scale 1 -o /tmp/marp-check/でレンダリングし、内容量が多いスライドを画像で確認する - •ハミ出しがある場合はスライド分割または
denseクラスの適用で対処する - •
npx @marp-team/marp-cli slides/slides.md -o slides/slides.html --htmlで最終 HTML をビルドする
出力形式
レビュー結果は以下の形式で報告する:
code
## 総評 [全体の印象、強みと弱み] ## 1. [問題カテゴリ] ### [最優先 / 推奨 / 軽微] **[章]:[行番号付近] [問題の要約]** > [該当箇所の引用] [問題の説明と改善案]