ガイドラインをドキュメントにする

ガイドラインは作ったら社内でどのような形で共有していますか？ 社内のネットワーク上に公開したり、ドキュメントとして保管しているでしょうか？

ガイドラインは職場の皆に存在をアピールして、浸透させてこそのものなのです。大きな組織になればなるほど、直接業務に関係ないとガイドラインの存在さえ知らなかったりします。自社サイトの定義として目立つ所にバーンと置きたいものです。

複数人でのサイト制作、管理、運用という作業を行うというフローにおいて、企業やある程度人数のいる組織内で人員の異動はよくあることです。

そのような場合でもガイドラインをドキュメントとしておくことで、新人や異動してきた人、派遣社員や業務委託の人に読んでもらうことができます。手始めにサイトの構成や大まかなところを理解してもう手がかりになるはずです。

また、外注先の制作会社にもガイドラインを渡して読んでもらえれば自社のサイト構成を手間をかけずに説明でき、デザインをしてもらう時にもガイドラインとかけ離れたデザインが上がってくる恐れはまずないでしょう。これは強い味方です。

筆者の場合、外注先にガイドラインを渡した上でさらに口頭でもお願いする点があります。それは推奨環境での動作確認やソースコードの記述方法です。推奨環境が書いてあっても、意外と先方の常識ブラウザのみのチェックでこちらのガイドラインを見ていない場合が何度かあったからです。それぞれのWebサイトで推奨環境は意外とバラバラなので、注意してください。

また、ガイドラインもさらに詳しく、いくつか対象の人向けにそれぞれ専用の項目を追加するなどしても良いかもしれません（図2）。

今までも行っていた業務を再度見直すという作業をすると、改めて今までの作業に無駄があった事に気付いたりします。更新フローや担当が決っている場合には、現場の人の作業フローを実際によく理解してそれに基づいてガイドラインを作成することで今までのものよりも実践的で無駄のないものになるでしょう。

ガイドラインは常に鮮度の良いものにしておく必要があります。そのWebサイトの最新情報であるからです。また、ガイドラインをドキュメント化して共有するというフローによって、1人のみで知識や技術を抱え込むことも防ぎます。

ガイドラインがあってもそこから抜けている事項で「あー、これって○○さんしかわからないんですよね」というトラブルがあったりします。完璧な管理は1人1人の意識も大事になってきます。主に管理する側の、Webの知識や技術が長けてる人ほどガイドラインの存在をあまり注意していないことってありませんか？

よくプログラマで（しかも結構デキル人）「仕様は頭の中にあります」とかいうことでドキュメントにしていないという話を聞いたりします。しかし、その人に何かあって急に入院したりしてしまったしたら、という不安が残ります。そのため、ドキュメントにすることはとても重要です。

これは、HTML/CSSでも同じことです。情報を共有するという役目もそういう意味でとても大切です。

曖昧を潰すチャンス

実際にガイドラインをドキュメントにする作業をしていくと、今まで持っていた知識の曖昧さに気付くでしょう。ガイドラインを決めていくメンバーでの話し合いの中で「わかったつもり」がたくさん出てくるのではないでしょうか。

前回書いたソースコードの記述方法やコメントタグの入れ方の他にも、HTMLのバージョン、ファイルの拡張子（htmlやhtm）、ダブルクォーテーションやシングルクォーテーション、読み込む外部ファイルの正しい分け方など、曖昧な知識を一掃する良い機会になるでしょう。

曖昧でも済んできたけれどせっかくガイドラインをきれいに作り直すなら、気合いを入れて一度全部基礎から書き直しても良いのではないでしょうか。ここが曖昧な知識とお別れするチャンスです！ 次のページ