はじめに
おっさんエンジニアが新人エンジニアだったころにおっさんエンジニアに言われて実践してきたことを書きます。(ここではコーディング以外で言われたことを記載します。)
どんな作業でも工数見積もりをする。
「これどのくらいでできる?」
エンジニアやってると必ず聞かれるキーワードですよね。
特に新人エンジニアの頃は不明点も多いし、どこが難所かも想像つかないし(全部が難所にみえる)なんて答えていいかわかりませんよね。
私が新人エンジニア時代もそうだったのですが、そこで聞かされた話です。
最初から作業見積もりが正確にできる人なんていないので経験していくしかない。
ただし、毎回提示されている工数見積もりを見るだけでなく、自分自身でどのくらいかかりそうかを計算するクセをつけること。作業が完了したときに自分自身の工数見積もりとどのくらい差があったかを振り返ること。その繰り返しをしていけば工数見積もりの精度はかならず良くなるよ。
ただしい用語を使う。
ドキュメントやメールを書く時に様々なサービス名や製品名を記載することが多々あると思います。
そんな固有名詞にはかならず正式な呼び方があります。
ドキュメントを起こす時はきちんと調べて正式な呼び方を使いましょう。
会社やプロジェクトで統一された記載をする際の基準としてきちんと正式な名称で統一されていると気持ちいいですね。
また正式名称を調べるついでに出てくる記事などを見ることで、そのものの造詣を深めることができます。
× wifi Wifi WiFi
◯ Wi-Fi
× iPadAir2
◯ iPad Air 2
× xcode XCode
◯ Xcode
文書の書き方を統一する。
用語とちょっと似てますが文書についてもある程度統一していこうと言われました。ただし正直これはそこまで実践できていませんでした。
この話をされた時に基準として示されたのがマイクロソフトランゲージポータルです。
https://www.microsoft.com/ja-jp/language
(蛇足ですけど、ここでスタイルガイド落としてみたら今ってもうpdfで落ちてくるんですね。昔はマイクロソフトのドキュメントってxpsだったような。曖昧ですが、、)
- 全角文字と半角文字 (記号を含む) の間にはスペースを入れます。
- 全角文字どうし (記号を含む) の間にはスペースは入れません。
この辺りは割と有名なんではないでしょうか。
マイクロソフトは各言語への翻訳等ありますので翻訳のしやすさ等意識したものだとは思いますが、統一したフォーマットという点で参考にするのもいいかと思います。
この記事を書くにあたり色々と調べていたら2008年のカタカナ表記ルール変更の記事とかでてきて懐かしいです。。
https://japan.cnet.com/article/20377831/
公式のリファレンスは必ず目を通す。
Qiitaの記事やstackoverflowの質問など、コーディングに関する疑問を調べる際によく利用すると思います。もちろんこういった記事を参考にして開発は進めていくのですが、これらの内容を100%信じ切ってしまってはいけないということです。本当の正解は公式リファレンスですよという認識を持っておくことと、リファレンスをきちんと読むクセをつけたほうが良いです。
公式>>>書籍>>>>>>Web
くらいの信頼度でいた方が良いよって当時言われてました。10年以上前ですし今はもう少し違うかもしれません。
(逆引き大全とかなつかしいですね!)
終わりに
いかがでしたでしょうか!
人に歴史あり、プログラミングに歴史あり。
先人達の格言(叱言??)がみなさんの一助になれば幸いです!
それではEnjoy Hacking!!