ドキュメント作成は「ガイドライン」と「マニュアル」の区別が必須!

ドキュメントとは「参照される資料や書類」のことを指し、デジタル端末に保存されたPDFファイルなどもドキュメントに含まれます。

Web制作の現場でもドキュメントは使用されるフレーズとなりますが、特に「制作」のプロセスを経て、Webサイトの公開後に移行する「運用フェーズ」にてよく聞くことがあります。

しかし、Web制作の現場で使われるドキュメントの意図するものは「参照される資料や書類」だけでは少し物足りません。

Web制作の経験が浅い人は、この「ドキュメント」が指す具体的な対象物が上手く想像できないことも多いのではないでしょうか。

スムーズにWebサイトを運用するためにも、Web制作におけるドキュメントが指す対象物は覚えておきましょう。

Webサイト制作におけるドキュメントとは?

Webサイト制作におけるドキュメントは主に「運用マニュアル」「管理表」「帳票」のことを指しています。

ドキュメントは「サイト運営全体に関するドキュメント」と「業務内容に関するドキュメント」の2つに分類され、それぞれ役割が異なるのが特徴です。

サイト運営全体に関するドキュメントは「運営ガイドライン」とよばれ、「サイト運営の目標」「サイトの運営体制」「サイト運営に使用する各種ドキュメントまとめ」などで構成されます。

したがって、サイトの運営業務に関する細かな指示書というよりも、サイト全体を俯瞰して捉えた時の「品質」や「あるべき状態」といった資料としての印象が強くなります。

一方の業務内容に関するドキュメントは、各種業務や各コンテンツの「ガイドライン」「マニュアル」で構成されるのが特徴です。

それぞれの業務内容に対するルールや業務手順、コンテンツのクオリティチェックなどの参照資料となります。

サイト運営ではコンテンツ管理だけでなく、サービス向上・改善のための「アクセス解析」や、ユーザビリティを高めるための「コーディングチェック」などの作業も必要です。

いざこうした作業を行う折になって作業方法が分からず無駄な時間を過ごしてしまわないためにも、予めこうした運用に関するドキュメントを分類しておく必要があるといえます。

Webサイトの公開後に日々新たなトラブルが発生することを考えると、運営フェーズにおけるドキュメントの重要性が分かってくるはずです。

サイト運営全体に関するドキュメント

Webサイト制作におけるドキュメントのうち、サイト運営全体に関するドキュメントには「サイト運営の目標」や「運営体制」といったものがあり、まとめて「運営ガイドライン」とよばれます。

この運営ガイドラインが果たす役割は非常に重要で、さまざまな業務の目標や「なぜサイト運営を行うのか」といった理念が明記されます。

ほかにも、Webサイト運営の全体が一目で分かるように各業務の体系整理を行ったり、各業務が参照するドキュメントの一覧表を作成したりします。

このように各業務の手順や役割を1つに管理しておくことで、Webサイト運営に関わるメンバーの共通認識や徐々に増えていく業務内容の確認を容易に行えるようになるのです。

業務内容に関するドキュメント

Webサイト制作に関するドキュメントは先述したような「運営ガイドライン」と「業務内容に関するドキュメント」の2つに大きく分類されますが、必要に応じてさらに分類していきます。

その分類がコンテンツのクオリティをチェックするための「品質ガイドライン」と、実際にコンテンツを制作するに当たって参考となる「業務マニュアル」です。

Webサイトを運営する企業や個人によって「業務マニュアル」にある程度の品質基準を記載することもあるため、「絶対に分ける必要がある」とは一概にはいえません。

しかし、アウトソースを利用する予定があり、業務マニュアルを業務委託先のライターに送信する可能性がある場合は、分類しておくとそのまま送信がしやすく便利です。

いずれにしても、「納品された成果物の品質が基準を満たしている」と判断するためのドキュメントは用意しておく必要があるため、「品質ガイドライン」と「業務マニュアル」の分類があることは理解しておく必要があるでしょう。

ドキュメント作成時のポイント

ここからは実際のドキュメント作成で役立つポイントについて紹介していきます。

制作するWebサイトによって作成されるドキュメントの中身はさまざまなため、すべてのドキュメント作成に共通する工夫点をピックアップしました。

ドキュメントの内容を冒頭で示す

すべてのドキュメントで工夫できるポイントとなりますが、ドキュメントの冒頭で「このドキュメントには何が書かれているのか」を明記しておきます。

そうすることでドキュメントを読む人は「何をどこまでの範囲で知ることができるのか」を把握して読み進めることができるため、知りたい情報を確実に得ることができます。

また、該当ドキュメントを読む「対象者」や「必要スキル」を冒頭で明記しておくと、情報の適切な省略が可能となり、ドキュメント全体のボリュームを減らすことができます。

このようにドキュメントの冒頭部分を工夫することで、作業効率の上昇を図ることができるのです。

作業目安時間を記載する

ドキュメントにはトラブル発生時の「対応マニュアル」も含まれます。

対応マニュアルは普段あまり使用しませんが、トラブル発生に「所要時間が分からない」のでは多方面に迷惑をかけてしまいます。

そうした二次的なトラブルを防ぐためにも、各種トラブル対応にかかる手順と所要時間を予め明記しておきましょう。

ガイドラインとマニュアルを区別しよう

Webサイト制作の現場で使用されるドキュメントは規模や目的によってさまざまに変化します。

とはいえ、ドキュメントのガイドラインとしての側面とマニュアルとしての側面の両方があることは理解しておく必要があります。

これから各種ドキュメントの作成を行う担当者はガイドラインとマニュアル2つの役割を理解し、必要に応じて分類できるように準備しておきましょう。

(画像はPixabayより)
御社の課題にお応えします
資料請求お問い合わせ

お名前 必須

会社名 必須

メールアドレス 必須

電話番号 必須

お問合せ内容

下記の個人情報方針に同意します。