各種モデルプロジェクトディレクトリ管理手引

  • 石渡正樹, 小高正嗣
    • 2005/06/10 (小高正嗣) 最終更新
    • 2005/04/01 (小高正嗣) deepconv 用作成

ディレクトリメンテナンス時の注意

dcmodel/ ディレクトリおよび各種モデル開発プロジェクトのディレクトリに対して作業する際には, 以下のようにすること.

  • 作業を行う際には

    $ sg (プロジェクトグループ)
$ umask 002

    とする.

  • 全てのファイルには SIGEN ファイルを作成する.
  • 何らかのツールで自動生成した HTML ファイルの拡張子は htm, 手動作 成した HTML ファイルの拡張子は html とする.
  • HTML ファイルで使用するスタイルシート, 壁紙などの HTML 用素材は dcmodel/htmltools ディレクトリに 格納されたものを使う.
  • htm ファイルを自動生成するための資源 (例えば, rd ファイルと Makefile など) は同じ場所に置く.

各種モデルプロジェクトディレクトリの構造

  • プロジェクトの公開ディレクトリの構成は以下のようにする.

    PROJCET/index.htm                     :目次ファイル(日本語)
        index.htm.en                  :目次ファイル(英語)
        shigen1/                      :製品置き場所 1   
                shigen1-YYYYMMDD      :製品その 1
                shigen1-YYYYMMDD.tgz  :製品その 1 の tgz ファイル
        shigen2/                      :製品置き場所 2  
        …
        memo/                         :作業履歴置場
        cvsroot/                      :CVS レポジトリ
        …
        その他必要なサブディレクトリ
  • shigen1, … は各プロジェクトの製品の置場所である. コードネーム毎にディレクトリを作成しても良い.
  • 全てのファイルには SIGEN ファイルを作成する.

html ファイル作成時の注意

  • トップディレクトリの目次ファイルは日本語版を index.htm, 英語版を index.htm.en とする.
  • index.htm および index.htm.en は index.rd から Makefile を用いて一括作成する.
  • index.htm.* は, スタイルシートとして dcmodel/htmltools/dcmodel.css を使う.

  • index.rd の更新日, 更新履歴はファイルのタイトル直下に以下のように記載する. 更新履歴はコメント文にしておき, HTML ファイルには表示されないようにしておく

    =begin JA
[ ((<English|URL:index.htm.en>)) | ((*日本語*)) ] 
= タイトル

* 石渡正樹, 小高正嗣
  * 2005/04/01 (石渡正樹) 最終更新 
#  * 2005/03/31 (小高正嗣) 最終更新 
#  * 2005/04/01 (小高正嗣) 最終更新 
  * 2005/03/31 (小高正嗣) 新規作成
=end JA
=begin EN
[ ((*English*)) | ((<Japanese|URL:index.htm>)) ]
= Title

* Masaki Ishiwatari, Masatsugu Odaka
  * 2005/04/01 (Masaki Ishiwatari) Update
#   * 2005/03/31 (Masatsugu Odaka) Update
#   * 2005/04/01 (Masatsugu Odaka) Update
  * 2005/03/31 (Masatsugu Odaka) Initial Release
=end EN

cvsroot/ ディレクトリ

memo/ 作業履歴ディレクトリ

  • memo/ ディレクトリには開発に関するメモの類を格納する.

  • メモファイルの名前の形式は以下の通りとする.

    YYYY-MM-DD_username_description.*
  • ファイル名の例

    • momoko が作成した個人メモは

      2005-02-14_momoko_memo.rd

    • morikawa が作成したミーティングメモは

      2005-03-14_morikawa_meeting.rd
  • PROJECT/index.htm.* などからは memo/SIGEN.htm にリンクを貼るのでも良し, PROJECT/memo/ ディレクトリ用に作成した目次ファイルにリンクを貼るのでも良い.
  • メモをメールでプロジェクトのメンバに送るには memosend.rb を使用すると良い.

計算結果公開ディレクトリ