Web制作 おくだ屋

WEB制作 おくだ屋

//この中に次から作るsvgデータを入れていく
ホーム > ホームページ制作 > 保守を考えた実装って?引き継ぎやすいコードの条件【発注側目線】
ホームページ制作

保守を考えた実装って?引き継ぎやすいコードの条件【発注側目線】

「あのときの外注コーダーさんに頼んだサイト、別の人が触ったら何時間もかかってた…」

制作会社・ディレクターの皆さんなら、こんな苦い経験ありませんか?納品時はキレイに見えても、いざ改修フェーズに入ると「触れない」「壊しそう」「結局書き直し」になってしまうコードがあります。

今回は「引き継ぎやすいコード」とはどんなものかを、発注側が知っておきたい観点でまとめました。

結論:「規則性」と「最小限の前提」

引き継ぎやすいコードの特徴を一言で表すと、「規則性があり、最小限の前提知識で読める」こと。複雑な独自ルールや、コメントのない暗黙知に依存しないことが理想です。

① CSS設計が決まっているか

BEM、FLOCSS、CUBE CSSなど、何でもいいので設計思想が一貫していること。

命名スタイル 引き継ぎやすさ
BEM(Block__Element–Modifier) ◎ ほぼ全業界で通用
FLOCSS(layer/component/project等) ◎ 規模感あるサイトに最適
Tailwind(utility-first) ○ プロジェクトによる
独自命名(意味なし) × 引き継ぎ困難

② ファイル分割が論理的か

1ファイル5000行のSCSSは、もはや読めません。役割ごとに分割されていることが重要です。

  • foundation/:リセット・変数・ミックスイン
  • layout/:header、footer、grid系
  • component/:再利用パーツ(ボタン、カード)
  • project/:ページ・セクション固有スタイル

SEOとコーディングの関係でも触れましたが、整理されたコードは検索エンジンにとっても理解しやすくなります。

③ コメントは「なぜ」を書く

良いコメントは「何をしているか」より「なぜそうしたか」を書きます。

// 悪い例
// 文字色を赤に変更
.error-message { color: #ff0000; }

// 良い例
// ブランドカラー違反を避けるため、エラー文字は赤(#c00)に統一
.error-message { color: #cc0000; }

「なぜ」が書いてあれば、改修者は影響範囲を判断できます。

④ 単位や数値に意味があるか

突然出てくる87px13.5emは、改修時に「これ動かしていいのか…?」と止まる原因になります。

  • 4px / 8px の倍数などのルールがある
  • 変数(CSS Custom Properties or SCSS変数)で管理
  • マジックナンバーには理由をコメント

⑤ JSが疎結合か

JavaScript も同じ。「これを修正すると、別の箇所が壊れる」状態は引き継ぎ困難の典型です。

  • 機能ごとにファイル分割
  • グローバル変数を作らない(即時関数で囲む、moduleで書く)
  • セレクタは js-xxx 接頭辞で分離(CSSとの混同を防ぐ)

引き継ぎやすさを発注前に確認するには?

外注コーダー候補に、こんな質問をしてみましょう。

質問 狙い
「他社が書いたコードを引き継いだ経験はありますか?」 引き継がれる側の苦労を知っているか
「ファイル構成のサンプルを見せてもらえますか?」 整理術の確認
「コメントの方針はありますか?」 運用視点の有無

こうした質問に明確に答えられる人は、引き継ぎ可能なコードを書きます。

納品時にもらいたい資料

  • READMEファイル:ビルド方法・依存パッケージ・主要なディレクトリ説明
  • 変数一覧:色・余白・フォントサイズなど
  • 動作確認手順:ローカル起動方法

これらがあるだけで、半年後・1年後の改修が劇的にスムーズになります。

まとめ

引き継ぎやすいコードは、「規則性」+「最小前提」+「丁寧なコメント」の3点で生まれます。発注前のヒアリングと、納品時の資料請求でかなり防げます。

「過去の納品物が引き継ぎにくくて困っている」「今後の案件は保守を考えた実装にしたい」という方は、おくだ屋の制作会社向けサービスでも対応可能です。お気軽にご相談ください。