沼津高専 電子制御工学科
MIRS ドキュメント作成規定
MIRSDBMD-DOCS-3001
改訂記録
版数 作成日 作成者 承認 改訂内容
A01 2001.10.30 大原 大原 初版
A02 2004.6.1 牛丸 牛丸 2版
A03 2005.4.22 牛丸 牛丸 作業報告入力の項目を追加
A04 2007.5.1 江上 江上 作業記録の登録の項目を改訂
A05 2008.5.29 江上 江上 ファイルの種類を改訂

目次

  1. はじめに
  2. ドキュメント作成の流れ
  3. ドキュメントの記載内容
  4. ドキュメント番号の採番権
  5. ドキュメントの承認
  6. ドキュメント作成上の注意
    1. ドキュメントに記載されなければならない必須事項
    2. ドキュメントのファイル構成
    3. ドキュメント内のハイパーリンクについて
    4. ファイルの種類
    5. その他の規定
  7. ドキュメントのフォーマット
  8. 各部品等の名前

1.はじめに

このドキュメントは沼津高専電子制御工学科のMIRSカリキュラムにおけるドキュメント作成方法について規定する。ここで言うドキュメントは主にファイルの形の電子ドキュメントをさす。

ドキュメント作成時に必要な規定はMIRSドキュメント管理規定と重なっても記す。

2.ドキュメント作成の流れ

ドキュメントの作成は以下のような流れに基づいて行われる。

3.ドキュメントの記載内容

ドキュメント台帳には下記の内容が記載される。
ドキュメントには下記の内容が記載される。

4.ドキュメント番号の採番権

その台帳内に登録されるドキュメントを作成する者には等しく採番権がある。

となる。
番号の取得は、電子メール等で台帳管理者に申し出て番号の交付を受ける。

5.ドキュメントの承認

基本的に各部門のドキュメントマネージャがドキュメントの承認をおこなう。 設計書や仕様書など大事なものは担当教員の承認をもらう。 また、標準MIRSの台帳に載せるものはすべて最初に教員の承認をもらわなければならない。A版からB版など、版数のアルファベット部分が変わるときも教員に見せる。

6.ドキュメント作成上の注意

  1. ドキュメントに記載されなければならない必須事項

  2. ドキュメントのファイル構成

    1つのドキュメントは1つのHTML形式ファイルで構成しなければならない。台帳管理者にドキュメント登録を依頼する時には図等のファイルも同時に添付すること。台帳管理者は図等のファイルを同一ディレクトリに置く。

  3. ドキュメント内のハイパーリンクについて

  4. ファイルの種類

    原則として以下の11種類の登録を認める。
  5. その他の規定

7.ドキュメントのフォーマット

原則として、以下の5種類の形式とする。
  1. 資料形式(教育資料,技術資料,会議資料,議事録 etc.)
  2. 仕様書形式(設計書,試験仕様書,ROMデータ書き込み手順書,ソフトウェアインストール仕様書 etc.)
  3. 図面形式組立図,加工図,ケーブル作成図 etc.)
  4. データ形式(ソフトウェア,CAMデータ,PLDデータ etc.)
  5. 作業記録形式(作業記録 etc.)

8.各部品等の名前

原則として以下のようにする

・バックプレーン

・FPGAモジュール

9.作業記録の登録

作業記録の記入および登録は次のように行なう。
  1.    http://www2.denshi.numazu-ct.ac.jp/mirsdoc2/mirsxxyy/cgi-bin/record/index.cgi
    より、各自で作業登録のための新規登録を行なう。(mirsxxyy の xxyy はチーム名に置き換える。)

  2. 作業報告書は、原則として毎回の作業の最後に記入する。

  3. 作業報告書は管理台帳からリンクする。 リンクのURLは、以下のようにする。

         http://www2.denshi.numazu-ct.ac.jp/mirsdoc2/mirsxxyy/
                      cgi-bin/record/index.cgi?mode=view&vName=user_name
    


関連文書