|
1.ソフトウェア開発におけるドキュメント(要件定義書・設計書)の役割
(1).文書化の不備によるトラブルと品質問題の発生
a.開発プロセスにおける不具合の実態と原因
b.なぜ要件定義書・設計書の記述不備が品質問題を引き起こすのか
c.不明確な記述が原因となるトラブル、手戻り、品質低下
【演習】自身の経験から文書不備による問題事例を共有
(2).開発プロセスにおける文書の重要性と品質への影響
a.ソフトウェア開発プロセスにおける成果物としての文書の意義
b.プロセス品質とソフトウェア品質の関係
(3).開発プロセスにおける文書の6つの役割
a.工程間インタフェースの明確化:前工程からの引継ぎ、次工程への伝達
b.工程作業の管理:何をどこまで完了したかの可視化
c.品質の作り込みと検証:レビューによる品質確保
d.品質保証:成果物として品質を証明する
e.開発プロセスの定義:文書体系がプロセスを定義する
f.ナレッジの蓄積:保守・改修時の情報源
2.ドキュメンテーションに基づく開発プロセスの進め方
(1).ソフトウェア開発におけるドキュメンテーションの位置付け
a.「書くこと」が「考えること」-文書化は思考の整理
b.「書けない」ことは「決まっていない」証拠
c.文書で考え、文書で進める開発プロセス
(2).開発プロセスの工程と文書体系の関係
a.要件定義、基本設計、詳細設計の文書構成と記載内容
b.文書構成(目次)が作業の項目と内容を決める
【演習】開発プロセスの各段階で決めるべきことを整理する
(3).ソフトウェア品質向上のための文書化のポイント
a.要件定義書・設計書作成の心得:書く前に考える、構造化してから書く
b.図表記載の心がけ:図で全体像、表で詳細、文章で補足
c.読み手を意識した文書の構成と内容:知りたいことは何か
【演習】読み手を意識して書くべき内容を決める
(4).開発文書作成における生成AIの活用と影響
a.文書作成における生成AIの活用可能性と限界
b.AIが作成した文書と人間が行うべき「決定」の本質
3.テクニカルライティングの基礎:論理的に説明し、わかりやすく書く技術
(1).文書のわかりやすさと論理展開
a.主張や説明の根拠を明確にする
b.技術的判断のプロセスを可視化する
【演習】理由を明示して結論を述べる
(2).文書に書く内容を整理する
a.MECEで情報を「漏れなく、ダブりなく」整理する
b.So What?(だから何?)/ Why So?(なぜ?)で論理を組み立てる
c.メッセージ → 理由 → 根拠の階層構造
【演習】システム構成要素をMECEで整理する
(3).構造化した情報を文書構成に変換する
a.頭括型構成:結論を先に示して説得力を高める
b. 1段落=1トピックの原則で読みやすさを実現する
【演習】技術説明を頭括構成で書いてみる
(4). テクニカルライティングに必要な3つの原則
a.明確性(Clarity):曖昧さを排除し、誰が読んでも同じ理解
b.簡潔性(Conciseness):冗長表現を避け、必要十分な記述
c.一貫性(Consistency):用語・形式・粒度の統一
(5).曖昧表現を排除し、正確に書く技術
a.主語を明示する:「処理を行う」→「サーバーが処理を実行する」
b.能動態と受動態の使い分け:動作主体を明確にする
c.一文を短くシンプルに:目安は60文字以内、一文一義
【演習】読みにくい文を簡潔で明瞭な記述に改善する
(6).技術文書特有の技法
a.図表を効果的に使い、文章と連携させる
b.階層的番号付け(1.2.3方式)で情報の位置を明確化
c.箇条書きの効果的な活用:並列関係と階層関係の表現
d.相互参照の技術:「詳細は○○を参照」の適切な使い
4.実務で活用できる文書作成の要点
(1).ソフトウェア開発文書の種別ごとの実践的な作成方法
a.前提条件とスコープの明示:何を書き、何を書かないか
b.ソフトウェア要件定義書の構成と記載内容
c. 基本設計書の構成と記載内容:目次例と記述例
d.詳細設計書・インタフェース仕様書の作成ポイント
(2).文書品質向上のために:セルフチェックとレビューへの応用
a.システム開発文書に求める品質特性
b.レビュー観点と効果的なレビューの進め方
c.レビュー結果のフィードバックと改善サイクル
d.変更管理の手順と方法のポイント
5.ドキュメンテーション実践演習:問題のある設計書の改善
(1).設計書サンプルの分析(グループワーク)
a.どこが問題か?なぜ読みにくいのか?を議論する
b.構成、論理、表現の観点で問題点を洗い出す
(2).文書の改善実践:「文書のリファクタリング」
a.章立てを見直し、適切な構成に組み直す
b.曖昧な表現を具体化し、箇条書きや図表を活用する
(3).成果発表と全体共有、フィードバック
a.各グループから改善後の文書を発表、全体で共有
b.他のグループからの質問、フィードバック
c.講師からの講評と解答例の紹介
6.まとめと振り返り・講師からの全体フィードバック
(1).重要ポイントの総復習:文書化を定着させて品質向上するために
(2).講座の振り返り:学びと気づきの確認
(3).質疑応答
|