知識や技術をドキュメント化する必要性

長田 太彪のプロフィール画像
エンジニア 長田 太彪

801 view

私はエンジニアとして、今までと異なる技術や設計などを試し知見を得ること、過去のコードをブラシュアップすることなどでスキルアップすることが必要だと考えており、これはエンジニアである以上ずっとそうありたいが、一方でこれまで培ってきた技術をドキュメント化する必要性も感じている。

これまで弊社に入社したエンジニアの傾向を見ると、HTML、CSS、JavaScript(jQuery)は書けるが、弊社で使用する開発環境(Git、タスクランナー)への理解不足や、実装面での独自ルール、例えばFLOCSSベースのCSS設計や、JavaScriptの設計に馴染むのが難しい、大規模サイトに対応するのが難しい、ということが多い。

これは新人エンジニアなら必ず通る道であり、後半に至っては社内文化なのでエンジニアのレベル関係なく発生する。ただ、教える側にとっては毎回説明するのはかなり骨が折れるし、異文化になじむ側も人によって説明が違うと、その人の理解度や教え方によって言われることが違うという状況にも成りかねず、体系だって学べないと結構つらい。できればこのあたりは毎回説明せずとも勝手に学べる環境を用意して、それよりもJavaScript、PHPの難易度の高い実装などに注力できたほうがよい。

以前コーディングテンプレートを作成していたが、HTML,CSSレベルであれば1から学ぶよりもテンプレートを使った方が早いし、例えば「こういう形のコンポーネントにはこういう名前を付ける」という命名ルール、「こういう考えだから余白はここにつける」というスタイルの指定ルールなどの社内文化を学ぶ学習コンテンツにもなるはずだ。

またそれとは別にgitやpug、sassなどを社内でどうやって使っているか、というドキュメントもあった方がよいだろう。プログラミング経験者であれば「公式ドキュメントを見て」だけで良いかもしれないが、それだけでは皆が十分に理解できるか怪しい。そしてその中には社内で使わない技術も多く、弊社で役立つスキルを身に付けるという意味では無駄が多い。なので、社内で使う技術だけでも先に身に着けてもらった方が良い。

エンジニアの採用に力を入れるのも勿論だが、一方で入社してくれた方が学びやすい環境の整備も力を入れていきたい。

関連する日報

    AIを使うことは、もはやマネジメントであるということ

    5,853 view

    小林聖子のプロフィール画像
    小林聖子 品質管理
    なぜ会議で発言しない方がリスクが高いのか?

    6,603 view

    大舘 仁志のプロフィール画像
    大舘 仁志 コンサルタント
    毒にも薬にもなる「なぜ?」のタイミング

    833 view

    瀬尾 友里恵のプロフィール画像
    瀬尾 友里恵 エンジニア
    フェアな人になりたいなら学べ

    2,373 view

    枌谷 力のプロフィール画像
    枌谷 力 代表取締役
    成長のために、社内で塾を始めた理由

    542 view

    藤本 恒輝のプロフィール画像
    藤本 恒輝 コンサルタント
上に戻る