EC-CUBEのドキュメントはどこに？ - EC-CUBEのカスタマイズ、ネットショップ制作メモ

昨日の記事、グロースハックってなに？の評判が良かったので、調子に乗って今日も書きます。

EC-CUBEを使ってネットショップを構築する場合、よくドキュメントの話になります。
こういったオープンソースのパッケージの場合、特に日本語のドキュメントが少ないのがよく問題になります。

DB定義書や仕様書、コーディングガイドラインなど、あると開発がスムーズに進みます。
さて、EC-CUBEのこれらのドキュメントはどこにあるのでしょうか？
公式サイトにも記載がなく、慣れていない方は探すのに苦労すると思うのでご紹介です。

EC-CUBE4カスタマイズのお問合せはこちら

実はソースコードに同梱されています。

EC-CUBEをダウンロードして展開すると、docsというディレクトリができます。
実はこの中にドキュメントが入っています。

eccube-diagram.jude
- astah* community - 無償UML モデリングツール（ http://astah.change-vision.com/ja/product/astah-community.html ）用のER図とかのデータベースの定義ファイルです。
  これが一番見やすいですね。
ER-D_Logical.pdf
- 上記のeccube-diagram.judeに含まれているER図（論理）です。
ER-D_Physical.pdf
- 上記のeccube-diagram.judeに含まれているER図（物理）です。
table_definition.xls
- よく見るタイプのエクセルでのテーブル定義書です。

EC-CUBEのテーブルに独自のカラムを追加したり、新しいテーブルを追加する場合はこれらのドキュメントに追加して管理しておくと何かと便利です。

ソースコードに同梱されていないドキュメント

実はEC-CUBEには、カスタマイズする上で指標となるドキュメントが存在しています。
これらはEC-CUBEの開発Trac( http://svn.ec-cube.net/open_trac/ )上にあります。
カスタマイズされる方はぜひ一度目を通してください。

技術情報

開発手順
（Trac上でのチケットの切り方などです。）
- EC-CUBE標準規約
  （EC-CUBEの標準コーディング規約です。）
  - EC-CUBE標準規約/リファクタリングガイドライン
    （何年か前にやったリファクタリング大会の時に使ったガイドラインですね。Pageクラスの書き方など、少し詳しい内容が記載されています。）
  - EC-CUBE標準規約/単体テストガイドライン
    （EC-CUBEのテストを書くためのガイドラインです）
  - EC-CUBE標準規約/開発効率向上のためのTips
    （EC-CUBE内でのエラーハンドリングの書き方とか、汎用的な少し詳しい内容が書かれています。）
カスタマイズと移行の手引（v2.0）
（1.3系から2.0系にバージョンアップされた時に記述された物ですが、現在のバージョンにも該当します。カスタマイズする際に、どこにどういうファイルを作ってコードを書けば良いかなど記載されています。）
テストデータ生成スクリプト(v2.0)
（商品データ等のテスト用のダミーデータ生成スクリプトです。）
ロードマップ
（EC-CUBEのロードマップです）
コミットログML
（コミットログのMLへの参加登録ページです）
リリースノート
（各バージョンのリリースノートです。）
EC-CUBE2.4系と2.11.1の定数比較表（株式会社Reaps-Factory.様）
- attachment:EC-CUBE_定数名比較表.xls ダウンロード
  （2.4系と2.11.1の定数を比較した物です。最新版では多少ズレがありますが、大体一緒です）
EC-CUBE運用マニュアル(株式会社サイバーウィル様）
（プラチナパートナーであるサイバーウィルさんが作成された運用マニュアルです。非常にありがたい...）
プラグイン関連情報
（EC-CUBEのプラグインを開発する時に役立つドキュメント類です。）
API関連情報
（現状ではAPI関連のチケットへのリンクが貼られているだけですが、リンク先のチケットのコメントでAPIに関する基本的な事が記述されています。）

増えましたねー。
昔はこんな便利なドキュメントありませんでした...皆自分たちで一所懸命作っていました。

あと、EC-CUBEは専門の書籍が何冊か出版されています。
これらの書籍も役に立つと思いますが、本によっては内容が古くてあまり使い物にならない事が多いので注意が必要です。
以下に比較的最近の本を挙げておきます。これらの本も一部内容が古くて最新版のEC-CUBEではそのまま適用できない点があるので注意してください。