設計書の筋書き作れますか

2000年前後の頃、

「手順書を作ってください。」

と当時参画していたプロジェクトのリーダから依頼されたときに一つオーダがあったのは、

「目次が出来たら内容を書く前に見せてね。」

ですと。「(なんで？)」と当時のワタシは思ったかそれとも意図を理解せず安請負しただろうか。うーん、当時なら絶対100%の確信を持って後者だなー。目次を最初に見たいっていう意味わかっていない。

確か、3回くらいダメだし貰ったような気がする。2回目のダメ出しでは「(何がわるいんだよー！！)」ってわけわからんコトになっていたんじゃないか。依頼された人からはニコニコと少しだけヒントは与えてもらったけど、内心は「(使えねー)」って思っていたんじゃないか、と。

今思い返せば、一から自分で目次を起こしたのがいけなかった、というか、他の人の手順書の目次を見て真似ればそんなに何度もダメ出しを貰わなくてよかったんだけど。何せ、そんなこと思いもよらなかったんでねー。

結局は、

「他の人の作った目次を参考にして。」

となって、他の人の手順書の目次を手本にアレンジして持っていったら、さらにいろいろと項目を追加されて、やっとこさっとこ、

「書いていいよ。」

となったです。じゃあ、どんな目次だったかを思い出しながら並べてみると、

• 表紙
• 文書体系・関連文書
• 改訂履歴
• 本書の位置づけ
• 対象読者
• 本書の目的

と、始まります。上記の目次の中で最後になって追加されたのは「文書体系・関連文書」だったかな。例えば、みんなが大好きな「詳細設計書」なら、

文書体系・関連文書

項番	文書名	備考
1	要件定義書	システム要件を記載した文書。
2	基本設計書	システム方式を記載した文書。基盤編、業務機能編、移行編で構成する。
3	詳細設計書	実現仕様を記載した文書。基盤編、業務機能編、移行編で構成する。

となるし、関連文書は、詳細設計書がどんな文書でこうせいされているかとか、補助文書なども一覧として記載するように指摘があった。

項番	文書名	備考
1	詳細設計書　基盤編　機能	基盤のサブシステムの機能を記述する。
2	詳細設計書　基盤編　パラメータ仕様	パラメータ仕様を記述する。
3	詳細設計書　基盤編　運用機能	システム運用で使用する機能を記述する。
4	詳細設計書　基盤編　別紙	NW図など別紙を収容したもの。

まぁ、文書体系・関連文書なんてものは1つ作ればあとは差し込めばいいのだけれど、変更があったら都度全部差し替えないといけないんだから今時なら馬鹿らしい要求と思うけれど。そんなインデックスを作ったり、差し替えたりする暇があったらwikiでも立てて、リンク集を作った方が良いけれど、納める文書なら別紙にしておいて文書からリファーさせる構成にするのが正解かと。

で、大分脱線したので肝心の筋書きの方に話を戻すけれど、先の手順書の目次構成をその文書の目的に沿ってアウトラインを作れるかどうか、ということです。

ずっと一担当だと何処からか持ってきた文書の目次を指定されるとか、リーダか誰かが考えた目次で書いてと言われるかで、なかなか自分で目次を考える機会ってないんですよ。ほんと。でもね、手順書を書くから良く見ているけど、

「なぜその目次構成になっているか。」

考えたのが自分じゃないからわからないし、悩んでいないから目の前に並んでいる順番の意味も解らない。それに、目次の過不足、必要な項目の充足性や必要なのに足らないということもわからない。仕方がないんですけどね、意識して目次を見ていないのだから。

じゃあ、意識すればいいのかって言えば、そう。はじめは意識しないとどうしようもない。始まらない。だから、プロジェクトで色々な文書を見ているわけだけど、目次構成を考えるときになって意識しなければならない状況に置かれるととってもツライ。だって、自分のストックが空っぽなんだもの。当時のワタシはそうだった、っていう話なんだけど。

「え？いいじゃん、そのときに、必要なときになってから参考になる手本の文書を集めれば。」

って思うかもしれないけれどね。その時じゃ遅い時がある。なぜなら、手に入る手本の文書が目次構成を考える限界になるから。ということかというと、もし、いままで基盤の機能だけを担当していて、今度目次を考えないといけない範囲が「基盤全体の目次を考えて。」となったらどうなる？

論理構成、物理構成、NW構成、機能、非機能、運用、障害時……と、とっても広がるんだよね。それまで書いていたのは一部分だった、なんてことになるかもしれない。もちろん、契約でプライムコンダクターなら尚更だよね。サブコンなら部分だけを担うんなら今までどおり、契約で受けた機能だけをやればいいんだけど。

現実問題、なかなか全部を網羅した目次を見るのは少ないです。それは、何をどの範囲まで書くかは、顧客との契約範囲に依存するから。

じゃあ、「網羅的になんて無理ジャン？」と思う？そう、いきなりは無理。だから、目の前を通り過ぎていく文書の目次を拾って、マージしていくことをしないことにはどうにもならない。そうやって少しずつ集めて、自分なりにその目次の項目の必要性を考えて、

「何を書くか。」

筋書きを考える訓練をしないといけない。そういうこと。