
(写真:PIXTA)
システム開発を成功させるうえで、ドキュメントの重要性は増す一方。要求水準が上昇しているが、現場の作成力は追いついていない。必要なのは「アレンジ力」「表現力」「レビュー力」という3つの力だ。第一線のエンジニアに取材し、実用性の高い実践ノウハウを探った。
閉じる
システム開発を成功させるうえで、ドキュメントの重要性は増す一方。要求水準が上昇しているが、現場の作成力は追いついていない。必要なのは「アレンジ力」「表現力」「レビュー力」という3つの力だ。第一線のエンジニアに取材し、実用性の高い実践ノウハウを探った。
あなたが参加するプロジェクトでは、ドキュメントのレビューが形骸化していないだろうか。
ドキュメントの分かりやすさを高めるうえで、図表が大きな効果を発揮するのは、誰もが実感していることだろう。しかしDFD(Data Flow Diagram)やクラス図といった設計用の図、さらに業務フローを表した図を除けば、文章による説明で終始しているケースが少なくない。
文章や図表をうまく書くには生まれ持ったセンスが必要──。そんなふうに考えたことはないだろうか。
ドキュメントの目的は、その都度考える必要がある。それによって、そのケースにおけるドキュメントの要件が明確になり、標準フォーマットのままで事足りるか、どうアレンジすべきかが見えてくるからだ。
専門用語や抽象的な言葉が頻出する難解な要件定義書、長々とした文章による説明が続く基本設計書──。こうしたドキュメントの読み手はたまったものではないだろう。納得どころか理解もできず、勝手に推測して内容を補わざるを得ない。こうして生まれた誤解や勘違いは、やがてプロジェクトを危機に陥れる。