コーディング規約を作ってみた。

投稿： 2019/03/24 ｜更新： 2019/03/30

4月から開発予定のWebアプリのために、まずはコーディング規約を考えることにしました。
基本的にひとりで作りますが、いつか外注するかもしれないですし！（遠い未来）
このブログも「先ず書く！」と決めているため、コーディングはめちゃめちゃですし。いずれは変えないとと思っていて、今までの経験上その「いずれ」が来たことはありません……(笑)

コーディング規約とは

複数人で制作にあたる場合、マークアップやプログラミングなどの品質を保つために決めたルールをまとめたものです。
グループで制作する場合や、外注する場合など相手方のスキルはまちまちだと思います。
後になって困らないために、最低限守ってほしいルールや絶対にやってほしいこと、禁止事項などを盛り込んでおきましょう。

私にとっての注意点！

縛りすぎないこと！スキルの高い・得意分野がある人の生産性を落としてしまう！
品質を守ることだけに注視し、根拠のない「これが良い」は排除すること。
共通のものには、スキルが高い人用に例外を作っておく！
禁止事項はなぜダメなのかを書いておくこと。
新人など、現場のスキルに追いついていない人には、別途手引書を作る。

「私が正しい」ことはない！

決めてみたこと

目的

統一性を持たせ、後に整理・発展させやすくするためにルールを設ける。

命名規則

ケバブケースは使わない。単語をつなぐ時はキャメルケースにする。
（JSなどプログラム言語で、「-」はマイナスの記号として認識されるため変数などには使えない。DBの不具合につながる、など理由が多数ある）

フォーマット

基本的に、Google HTML/CSS Style Guideに合わせる。
文字コードはUTF-8、改行コードはLFにする。
HTML5を使用する。
Sassを使用する。
FLOCSSかBEMを使う。
セマンティック・インクルーシブなコーディングを心がける。

対応ブラウザ

Google Chrome、Firefox、Safariの最新版
（Windowsが故障中のため確認ができませんw）

守ってほしいところは、人それぞれだと思います。
また、コーディングする側だけの意見ではデザイナーさんや他の業務の人も縛られて困ってしまいます。
人を巻き込む場合は、よーく話し合った上で決めることをオススメします。
私も制作意図と、デザイナーさんに方向性を何度も何度も聞きにいきます。最近はディレクター見習いのようなこともやらせていただいてますし。
「私にとっての注意点！」を読んでいただいていればお分りかと思いますが、そうでないと私はゴリッゴリに固めてしまって、つまらないサイトになってしまうので。。。
こうやっていくつか案を出して、そこから話し合うとスムーズに進むのでオススメです(･ω<)☆

リリース数：8（記事：6、Document：2）投稿日時現在