この文書は仕様書の書き方からプログラム設計の基本指針、ユーザインタフェースを通した画面の構成に至る共通ポリシーについて解説します。プロジェクトに参加する全てのメンバーは基本原則を理解し、ポリシーに準拠していく必要があります。

基本方針

文字コードと改行コード

次に示すリソースは全て文字コードを UTF-8 (BOM なし)、改行コードを LFに統一すること。設定ミスを防ぐため、あらかじめエディタの設定を変更しておくことを推奨する。

ファイルとディレクトリ

ファイル拡張子

サイト内で利用する各リソースファイルは下表に示す拡張子を用いること。

ファイルタイプ 期待する拡張子
画像 JPEG *.jpg
GIF *.gif
PNG *.png
ファビコン *.ico
PHP YAML *.yml
  YAML (デフォルトファイル) *.yml.default
  関数ファイル *.php
  クラスファイル *.class.php
  インタフェースクラス *.iface.php
HTML テンプレート *.tpl
JavaScript *.js
CSS *.css
Flash *.swf
各種ログファイル *.log

表記規則

ここでの「表記規則」は、各種仕様書やアプリケーションの HTML テンプレートに共通して挙げられる喚起事項を示す。

リポジトリ管理