読者です 読者をやめる 読者になる 読者になる

ブログ名はまだ無い(仮)

インフラエンジニアのツイッターには書ききれないつぶやきです



我々はいつまでドキュメント作成に苦しめばいいんだろう

勉強会

先日と言ってももう1ヶ月以上経ってしまいましたがOSC(オープンソースカンファレンス)
にて「我々はいつまでドキュメント作成に苦しめばいいんだろう 」というタイトルでLT
をさせていただきました。
f:id:smile_0126:20160518132351p:plain

OSCのLTやセミナーは基本的には技術的なセミナーがもちろん多いのですが、仕事をする
上で避けては通れないドキュメント作成についても話す機会があってもいいのではないか
なーと思って話をさせていただきました。

OSCの資料と動画は以下になります。

資料

www.slideshare.net

動画

www.youtube.com

ドキュメントに苦しむITの現場

今回のLTをするきっかけとなっているのは、今までいた会社では必ずといっていいほど
ドキュメントで苦しんでいたということです。

現在の会社でIT関連の会社5社目になりますが、必ずドキュメントは苦しんでいました。
OSCの資料でも書きましたが「ドキュメントが残ってない」「ドキュメント作成に工数
かけすぎ」「単純にドキュメント作成が嫌い」など、理由はさまざまでした。

ドキュメントは武器になる

とはいっても、必ずドキュメントを作成する機会はやってきます。

ドキュメント作成は決して仕事の進捗を邪魔するようなものではないですし、むしろド
キュメントを正しく残すことによって仕事を進めていく上で強力な武器になると思って
います。

ITエンジニアが作りそうなドキュメントとして、議事録、構成図、仕様書、パラメータ
シート、さまざまものがあると思います。

構成図、仕様書などはプロジェクト開始前などに適切にお客様に提示てきれば、できあ
がってくるものとの齟齬を軽減することができます。
また、お客様にわかりやすく伝えることができれば安心を買うこともできます。

パラメータシートは適切にサーバの状況を把握し、障害発生時に適切に対応することが
できます、さらにサーバリプレースの際にも有力な情報となります。

こだわりは捨てた方が良い

よく新人の人に対して「議事録取っておいて!」といって新人の方に議事録を書かせる
ことは良くある光景だと思います。

実際にできあがった議事録に対して先輩社員が「これが違う」「あれが違う」あげくの
果てには「日本語がおかしい」とか言って新人さんを注意したりします。

「内容が間違っている」「記載内容が足りない」となで注意するのは理解できるのです
がそれ以外でガタガタいうのはどうなのかな?と毎回思っていました。

社内の議事録なんだから伝わればいいと思いますし、またそんな注意しまくることによ
ってドキュメント嫌いのエンジニアを量産してしまうと思うんですよね。

このような「ドキュメントイジメ」につながるこだわりは捨てたほうが良い!というの
が勝手な自論です。
今まで色々な「ドキュメント作成が上手い」とされている人を見てきましたが、「です
ます調で揃える」といった基本的なところ以外は皆言ってることが違ってました。

個人的には正解なんてものは無くて、最終的には個人のこだわりになってるのではない
かなと思います。
だったらこだわりを捨てて、社内の人に資料を作って残してもらったほうが有益なはず
です。

今後の展開

OSCのLTでは問題提起して何も解決していないので、今後は解決に向けて何かしていき
たいと思っています。

今取り組んでいるのは「ドキュメントを作成しやすい仕組み作り」「成功体験をしても
らう」といったことでドキュメント嫌いを克服できないかなということをしております。

また、どこかの機会でお話できればと思っています。

最後に、昔会社の先輩がこんなことを言っていたのを思い出しました。

「エンジニアの仕事なんてのは7割が物書きだよ」
「1日中ガチャガチャサーバいじってるうちはまだ半人前だ」

今思えばすごい的を得ているような気もします。