プレゼンテーション用スライドの改善事例

» 2016/04/06

ドキュメント・コンサルタントの開米です。

なにかと複雑で人に説明するのが難しい情報をわかりやすく説明するためのご相談に乗ったり、代わりに書いてしまったりする仕事をしています。

今回は技術評論社刊 Software Design 誌で一緒に「RDB性能トラブルバスターズ奮闘記」を書いている生島さんのご相談でこんな資料をいただきました。以下、技術的な話なので細かい内容よりも全体の流れをみてください。

↑これがもともと生島さんの作られたもの。私からの指摘事項としては、

「○○がない！」は問題点を指摘していると思われるが、この指摘は「本来あるべきなのに作れていない」と思っている人にしか通じない。作っていない現場が多いということは、そもそも必要なことを自覚していないはずで、「本来こういうものが必要でしょ？」という話からしなければならない
したがって「インタフェース仕様書ってそもそもこういうものを書くものでしょ」という定義が必要
クライアントPCと２つのAPサーバの関係がつかみにくい
問題は「インタフェース仕様書がない」ことだけでなく、ＡＰ側とRDB側でプログラム言語パラダイムのギャップが大きすぎることにあるようなので、それを説明する
人間は別なものと比べると理解しやすいので、似た構造を持つ別な分野と比べられるように書くとよい

といった項目でした。

で、実際にそれを踏まえて書き直した構成が下記のようになります。（実際のところ、指摘されただけでリライトができる方は少ないので、私が代わりに再構成してしまうケースが多いです）

【スライド１】　インタフェース仕様書の役割を定義する