2021-02-11

ドキュメントを書けないエンジニアは単に能力が低いだけ

たとえば、「彼は優秀な数学者だが、論文は書けない」なんて話は、(まあよほど特殊な事例を別にすれば)無い。

一方、「彼は優秀なエンジニアだが、ドキュメントは書けない」という話は、この業界に勤めていれば頻繁に聞く。しかも、コードは書くがドキュメントは書かないことが職人気質でかっこいいかのようなニュアンスを含む場合すらある。

この違いは何だろうか?答えはこうだ。

ドキュメントを書かないエンジニアは、エンジニアとしてもレベルが低い」

ただそれだけの話だ。

ドキュメントが書けないというのは、自分の作ったプログラム設計、あるいは使っているツール等の機能理解していないということである。つまり結果的に動くものが作れただけで、その実は見よう見まねでコードを書いたりツールを使ったりしてただけということである

ソースコードドキュメントである」というのは単なる怠慢に過ぎない。実際、有名なオープンソースソフトウェアには良質なドキュメントがあることが普通である。ついでに言えば、それらの開発者は、その辺のサラリーマンエンジニアよりも遥かに優秀である

ソースコードが完全なドキュメント足り得ないのは、

等、ソースコードに直接現れない情報いくらでもあるからだ。こんなことは、わざわざ書かなくても、一定常識があれば明らかだが。

  • プログラムが書けるのに日本語が書けないわけ無いだろ。 あるいみ、雑誌の執筆経験もあるが、営業がわかるようなドキュメントは書かない。 シャットダウンの方法とかパスワードとか...

    • パンティー

      • 営業向けには技術論ではなく小説を収めるようにしている。挿絵付きの。

        • よくわかるMS-WORD 2000円ぐらい。1冊辺り。

          • 受注できたら、そのままシスアドの会社に自分で作ってって20%ぬいて投げようかなと。 突如魔法のようにシスアドができるようになるから。

    • どう考えても自然言語を書く能力って別物だと思うんですが

      • ドキュメントは自然言語で書くわけではない。ましていわんや論文。 MS-WORDなら、よくできるMS-WORDにいくまでがながいだけ。何段階もドキュメントがある。

        • ウホッ☆きらーん

        • プログラムが書けるのに日本語が書けないわけ無いだろ 前提どこいいったの

          • そうではなくて、知らないやつが読んでも読めないように難読化してあるドキュメントが読めないのは当たり前だ。 会社においてある設計図なんかは、事務員でも読める。 情報を事務員...

            • 素人が読んでもわからず、専門家が読めばわかるように書いてあるのに 素人が読みやすいものを書けない馬鹿な人といわれたら、知恵が足りないのはお前だとかえすのはあたりまえ。

              • 硝酸にニトログリセリンをまぜるといいよ。とかあぶないからかけないだろ。それとおんなじ。書けないんじゃないくて書いちゃだめなんだよ。

            • 前提嫁よプログラムの話はどこいったんだ

  • いくらのドキュメントがほしいのか、金額を教えてくれ。 ソフトXX円 ドキュメントBB円 金額分のドキュメントを納品する。だけど営業が書いたほうが安いぞ

記事への反応(ブックマークコメント)

ログイン ユーザー登録
ようこそ ゲスト さん