このガイドラインについて
背景
ウェブサイト制作の現場では、検証ブラウザからInternet Explorerが外れて以降、フレームワークの導入障壁が消滅し、JamStackやマイクロフロントエンドなどフロントエンドとバックエンドという切り分けがないようなウェブサイト開発が当たり前になってきています。モダンな開発手法を体験していくにつれ、ブラウザに配信されるHTML、CSS、JavaScriptに対しての興味関心がますます薄れてきていないでしょうか?
ブラウザに配信されるリソースを最適化し、品質を高めるのはフレームワークではなく、開発者とそのチームです。
ウェブサイト制作のプロとして、(自分にとって)簡単に制作するのではなく、品質の高いウェブサイトを制作することに重点を置くためには、良いウェブサイト制作を指し示すガイドラインが必要です。
我々が提供すべきものはとてもシンプルです。
ウェブサイトを利用するユーザーにとって、
- セマンティックでアクセシブルなHTML
- 最適化されたメディア及び外部リソース
ウェブサイトを運用していく企業・担当者にとって、
- クリーンで一貫性のあるHTML
- いつまでも更新しやすいCSS
- 外部ライブラリなどへの依存が最小限のJavaScript
- そしてサイト運用のためのわかりやすいドキュメント
提供するものの品質を最重要視しながら、
いつでも/メンバーに左右されることなく/合理的なスケジュールで
制作するためのガイドラインを作り、適切に運用していこうと考えています。
目的
本ガイドラインが目指すのはコーディング品質の継続的向上です。
ウェブサイト制作はコーディングのプロ以外でも十二分にそれなりのクオリティで制作出来るようになってきています。
- 生成AIによる自動化
- テンプレートからのコピーアンドペースト
- ノーコードツール
- プログラミングスクールで就学したフリーランスの登用
- ウェブサイトを保持する企業による内製化
本ガイドラインを利用する人にとって上記はライバルではありません。
本ガイドラインの利用者は、プロとしてウェブコーディングの品質に向き合い、一定以上の品質をクライアントおよびユーザーへ提供するとともに、開発期間中の気づきが経験となり、納品する頃には「もっとよく(うまく)出来た」と実感できるでしょう。
そしてガイドライン利用者自身のレベルアップとともに、本ガイドラインもより最適な形へと変化していきます。 本ガイドラインは更新時点での良いコーディングを指し示すものです。翻って、ガイドラインを利用する時点では正しくなくなっている可能性があります。 よりよいコーディングが出来る場合はガイドラインを守る必要はありません。
品質の高いコーディング > ガイドラインの遵守
です。
ガイドラインが誤っている場合は指摘をしましょう。指摘するためのフローも用意しています。あなたの考えや知識、検証した事実がガイドラインに反映されることで、あなたが手に入れた品質が本ガイドラインの改善につながり、次回ガイドラインを利用する誰もが、より高い品質で制作することが可能になります。
適用
依頼元(クライアント)のコーディングガイドラインがある場合は最初にそれを遵守します。
そのためにはこのガイドラインをよく確認し、どのような相違点があるか整理してプロジェクトに着手してください。
例えば以下のようなケースがあるかもしれません。
A.依頼元のベンダーロックインによる相違点があった場合
例:文字コードがShift-JISである。CSSファイルの形式に指定がある。(〇〇.cssに追記しなければならない。など)
プロジェクト固有の仕様として対応します。 本ガイドラインへの追加は不要です。
B.依頼元のガイドラインよりも当ガイドラインを採用したほうがよいと思われる場合
クライアントと相談をします。該当箇所を本ガイドラインで進めることになった場合はその旨を適切にプロジェクト内で共有してください。
クライアントが承知しなければクライアントの指示に従います。
C.依頼元のガイドラインが本ガイドラインよりも良いものであった場合
本ガイドラインに取り込めるか検討したいのでぜひ情報提供してください。
許諾が必要なものであればその旨も教えて下さい。