一般社団法人 全国個人事業主支援協会

COLUMN コラム

フリーランスエンジニアとして活動していると、ドキュメントの重要性が大事に思うことが多々あります。特に重要視しているポイントをいくつか紹介させていただきます。

1.コードの可読性

リーダブルコードを読め!で済む位プラグラミングに関わる人にとって重要な書籍(と思っている)

個人的に命名規則とコメントの扱いは重要視しており、プロジェクトでコーディング規約がないプロジェクトに関しては、なるべくレビューでコーディングにおける認識を合わせるようにしています。

 

2.ドキュメントの保管

セキュリティの問題は別として、なるべく共有ストレージを使ってローカルに置かない、適当なアップデートの名前を付けない。

 

3.プロジェクトwikiの利用

最近はwiki以外にもあるようですが、要は知識は共有、保存しておきましょう。の意識が重要です。引き継ぎも楽に済むし、手順をまとめるのも良いでしょう。

人間は忘れる生き物なので、自分の記憶領域を過信せず、書き留めておくと良いです。

ベストは書いたものを他の人が確認、再現出来ることが一番良いです。お互いに間違いを修正し、環境による誤差を無くし、知識の共有の意識を高めることが出来ます。

この記事をシェアする

  • Twitterでシェア
  • Facebookでシェア
  • LINEでシェア