ドキュメントレビュー(2回目)

お申込みは↓のボタンから

現在募集期間外です

科目名 ドキュメントレビュー(2回目)
開講日 [Zoom講義] 2025年12月2日(火曜日)
開講時間 [Zoom講義] 9時30分から17時00分 (9時00分開場,集合時刻9時15分)
受講申込期間 2025年10月1日(水曜日)~2025年11月17日(月曜日)
受講料 30,000円(税込)
enPiT-Pro Embの「名古屋大学車載組込みシステムコース」のコース受講料に含まれますので,同コースの履修者には請求しません.
定員(先着順) 40名
会場・留意事項 ・テキストは,受講者に事前に送付します.
・勤務先や自宅などから,Webで受講してください.
・Webでの講義配信に,Zoomを使用します.
・必要な機材は,PC,ヘッドセット,通信環境です.カメラは任意です.
詳しくは,こちらでご確認ください.
・https://zoom.us/test でZoomの基本動作を確認できます.
・オンライン講義実践ガイドは,http://enpit-pro-emb.jpをご参照ください.
・質疑応答やグループワーク(発表含め)等は,Zoomで実施します.
・修了テストは,Webテストや,問題のWeb配信とE-mailでの提出などで実施します.
・ネットワークトラブルにより受講ができなかった受講者には,後日に録画データを配信します.
・インターネット回線(モバイルルーター含む)は,通信容量制限や速度制限のない契約プランでご使用ください.制限を超えると画像が映らない,音声が途切れる等のトラブル発生の可能性があります.
講師 塩谷敦子(イオタクラフト)
講師は都合により変更する場合があります
講座概要 ソフトウェア開発では,要求仕様書やアーキテクチャ設計書などのさまざまな種類の開発ドキュメントが作成されます.本講座では,それらの開発ドキュメントに対するレビュー技術を学びます.

本講座で学ぶ開発ドキュメントのレビュー技術は,単なるドキュメントの校正にとどまらず,技術者の育成までを視野に入れています.私たちは,このレビュー技術を「文書診断」と名付けています.

文書診断では,以下の6つの診断視点を例に,自身の診断視点を検討します.
・文法や規則に準じているか
・読みやすいか
・理解しやすいか
・論理的に記述されているか
・記述内容を利用維持できるか
・開発ドキュメントとしての目的達成に必要十分であるか

これらの診断視点を用いることで,開発ドキュメントの理想的な形や,適切な表現方法を再考するきっかけとなります.
(※)これらの6つの診断視点は,システム開発文書品質研究会(ASDoQ)発行の「システム開発文書品質モデル Ver.2」を参考にしています.

さらに文書診断を通じて,ドキュメントの品質向上が図れるだけでなく,診断を受けたドキュメントを作成した技術者が,どの領域で記述力が不足しているかを明確にできます.これにより,各技術者に適した効果的な育成が可能となります.また,文書診断を行う技術者自身も,客観的にドキュメントを読み解き,改善するスキルを身につけることで,自身の文書力を向上させることができます.

本講座は,すべてのソフトウェア技術者にとって役立つ実践的な内容です.
実習機材 特になし
到達目標 ドキュメントレビューに関して理解を深め,開発現場において実践できるようになる
対象者 ソフトウェア開発業務に従事されている方
前提条件 特になし
講義計画 1. レビュー総論
・レビューの位置づけと種類
・レビューの有効性

2. ドキュメントレビュー要説
・ソフトウェア開発とドキュメンテーション
・ドキュメントレビューとは
・ソフトウェア文書診断
・診断視点の検討
・文書診断によるドキュメントレビュー

3. 文書診断の実践
・診断項目の確認
・指摘事例
・診断演習
・ドキュメントレビュー実習

4. 図表のドキュメントレビュー
・図,表,文章
・図表のレビュー
・表の例
・図の例:UMLダイアグラム
・図表が表現できること・できないこと
評価方法 enPiT-Pro Embの「名古屋大学車載組込みシステムコース」履修者がこの科目を受講した場合の修了認定基準は,次のとおりです.
・理解度テスト60点以上
・全時間数を出席していること
これまでに受講された方々の声 実践的な内容を含んでおり,仕事でもすぐ活かせる内容でした.文書を見直すための技術,技能的な観点を教えて頂けたのが有意義であったと思います.
レビューのやり方がとても参考になった.具体的には,レビューの時間のかけ方や,レビューの観点(誰が,いつ,何のために,どのように)等,持ち帰って実践を行おうと思います.個人的には,別の方の意見も聞けてとても参考になりました.
ドキュメントは作成していたけど,レビューをしてもらった記憶があまりなかったので,なんとなく分かってはいましたけど,やはりこれが不具合発生が止まらなかった理由なのかと納得しました.ドキュメンテーションの重要さが身にしみました.
ドキュメントのチェックポイントがよく理解できました. 実習で体験することで理解を深めることが出来たと同時に,日本語の持つ「あやふやさ」を再認識しました.

*enPiT-Pro Embの講義について語っていただいた,受講者の声(インタビュー形式)はこちらから.
備考 複数回開講する科目の場合,改良を目的として教材をマイナ改訂する場合があるので,完全に同一の内容とならない可能性もございます.しかし,到達目標や扱う内容に変わりはありません.
お申込みや開講に関わる諸条件は,公開講座開講規約のページをご覧ください.
enPiT-Pro Emb向けの文部科学省BP要件該当授業時間数(実務家教員)情報:この科目は6時間です.