boy in green shirt
Photo by CDC on Pexels.com

【授業レポート】システム開発(2年) 第40週目

〜ドキュメント仕上げ&引き継ぎ設計:開発を「終わらせる力」〜

第40週目は、前回のミニ発表会で完成度を確認したシステムを対象に、
ドキュメントの最終整備と引き継ぎ設計を行いました。
テーマは「次の人が困らずに使える・直せる・改善できる状態にする」ことです。


■ 先生の導入:「良い開発は、良い引き継ぎで完成する」

田中先生:「コードが動くだけでは仕事は終わりません。
“誰かに渡せる形”にして初めて、プロジェクトは完成です。」

先生は実務の例として、

  • ドキュメント不足で改修できなくなったシステム
  • READMEが整っていて短時間で引き継げた案件
    を比較し、引き継ぎの質が開発効率を左右することを説明しました。

■ 今日のゴール

  1. README を「第三者が初見で使える」レベルに仕上げる
  2. 設計書・フロー図・ER図を最新版に統一する
  3. 運用・トラブル対応のメモ(運用ノート)を作る
  4. 引き継ぎチェックリストを完成させる

■ 実習①:README最終仕上げ

各班は README を開き、以下の観点でブラッシュアップしました。

README に含めた必須項目

  • プロジェクト概要(何を解決するシステムか)
  • 動作環境・前提条件
  • セットアップ手順(DB作成 → マイグレーション → 起動)
  • 基本的な使い方(ユースケース別)
  • よくあるエラーと対処法
  • ログの場所と見方
  • フォルダ構成の説明

生徒A:「“初めて触る自分”を想像して書くと、説明が増えた」


■ 実習②:設計ドキュメントの整理と最新版化

これまで作ってきた以下の資料を最新版に統合しました。

  • 要求定義(ユーザーストーリー・受け入れ条件)
  • クラス図・シーケンス図
  • ER図・テーブル定義
  • DAO/Service の役割分担メモ

チェックポイント

  • 実装と図が食い違っていないか
  • 使われていないクラスやテーブルが残っていないか
  • 命名がコードと一致しているか

生徒B:「図を直すことで“不要な機能”に気づいた」


■ 実習③:運用ノート(トラブル対応メモ)作成

「動かした後」に必要になる情報をまとめた 運用ノート を作成。

記載内容の例

  • よく起きたトラブルと原因
  • エラー発生時の確認手順(ログ → DB → 設定)
  • 安全な再起動手順
  • データバックアップの方法
  • 触ってはいけない設定項目

生徒C:「“これは触らないで”が書いてあると安心」


■ 実習④:引き継ぎチェックリストを作る

最後に、引き継ぎ時に必ず確認すべき項目をチェックリスト化しました。

引き継ぎチェックリスト(例)

  • [ ] README を読めば起動できる
  • [ ] DB構造がER図と一致している
  • [ ] 主要ユースケースが再現できる
  • [ ] エラー時のログ確認手順が分かる
  • [ ] 改修時に触るファイルが明示されている

このチェックを全て通ることが「完成」の条件です。


■ ペア引き継ぎ演習(仕上げ)

班内で役割を交代し、
「作った人が説明しない」引き継ぎ演習を実施。

  • README とドキュメントだけを見て起動
  • 分からない点をメモ
  • その場でドキュメントを改善

生徒D:「説明しない縛り、めちゃくちゃ勉強になる…」


■ 先生の総まとめ

「今日やったことは、
“自分の成果を未来につなげる技術”です。

設計・実装・テスト・改善・引き継ぎ
――この一連を経験した皆さんは、
もう“作るだけの人”ではありません。」


■ 振り返りコメント(抜粋)

  • 「READMEの重要性を初めて実感した」
  • 「人に渡す前提で作ると、設計の甘さが見える」
  • 「チーム開発は“終わらせ方”までが仕事だと思った」

■ 次週の予告:学期総括&成果振り返り

次週はこの学期全体を振り返り、
ポートフォリオ整理・自己評価・次学年(3年)への接続を行います。
生成AIや外部サービス連携へ進む前の、大切な区切りの回です。


第40週目は、コードではなく「伝える力」で完成度を高める授業でした。
生徒たちは、システムを“作って終わり”にせず、
“次に渡せる形”にする本当の意味をしっかり学びました。

投稿者 greeden

コメントを残す

メールアドレスが公開されることはありません。 が付いている欄は必須項目です

日本語が含まれない投稿は無視されますのでご注意ください。(スパム対策)