読み手が納得する開発ドキュメントの作り方

目次

• 

  「レビュー」の形骸化が開発ドキュメントの品質を下げる、3つの対策はこれだ

  　あなたが参加するプロジェクトでは、ドキュメントのレビューが形骸化していないだろうか。（2020/4/3）

• 

  開発ドキュメントの「説得力」を磨く5つの鉄則、図や表の上手な使い方

  　ドキュメントの分かりやすさを高めるうえで、図表が大きな効果を発揮するのは、誰もが実感していることだろう。しかしDFD（Data Flow Diagram）やクラス図といった設計用の図、さらに業務フローを表した図を除けば、文章による説明で終始しているケースが少なくない。（2020/4/2）

• 

  生まれ持ったセンスなんて不要、わかりやすい書類を作る5つの鉄則

  　文章や図表をうまく書くには生まれ持ったセンスが必要──。そんなふうに考えたことはないだろうか。（2020/4/1）

• 

  超わかりやすい要件定義書を作る秘訣は、「あれ」を想像しながら書くことに

  　ドキュメントの目的は、その都度考える必要がある。それによって、そのケースにおけるドキュメントの要件が明確になり、標準フォーマットのままで事足りるか、どうアレンジすべきかが見えてくるからだ。（2020/3/31）

• 

  読み手が思わずうなる、上手な開発ドキュメントを作る3つの秘策

  　専門用語や抽象的な言葉が頻出する難解な要件定義書、長々とした文章による説明が続く基本設計書──。こうしたドキュメントの読み手はたまったものではないだろう。納得どころか理解もできず、勝手に推測して内容を補わざるを得ない。こうして生まれた誤解や勘違いは、やがてプロジェクトを危機に陥れる。（2020/3/30）