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

Yes, Write Now!!

»

■そのドキュメント、今じゃなきゃダメです!

 Ahfさんのコラムを読んで、反射的にそう頭に浮かんだ。答えは簡単だ。

 情報はホットな内につかめ!そして書け!

それに尽きる。トラブルが起きた時は、ドキュメントがあればほど迅速に対応できる。時間が勝負なIT業界で迅速であることは、間違いなく一つの価値なはずだ。

 ただし、ドキュメントがあるだけではダメだ。的確でなくてはならない。IT業界でドキュメントうんぬんがよく騒がれるか。これも理由は簡単だ。

 ドキュメントを書くスキルが決定的に低い!

 それ以上に言うことはない。

■早く書くための基盤

 まず、ドキュメントを早く書くためには準備が必要だ。準備するものは二つ。テンプレートと編集の技術だ。テンプレートの質が悪く、編集の技術を勉強しようとしない。そうであるなら、ドキュメントが早く書ける訳がない。

 そして的確にドキュメントを書くのに必要なもの、それは的確な情報だ。ここが崩れているのではないだろうか? もともとの情報が曖昧だったり、認識がずれていたら、書かれるドキュメントの内容は当然崩れる。

 ドキュメント関連のトラブルがあるなら、このような基盤の部分が脆いはずだ。

■改善に適切なアプローチがされていない

 Ahfさんのコラムを読んで二つ思った事がある。一つは、確実に改善策はあるということ。もう一つは、腐りきって改善できない現場もあるということだ。腐りきって改善できない現場の話は避ける。勝手に自然淘汰されるだろう。淘汰された後に再起するための改善策について、検討したい。

 そもそも、ドキュメントを書くにしてもリファクタリングの技術がある。まぁ、ドキュメントにリファクタリングという言葉を使うのが的確かは分からないが、ソフトウェアのそれと似たようなアプローチができる。

 コードを書いている人なら当然、いろいろな工夫をしていると思う。分かりやすい記述を考えたり、構造を工夫したり、使うツールを工夫したりと。ドキュメントにも同じような工夫がされているだろうか。まず、そこを問いたい。

■決定的な解決策。それはモチベーションだ!

 話はそれるが、私がコラムをネタ切れ知らずにハイペースで書ける理由。それは、ドキュメントのリファクタリングの技術を追求しているからだ。面白いと思ったコラムに、カウンターでコラムを書けるのも、その技術を応用しているからだ。コラムを出すタイミングも重要だ。

 多分、コードを書くことに面白さを感じる人は多いと思う。奥の深さがあり、いろいろな工夫ができる。パズルを解いていくような楽しさがある。そういうモチベーションがあるから、技術を高められるのではないだろうか?

 ドキュメントも同じような面白さがある。それに気づけば、強烈なモチベーションを維持できる。そして、現場を改善できる。このドキュメントの面白さが理解されない理由。それも実は答えが出ている。その本質は、onoTさんのかかれたコラム、敬意が足りないと面白味のないモノしか作れないに書かれている通りだと思う。

 つまり、ドキュメントへの敬意が足りないということだ。

 現場のドキュメントに敬意がこもっているだろうか?そこは問う価値はあると思う。

P.S.

 そしてドキュメントを書くテクニックの一つ。何も自分で全部やる必要は無い。前人の残した成果をうまく使わせて頂くことだ。

 そんなことで、先に書かれた2本のコラムに知恵を拝借して書かさせて頂きました。 Ahfさん、onoTさん、ありがとうございました。

Comment(0)

コメント

コメントを投稿する