Web制作ガイドライン

このガイドラインは下記のガイドラインを参考に作成されています。

Google HTML/CSS Style Guide
WordPress コーディング規約

本ガイドは、品質の均質化とメンテナンス性の向上を目的に作成されています。
作業効率の低下を防ぐため、最小限度の項目に絞っています。ご確認、厳守のほど宜しくお願いいたします。

対応環境

対応環境で使用できないプログラム、スタイルは使用しないでください。

対応OS

OSの種類 バージョン
Windows Windows 11
Mac OS 最新版
iOS 最新版
Android 最新版

対応ブラウザ

ブラウザの種類 バージョン
Internet Explorer 対応しません
Edge 最新版
Chrome 最新版
Safari 最新版

提供資料について

原則、下記資料を提供しますので、必ず準拠して作成をお願いします。
依頼内容によっては、下記資料から作成いただくこともあります。

  • SPブック:
    案件の概要・ヒアリング内容・仕様・サイトマップが記載された資料を提供します。
    特に「各ページのURL」「title」「description」に関してはこちらに準拠いただくようお願いいたします。。
  • TOPデザイン:
    デザインからやっていただく場合には、TOPのワイヤーフレームを提供します。
    コーディングから依頼する場合はデザインデータを提供します。
  • 下層ワイヤーフレーム:
    全ページのワイヤーフレームを提供します。

ディレクション工程からご依頼する場合は、SPブックをご利用ください。

ディレクトリ階層

下記のディレクトリ階層に従って構築をお願いします。

root
├─asset
│  ├─css      :CSSはここに格納して下さい。
│  ├─images   :画像はここに格納して下さい。
│  ├─js       :JavaScriptはここに格納して下さい。
│  └─sass     :Sassを使用する場合はここに格納して下さい。
└─hoge-wp     :WordPressのインストールフォルダ

※hoge-wpのhogeは案件名の短縮3文字

コーディング規約

サーバー内リソースの参照

画像、スタイルシート、スクリプト、下層ページ等の同一サーバー内の参照にはルート相対パスを用いて参照してください

<!-- 非推奨 -->
<img src="https://www.hoge.com/assets/images/hoge.png">
.hoge { background-image: url(../hoge.png); }
<!-- 推奨 -->
<img src="/assets/images/hoge.png">
.hoge { background-image: url(/assets/images/hoge.png); }

外部リソースの参照

使用できない場合を除き、外部リソースの参照にはHTTPSプロトコルを使用してください。

<!-- 非推奨 -->
<script src="//ajax.googleapis.com/ajax/libs/jquery/3.1.0/jquery.min.js"></script>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/3.1.0/jquery.min.js"></script>
<!-- 推奨 -->
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.0/jquery.min.js"></script>  

メディアファイルのサイズ制限

原則装飾目的のイラストやロゴ、写真を除き画像は使用しないでください。画像の場合は1MB、動画の場合は3MB以下の素材を利用してください。

<!-- 非推奨 -->
<a href="/contact/"><img src="/common/images/contact.png" alt="お問い合わせはこちら"></a>
<!-- 推奨 -->
<a href="/contact/">お問い合わせはこちら</a>

その他規約

  • 画像、ファイル、クラス名などはメンテナンス性向上のため、他者が見て意思疎通が可能な名前にして下さい。
  • HTMLタグやCSSでは全角文字は使用しないで下さい。
  • tableレイアウトは使用しないで下さい。
  • HTMLに埋め込みでスタイルは指定しないで下さい。
  • HTML5,CSS3に準じて記述してください。
  • CSSセレクタの命名規則はFLOCCSで記述いただけるととても助かります

WordPressについて

インストール先について

サーバーのルートディレクトリにWordPressインストールフォルダ「hoge-wp」を別途用意してそこにインストールしてください。
この時、インストールフォルダ名は「(案件名の短縮3文字)-wp」にしてください。

インストール先は「/hoge-wp/」ですが、サイトTOPのURLはルートディレクトリに設定お願いします。

プラグインについて

下記のプラグイン以外は、必要な場合を除き使用しないでください。

  • All In One SEO
    └原則、title、descriptionを個別に設定するため、指定です。
  • WP Multibyte Patch
  • WP-PageNavi
  • Contact Form 7
    └フォーム設置の場合は、指定です。
  • SiteGuard WP Plugin
    └指定です。細かい設定手法は別途ご連絡します。
  • 【※】Advanced Custom Fields Pro
    └カスタムフィールドが必要な仕様の場合は、指定です。弊社の有償ライセンスで有効化いたします。
  • 【※】Classic Editor
    └原則、お客様が更新するページ以外も、すべて『固定ページ』化していただき、管理画面から編集可能な状態としていただきます(運用効率のため)。コードが編集できれば問題ありません。
  • 【※】Contact Form 7 Multi-Step Forms
    └原則、フォームには”確認画面なし”としていますが、お客様のご要望で確認画面を設置する場合は、こちらのプラグインを使用してください。但し、フリープランの場合は4KBの制限がかかると送信できなくなるため、全体の項目や注釈の文字数、フリーテキスト枠の文字数制限などにご注意ください。
  • 【※】Drag and Drop Multiple File Upload for Contact Form 7
    └原則、フォームには”添付機能”は実装させない方針なのですが、どうしても添付機能を設置する場合は、こちらのプラグインを使用してください。

WordPressアカウントの作成

原則、マスターアカウント(フル権限:社内用)と、お客様アカウント(お客様が更新する箇所のみ表示)の2アカウントを作成していただきます。

その他

  • 管理者アカウントのIDを”admin”などの推定されやすい文字列には絶対にしないでください。
  • パスワードは強度が高い文字列かつ12文字以上の長さにしてください。
  • パーマリンク設定は、「カスタム構造」>「/%category%/%post_id%/」で設定してください。

メールフォームについて

  • 原則、Contact Form 7 を使用してフォームを作成して下さい。
  • 管理者宛てと、ユーザー宛で2つの自動返信メールを設定してください。
  • フォームには、確認画面を設定してください。
    確認画面の実装が難しい場合は、ご相談ください。
  • 送信後、サンクスページ(例:/contact/thanks/)に遷移するよう設定してください。

納品について

納品時には下記のデータを弊社にご提出ください。

  • 特にSASSを使用した場合は最新の状態にコンパイル出来ることを確認して納品をお願いします。
  • データベースのログイン情報
  • WPのアカウント情報
  • 各パーツのデザインデータ(psd,ai等)

公開について

リニューアル案件の場合、テスト領域に構築したサイトデータを公開できる状態への移行をお願いします。