コードレビューの実務とコメント設計
心理的安全性を高めつつ、コード品質を維持するレビューテクニックです。
レビューコメントのプレフィックス活用
MUST:修正必須（バグ、セキュリティ脆弱性、仕様違反）。IMO:In My Opinion（個人的提案。修正するかは担当者の判断に委ねる）。Nits:Nitpick（些細な指摘。タイポやスタイルの微修正）。Ask:質問・確認（意図のヒアリング）。
💬 コメント例
- BAD: 「この変数名わかりにくいです。変えてください。」
- GOOD: 「
IMO:dだと内容が推測しにくいため、created_at_dateなどに命名変更すると可読性が高まるかと思いますがいかがでしょうか？」
MkDocs によるドキュメント自動生成
コード内の docstring や Markdown ファイルから、美しく検索性の高いWebドキュメントを生成します。
Bash
# MkDocs (Material theme) のセットアップ
pip install mkdocs-material
mkdocs new my-docs
mkdocs serve
プロジェクトの見積もりとWBS（作業分解構成案）
- タスクの細分化: 1つのタスクは最大でも「半日〜1日（2〜8時間）」で終わる単位に分解。
- 見積もり手法（プランニングポーカー）: チーム全員でフィボナッチ数列（1, 2, 3, 5, 8, 13）のポイントを割り振り、認識のズレ（仕様理解の差）を事前に抽出する。
コメント