いろいろな仕事を渡り歩き、今はインフラ系エンジニアをやっている。いろんな業種からの視点も交えてコラムを綴らせていただきます。

お求めのドキュメントは書けません! Part1 --読むだけで東大に受かるドキュメントなんて書けません--

»

◾︎ドキュメントにそれを求めるな

 「読めばどんな人でも仕事できるようなドキュメントを書いてくれ」こういう依頼を受けたことはないだろうか。よくよく考えてみると、この依頼はかなり的外れではないだろうか。

 例えば、「これさえ読めば東大に受かる」そういうドキュメントは実在するだろうか?そんなものは存在しない。「読めばどんな人でも仕事できるようなドキュメント」というのはこれと同じだ。

 もしそんなドキュメントを書ける能力があるなら、シケた会社のエンジニア部門でドキュメントなんて書いていない。独立してもっとすごい書物を出版して、人生悠々と暮らしていることだろう。

◾︎業務においてのドキュメンントの立ち位置

 まず、東大に行きたいと思ったら参考書を買うだろう。業務においてドキュメントは、この参考書にあたる存在だと思う。東大くらいの難関校であれば、単に学校の成績が良いだけでは受かれない。なので、具体的な対策として参考書が必要になる。

 参考書といっても、いろいろな種類がある。例えば、赤本と言われる過去のの問題集。具体的な手法が書かれた解説書。問題を解く力を付けるための問題集。何をやれば受かるという基準は無い。それぞれの考えを元に、自分に必要だと思うものを揃えていく。

 これに対して、「読めばどんな人でも仕事できるようなドキュメント」を求めるというのは、余りに漠然としていないだろうか。そもそも、何のドキュメントが必要かさえ切り分けられていない。もし受験だったら、確実に落ちるパターンだ。

◾︎やり方が分かってからが本番だ

 受験でもそうだが、対策を立ててからが勝負だ。参考書を揃えるのはその前段階でしかない。「読めばどんな人でも仕事できるようなドキュメント」の裏には、「めんどくさいからドキュメントだけで仕事を済まそう」という考えの甘さが透けて見える。

 仕事で使うドキュメントは、どんなに頑張ってもやり方しか書けない。迷った時の最終判断を下すのはあくまで自分だ。どんなに判断基準を細かく書いても、例外事項が起きれば自己判断に頼るしかない。また、理解に一定の難易度が要求されるなら、読み手の知能と経験が問われる。

 なぜドキュメントを受験で使う参考書に例えたか。それは、ドキュメントは答えではなく考えるための材料だからだ。だから完璧でなくても良い。逆に、欲張って何もかも詰め込もうとするほど、ほんのりと腐敗臭の漂うクソドキュメンントが出来上がる。

◾︎ドキュメントの必要性

 「参考にしかならないなら、ドキュメントを書いても意味がないじゃないか!」と立腹されるPMさんもいいるかもしれない。だが、それは余りに軽率だ。試験に出る問題が載ってないから参考書はいらない!なんて主張する受験生がいるだろうか。いたら確実に試験に落ちる。

 作成するドキュメントは手順書だけじゃない。他にも書ける内容はいろいろある。何を書けばいいのか?それを考えるのも重要な訓練にもなる。書けもしない万能ドキュメントをいきなり書こうとするから、内容が破綻して書けなくなるのだ。もっと基礎的なところから見直す必要を感じる。

 本当にドキュメントを書こうと思えば、一般で考えられている時間より多くの時間が必要になる。工数を節約したいから勝手に切り詰められているだけだ。だからまともなドキュメントなかなか作成されないのだ。

 では、どのようにドキュメントを書き進めていけばいいのか。詳しい内容については、Part2で詳しく掘り下げていきたいと思う。

Comment(0)

コメント

コメントを投稿する