言語の歴史は人類の歴史。そして人類はコンピュータを言語で動かすようになった。

自分の仕事に専念したいからドキュメントは他の人に書かせたらどうだろう

»

どこのプロジェクトに行っても、時間を無尽蔵に消費するのがドキュメントの作成です。個人的には、分かるならテキストデータでもいいのでは?と思うのですが、お客さんは見た目を整えたがるものです。また、やたらと用語や言い回しにこだわりを持ったりします。エンジニアはそれに翻弄されて、多くの労力を失ってしまいます。

エンジニアは文章を書くプロではありません。こういう要求に応えるのは不向きと考えています。文章を書くプロの方でも一人で全部できる人はまれです。レイアウトを整えるプロの人がいたり、文法や誤字脱字をチェックする校正のプロがいたり、たくさんの人の手を借りて一冊の本に仕上がります。私たちの目に触れる文章というのは多くの人の手間に支えられています。

しかし実際のところ、ドキュメントを書いたはいいが労力に見合っているとは限りません。それを指摘して、ドキュメントを書くことを嫌うエンジニアも多いです。私の経験でも、○○設計書や仕様書より、実際に訳に立ったのはデータシートです。データシートに正確な情報と意図が書かれていれば、エンジニアとしての仕事は十分にこなせます。逆に、形骸化したドキュメントであれば時間の無駄でしかないです。

もしお客さんが質の高いドキュメントを求めても、無理にエンジニアが応じても利益は少ないように思います。ドキュメントを書く専門の人にお金を払って、質の高いドキュメントを書いてもらうべきではないでしょうか。エンジニアも苦手な作文ですり減らずに本業に集中できるし、お客さんは綺麗なドキュメントが手元にそろい、お互いハッピーになれます。

エンジニアは文章を書く専門家ではありません。文章をまとめるノウハウもないし、レイアウトの組み立て方も知りません。しかし、彼らはテキストエディタで書いたメモ書きでも仕事ができます。整ったドキュメントが必ずしも必要なわけではありません。それで成果が出せるなら、それで十分ではないでしょうか。整ったドキュメントが欲しければ、ドキュメントを書く専門の人に書いてもらえばいいです。きっと最高の結果が得られると思いますが、どうでしょうか。

Comment(3)

コメント

仲澤@失業者

自分の場合、仕様書の最初の行は決まってます。


定義:「A」は「B」を「C」するものです。


ですね。これしか書いてない仕様書がけっこうあります。


OOP的にはクラス名称が「A」、メンバオブジェクトが「B」、メソッドが「C」なので、
この一文が書けないとコードも書けません。
簡単な場合は数分で済みますが、大規模なものは数週間以上かかってしまう場合がありますけど。
後で気が向いた時や必要になった時に「B」「C」についての「定義:」を書いてます。

じぇいく

こんにちは。
私見ですが、ドキュメンテーションもエンジニアの仕事だと思っています。
エンジニアではない人のドキュメントに基づいてお仕事をするとエライことになりがちなのです。

すぎ

ドキュメント作成指示に苦戦している側です。
日本語をロジカルに理解してアウトプットできないエンジニアは、仕様認識にズレが発生し、
結果として形式的に記述するプログラムを設計することはできないと感じています。
日本語をプログラムに写すだけはできそう。
筆者さんの言っている専門家さんが、情緒あふれる文章ではなく、要求をロジカルに自然言語で表現する専門家なら、同意できます。

コメントを投稿する