WEBサービス創造記

WEBサービスを作ったり保守したりしてる人のメモブログです。

ディレクトリマップの作成

   

ディレクトリマップとは

ディレクトリマップとはこれから制作するWebサービスのすべてのページを網羅した資料のことです。
下表のようフォーマットで作成されます。

ディレクトリマップはページ単位で実装の進捗を管理が行えたり、ページのモックなど他の資料とIDを紐付けて確認できたりと非常に便利な資料です。
反面ここでリストアップするページに漏れや重複があったりすると、想定外の実装や余計な工数が発生することになるので慎重に作成する必要が有ります。

ディレクトリマップを作成するときの一般的な注意点は下記となります。

  • ページを漏れなくダブりなく網羅すること
  • ページの階層が一目でわかること
  • URLには規則性を持たせること(REST準拠など)
  • 割り振ったIDは変更しないこと

ディレクトリの表記法に決まりはなく、作成者毎にフォーマットが違ってくると思いますが、上記は概ねどの資料でも意識されていると思います。

自分なりにディレクトリマップをアレンジしてる点

上表は記事を書くためのサンプル用ということでかなり簡略化していますが、他のサイトで紹介されている記法とはいくつか異なっている点があります。
例えば、下記のような点です。

以下、それぞれについて自分なりの考えを記載していきます。

  • 動的なページをまとめている
  • CSSや画像はリストアップしない

動的なページの扱い

上表の例だと、カテゴリー毎の記事一覧が動的なページにあたります。

このような類のページは「プレスリリース」、「IR情報」、「従業員・組合への広報」とあげればキリがなくなってきますし、カテゴリーの増減があったときに更新の手間もあるので、自分は単に「カテゴリー別」という区分でわけることにしています。
URLのカテゴリIDのような動的に変わる値も、:idなどで表記します。

CSSや画像の扱い

CSSや画像などページの直接のレスポンスではないリソース(いわゆるAsset)もディレクトリマップにリストアップする場合もあるようですが、ここではページのみリストアップすることにしています。
理由としてはAssetはパスは採用するフレームワークなどのAssetのコンパイルの仕様によって決まることが多いですし、最終的にひとつのファイルをまとめられたりすることが多いためです。こういった場合はAssetのコンパイルの規約に準拠という注意書きだけで問題ないかと思います。

あとがき

ここではいきなりディレクトリマップの作成から開始しましたが、サイトマップ(サイト構成図)を作成してからそれを基にディレクトリマップに変換していくというフローもよく用いられるようです。

 - ディレクション