SEARCH

データ納品時のガイドライン

弊社にコーディングデータを入稿する際のガイドラインとなっております。また、RCMSで構築をする際のポイントにもなりますので、参考にしてみてください。

必須

【パートナー様へ】株式会社ディバータへの納品のコーディングデータ、デザインデータの品質について

    コーディングデータ、デザインデータを弊社に納品いただくパートナー様にお願いがございます。

    必ず事前に指定されているOS・ブラウザ・端末でモックの表示の確認を終えたデータの納品をお願いいたします。

    当ガイドラインの内容が担保できていない場合や、事前に指定されているOS・ブラウザ・端末で表示崩れが発生している場合は受け取ることができず、修正をお願いすることになります。

    また、どのような性質のサイトに適用するデータかにもよりますが、CSS設計などはある程度されているものをお願いいたします。
    弊社では以下のような構成を利用することが多いです。

    ・CSS設計
    FLOCSS
    参考)https://www.tam-tam.co.jp/tipsnote/html_css/post10205.html

    ・命名規則
    BEM

    ・タスクランナー
    gulp(yarn)

    ・CSSプリプロセッサー
    sass

    ・テンプレートエンジン
    EJS


    当ガイドラインについては納品いただく為の基準として使用しております。それほど特殊な内容ではないと考えておりますが、
    事前に一部のコーディングデータでもご提供いただければ、ガイドラインに沿ってるかの確認を致しますのでご相談いただければと思います。

    ガイドラインの詳細な内容については、以下をご確認ください。

    ファイルパスについて

      css、js、画像ファイル等のリソースファイルはルート直下に/files/user/とディレクトリを作り、その配下にリソースファイルを配置してください。
      RCMSでは画像やCSSファイル、JSファイルはファイルマネージャにアップロードして利用するため、ファイルを参照する場合、「../」は使用せず「/files/user/」から参照してください。「../」のままですとリンク切れを起こす可能性があります。また、データ納品後にファイルパスの置換作業が発生します。

       選択リソースファイルの配置について
      例:
      /files/user/images/file.jpg
      /files/user/css/style.css
      /files/user/js/script.js
      
      ファイルへの参照について
      NG:../../images/file.jpg
      OK:/files/user/images/file.jpg

      <form>内のsubmitボタンについて

        RCMSでは各種フォーム内のsubmitボタンは<input>または<button>を使用してください。
        <a>や<p>にした場合、スタイルを付け直す等の調整作業が発生します。

         選択NG:<a href="" class="btn--send">送信</a>
        OK:<input type="submit" class="btn--send" value="送信">

        <form>内のradioとcheckboxとselectについて

          RCMSの各種フォーム内で使用するradioとcheckboxとselectについて、指定可能なものは下記の通りです。

          ・inputのclass
          ・labelのclass
          ・labelを囲むタグ(1つ)
          ・inputのstyle

           選択基本形:
          <label><input type="radio" name="" value="" id="">見積もりに関して</label>
          
          NG:
          <label class="test1"><div class="form_item1" id="label"><input type="radio" name="" value="" class="item1" id="item"/><span>見積もりに関して</span></div></label>
          <label class="test2"><div class="form_item2" id="label"><input type="radio" name="" value="" class="item2" id="item"/><span>製品に関して</span></div></label>
          
          OK:
          <div class="test1"><label class="item1"><input type="radio" name="" value="" class="test"/>見積もりに関して</label></div>
          <div class="test1"><label class="item1"><input type="radio" name="" value="" class="test"/>製品に関して</label></div>

          <form>内の都道府県のvalue値について

            都道府県のvalue値は都道府県コードを設定してください。

            ※RCMSでは「全国地方公共団体コード」を利用しており、都道府県コードは「JIS X 0401」に基づきます。

            全国地方公共団体コード

             選択NG:<option value="東京都">東京都</option>
            OK:<option value="13">東京都</option>

            js、cssのセレクターにname属性を使わない

              検索フォームやお問い合わせフォーム内でjsの処理が必要な場合、装飾やjsの処理のセレクターにname属性は使用しないでください。
              RCMSのテンプレート内でinput要素のname属性を使用するため、セレクターにはidかclassを使用してください。

               選択NG: $('[name=submit_btn]').on('click', function(){});
              OK: $('.submit_btn').on('click', function(){});

              jsファイルの結合・圧縮を行っている場合

                タスクランナーやビルドツールでjsファイルの結合・圧縮を行っている場合、データ納品後にファイルの編集を行う可能性があるため、結合・圧縮前のファイルの納品もお願いします。

                jsからurlを参照する処理を書く場合

                  jsからurlから「.html」を検出するような処理は避けてください。RCMSではページのURLは「/」で終わることも多いため、「.html」はカウントされず、意図した挙動にならない可能性があります。

                   選択ローカル上のURL: https://www.r-cms.jp/news/index.html
                  RCMS上のURL: https://www.r-cms.jp/news/

                  外部リンクのURLの記述について

                    「http(s):」から始まるURLで記述してください。
                    Google HTML/CSS Style Guideで推奨されている記述方法です。

                     選択NG:
                    <a href="//www.r-cms.jp/" target="_blank" rel="noopener noreferrer">参考サイト</a>
                    
                    OK:
                    <a href="https://wwwt.r-cms.jp/" target="_blank" rel="noopener noreferrer">参考サイト</a>

                    CSSプリプロセッサーを使用している場合

                      Sass等のCSSプリプロセッサーで生成したcssファイルを納品する場合、データ納品後にファイルの編集を行う可能性があるためプリプロセッサー側のファイルも納品物に含めてください。

                      RCMSではSSIをサポートしていないため使用できません

                        要望

                        セレクターの先頭に要素を付けない

                          再利用性の高い装飾は特定のページだけで使えるのではなく、他のページでも再利用可能なコーディングをお願いします。

                           選択NG:h4.heading
                          OK:.heading

                          特定のページで共通部分にidやclassを付与する場合

                            body、header、footer等のページ内の共通部分に特定のページでidやclassを付与する場合、どのページで何を付与しているかのリストの提供をお願いいたします。もしくは、特定のページでは共通部分にidやclassを付与しない設計が好ましいです。

                             選択NG:
                            <body id="top_page">
                              <p>トップページ専用の装飾をします</p>
                            </body>
                            
                            OK:
                            <body>
                              <div id="top_page">
                                <p>トップページ専用の装飾をします</p>
                              </div>
                            </body>
                            
                            ※<div id="top_page"></div>は共通部分ではない

                            空タグの使用について

                              管理画面で空タグを使用すると、ユーザー閲覧ページでタグが削除されるため、装飾のための空タグは極力控えてください。
                              止むを得ない場合は開始タグと閉じタグの間に半角スペースを入れてください。

                               選択NG:<a class="icon"></a>
                              OK:<a class="icon"> </a>

                              複数のページで再利用できるようなコーディングデータ

                                再利用性の高い装飾は特定のページだけで使えるのではなく、他のページでも再利用可能なコーディングをお願いいたします。

                                モックアップサイトの提供

                                  コーディングデータの納品時は、表示確認および動作確認ができるモックアップサイトを提供してください。
                                  遷移ページは<a>タグ内に記述してください。

                                   選択NG:<a href="#">ニュース</a>
                                  OK:<a href="/news/">ニュース</a>

                                  参考になるページ

                                    以下に挙げている内容は長く運用するサイトにおいては必須に近い事項になります。
                                    RCMSをご利用されるサイトは更新頻度が高く長く運用される想定のものが多いので、以下のページはなるべく参考にしていただきたい内容になっております。

                                    フロントエンドエンジニアから、デザイナーさんに意識してほしい10のこと
                                    https://note.mu/pittan/n/n5789d09c5575

                                    知っておきたいCSS設計法 - OOCSSの基本 | CodeGrid
                                    https://app.codegrid.net/entry/oocss-1

                                    SEARCH