2016年03月

23

水曜日の投稿

松原 恵
投稿者:松原 恵
(ディレクター)

2016年03月23日

コーディングファクトリーのガイドラインがバージョンアップしました。
〜コーディングガイドライン策定 #01〜

コーダーのあーだこーだ

松原 恵
投稿者:松原 恵(ディレクター)

こんにちは、コーディングファクトリー部コーダーの松原です。

私たちコーディングファクトリー(以下CF)のコーダーは、特にお客さまからの指定がない場合、CFのガイドラインに沿ってコーディングをしています。

ガイドラインに沿ってきちんとコーディングすることで、どのコーダーが制作を担当しても、納品物のクオリティを一定に保つことができます。また、お客さまから追加ページや変更のご依頼いただいた際に、前回担当したコーダーが対応できなくても、同じガイドラインを使用していれば、サイトの構成を容易に解析にすることができ、迷うことなくスムーズに制作に入ることができます。
コーディングガイドラインはコーダーにとって布石でもあり、また道しるべでもあるのです。

CFのガイドラインは、コーダーが実際に使用する中で、気付いたことや改善点を随時検討・反映し、より使いやすいものになるよう、バージョンアップを繰り返してきました。そんな中、先月大幅な改訂を行い「Ver.6.0.1」となりました。

今回は新しくなったCFのガイドラインについて、経緯と概要をご紹介したいと思います。

なぜ今回バージョンアップしたのか

2014年10月28日、HTML5が勧告になりました。


W3C(ワールド・ワイド・ウェブ・コンソーシアム)によるHTMLとXHTMLのための語彙と関連API
https://www.w3.org/TR/html5/

それ以前は、「Webサイトを制作するときは、XHTML1.0を使いましょう。」というルールがW3C(ワールド・ワイド・ウェブ・コンソーシアムの略称、Webの標準策定を行っている非営利団体)によって定められていました。それが「これからはHTML5を使うように。」と変更されたのです。

CSS3の仕様の策定も進み、新機能が各ブラウザで次々と先行実装されました。代表的な機能として、これまで角丸やドロップシャドウ、グラデーションの装飾は画像を使って実装していましたが、モダンブラウザではCSSのみで再現可能になりました。

また、お客さまからご依頼いただく内容が多様化してきたことも理由の一つです。
これまでのPCサイトやスマートフォンサイトの案件に加え、レスポンシブWebデザインを採用するサイトの割合が多くを占めるようになりました。
CFのガイドラインも、このような現場の変化にあわせて内容を変更する必要があり、「ガイドライン策定委員会」が発足したのです。

ガイドライン策定委員会 = 現役コーダー8名


ガイドラインについて話し合う委員会メンバーたち。

去年(2015年)の夏が終わった頃、当時のCFコーダー全員が委員会のメンバーとなり、ガイドラインの改訂に向けて、話し合いがはじまりました。会議は毎週おこなわれ、多い時で週に2回ひらかれることもありました。

初回のブレストでメンバーから上がった検討内容は、どれも重要できっちり話し合わなければならないと感じるものでした。決めなければならないことが多すぎて、一体どれだけ分厚いガイドラインができるのだろうと若干不安にもなりました。
しかし、散々話しあった末に「これについてはルールとして決めない方がよいのでは」という結論に至ったものも多く、私が心配していた、辞書のように分厚いガイドラインにはなりませんでした。

ルールがあればそれに従えばよいので、考える手間が省け時間の節約にもなる。工数削減は大きなメリットですが、ルールを決めすぎると柔軟性が失われ、かえって使いにくいものになってしまいます。

コーダーの実体験から、あらかじめ決めておいた方が楽なもの、逆に決めてしまうことでルールに縛られやりにくくなってしまうこともじっくり話し合いました。人数が多いとそれだけ取りまとめるのは大変ですが、多くのコーダーの意見を取り入れられたことは、非常によかったと思います。

一体どこが新しくなったのか

変更内容を大きく分けると、以下の3つです。

  1. Webを取り巻く環境の変化にあわせて、新しく追加した項目
  2. これまでガイドラインで定められていたが、現状不要になった項目の削除
  3. classの命名ルール

一つ目と二つ目は想定内のことでしたが、話し合いをはじめると、その他にも様々な改善案が出されました。中でも多くの時間を費やしたのが、三つ目のモダンCSS設計を参考にしたclassの命名ルールについてです。

具体的な内容については、今後数回に分け、こちらのコーナーでお伝えしていく予定です。

新しいコーディングガイドラインを読んでみたい方はこちら

この投稿を書いた人

松原 恵

松原 恵(まつばら めぐみ)ディレクター

コーディングファクトリー部ディレクター。毎月行われているモノサスの読書会には初回から参加、技術本以外の本を読むよいきっかけになっています。最近はまっているのは日本酒としゃべる猫のものまね。

松原 恵が書いた他の記事を見る