沼津高専 電子制御工学科 |
MIRSドキュメント管理規定 |
MIRSDBMD-DOCS-2001 |
|
改訂記録 |
版数 |
作成日 |
作成者 |
承認 |
改訂内容 |
A01 |
1998.9.16 |
長澤 |
長澤 |
初版 |
目次
- はじめに
- ドキュメント管理の流れ
- ドキュメント台帳の記載内容
- ドキュメントの番号規定
- ドキュメント番号の採番権
- ドキュメントの登録権
- 版数管理規定
- ドキュメントの保管
- ドキュメント作成上の注意事項
- ドキュメントのフォーマット
- 紙のドキュメントについて
- ドキュメント管理統括者の仕事
- 台帳の管理者
- 台帳管理者の仕事
1.はじめに
このドキュメントは沼津高専電子制御工学科のMIRSカリキュラムにおけるドキュメント管理方法について規定する。ここで言うドキュメントは主にファイルの形の電子ドキュメントをさす。紙のドキュメントについても保管棚を設けできるだけ共通の管理を行う。
本管理規定はMIRS98プロジェクトより適用する。
2.ドキュメント管理の流れ
ドキュメントの管理はドキュメント台帳をもとに行われ、以下のような流れにもとづいて行われる。
- MIRS全体のドキュメント管理者の決定 <−学科会議
- 台帳の保管場所(ディレクトリ)の決定 <−ドキュメント管理統括者
- ドキュメント保管場所の決定 <−ドキュメント管理統括者
- 台帳ごとの管理者の決定 <−MIRS Staff会議
- 台帳の作成 <−台帳管理者
- 台帳が管理するドキュメント保管場所(ディレクトリ構造)の決定 <−台帳管理者
- ドキュメント番号の取得 <−ドキュメント作成者
- ドキュメントの作成 <−ドキュメント作成者
- ドキュメントの登録 <−台帳管理者
- ドキュメントの改版 <−ドキュメント作成者
- ドキュメントの改版登録 <−台帳管理者
- 改版の通知 <−台帳管理者
3.ドキュメント台帳の記載内容
ドキュメント台帳には下記の内容が記載される。
- ドキュメント名
- ドキュメント番号
- 採番日
- 採番者
- 版数
- ドキュメント作成者名
- 登録日
- 登録者
- 保管場所(ディレクトリ/ファイル名)
- 注1
- ドキュメント作成者名、登録日、登録者、保管場所は版数ごとに記載される。
- 注2
- ドキュメント管理台帳のファイル名はindex.htmlとすること。
4.ドキュメントの番号規定
ドキュメント番号は下記に示す例のように−で区切られた4つの部分からなる。
例1 |
| MIRSDBMD-EDUC-xxxx-rev | DBMD教育資料 |
| MIRSDBMD-TECH-xxxx-rev | DBMD技術資料 |
| MIRSDBMD-PRTS-xxxx-rev | DBMD標準部品 |
例2 |
| MIRSSTND-MEMO-xxxx-rev | 標準MIRS雑資料(議事録など) |
| MIRSSTND-TECH-xxxx-rev | 標準MIRS技術資料(調査報告書など) |
| MIRSSTND-DSGN-xxxx-rev | 標準MIRS設計書 |
| MIRSSTND-ASBY-xxxx-rev | 標準MIRS製造仕様書メカニクス,システム |
| MIRSSTND-ELEC-xxxx-rev | 標準MIRS製造仕様書エレクトロニクス |
| MIRSSTND-SOFT-xxxx-rev | 標準MIRS製造仕様書ソフトウェア
|
例3 |
| MIRS98XX-MEMO-xxxx-rev | 98xxチーム雑資料(議事録など) |
| MIRS98XX-TECH-xxxx-rev | 98xx技術資料(調査報告書など) |
| MIRS98XX-WORK-xxxx-rev | 98XX工程,作業関連資料 |
| MIRS98XX-DSGN-xxxx-rev | 以下同様 |
| MIRS98XX-ASBY-xxxx-rev | |
| MIRS98XX-ELEC-xxxx-rev | |
| MIRS98XX-SOFT-xxxx-rev | |
- 最上位4桁はMIRSで始まる。続く4桁は管理統括者が決定する。
- 次の−に続く4桁は台帳管理者が決定する。
- xxxxは4桁の数字で、台帳管理者がドキュメントごとに割り振る。
- revの部分には版数が入る。版数のつけ方については7に述べる。
- 例外
- ドキュメント管理台帳は最初の桁の下位4桁を次の4桁と同じものにする。たとえば、MIRS9801の台帳の番号はMIRS9801-9801-0001となる。
5.ドキュメント番号の採番権
その台帳内に登録されるドキュメントを作成する者には等しく採番権がある。
上の例では
- MIRSDBMD ->staff
- MIRSSTND ->staff
- MIRS98XX ->98XXチームの構成員
となる。
番号の取得は、電子メール等で台帳管理者に申し出て番号の交付を受ける。
6.ドキュメントの登録権
ドキュメントの登録ができるのは台帳の管理者のみである。
ドキュメントの登録を要求するものは、下記事項を添えて台帳管理者に依頼する。
- 作成者氏名
- ドキュメント番号
- ドキュメント名称
- 版数
7.版数管理規定
版数の管理は原則として以下のように行う。
- 版数は3桁
- 第1桁はアルファベット(Aから順に振る)とする。
- 第2,3桁は数値(01から順に振る)とする。
*改版により以前の版数と互換がなくなる場合、第1桁を変更する。
- ドキュメントの改版
一旦登録されたドキュメントを変更する時には必ず版数を更新しなければならない。
- 改版通知
ドキュメントが改訂されたときにはドキュメントの性質に応じて必要な者に通知されなければならない。通知先についてはMIRSスタッフ会議において決定する。下記に例を示す。
- MIRSDBMD ->staff及びMIRSカリキュラム実施中のチームマネージャとドキュメントマネージャ
- MIRSSTND ->staff及びMIRSカリキュラム実施中のチームマネージャとドキュメントマネージャ
- MIRS98XX ->98XXチームの構成員
- 例外
- 作業記録のように日々更新され、本文に更新日付が明記されるものについては、版数はA01に固定してもよい。ただし、最終更新日がドキュメントのトップ付近に記載されるように配慮すること。
8.ドキュメントの保管
ここでは主に電子ドキュメントの保管場所について規定する。紙のドキュメントについては後述する。
- revの下位2桁のみの改版の場合は原則として旧版は廃棄される。
- ドキュメント番号の各パートに対応したディレクトリを設ける。
例
mirsdoc2 | | | |
| mirsdbmd | | |
| | educ | |
| | tech | |
| | prts | |
| mirsstnd | | |
| | ... | |
| mirs98XX | | |
| | ... | |
- 1ドキュメントに1ディレクトリを設ける。
ディレクトリ名はドキュメント番号のNUM+4桁通し番号+revの最上位とする。
例 MIRSDBMD-EDUC-0001-A01の保管場所
/mirsdoc2/mirsdbmd/educ/num0001a/
- ドキュメントの保管期間
上のディレクトリ第3レベル(例えばEDUC)ごとに保管期間を設定しなければならない。保管期間は学科会議で決定する。したがって、保管ディレクトリの決定にはこの点を留意する必要がある。
- 台帳の保管は台帳が管理されるドキュメントのトップレベルに置かれる。上の例ではディレクトリMIRSDBMDに置かれる。
9.ドキュメント作成上の注意事項
ドキュメントに記載されなければならない必須事項
- ドキュメント名称
- ドキュメント番号
- 作成者
- 承認
- 作成,改版日付
- 版数
- 改版記事
ドキュメントのファイル構成
1つのドキュメントは1つのHTML形式ファイルで構成しなければならない。(台帳管理者にドキュメント登録を依頼する時には図等のファイルも同時に添付すること。台帳管理者は図等のファイルを同一ディレクトリに置く。)
ドキュメント内のハイパーリンクについて
- ドキュメント番号の無い文書(管理台帳で管理されてない文書)にリンクを張ってはならない。(但し、次項の場合を除く)
- 文書内に図を張りつける場合、同一ディレクトリに図を置き、相対リンクで参照する。
- 他のドキュメント(台帳によって管理されている文書にかぎられる)にリンクを張る場合はmirs.cgiを使ってドキュメント台帳を経由してリンクを行う。この文書の末尾を参考にすること。
10.ドキュメントのフォーマット
原則として、以下の5種類の形式とする。
- 資料形式(教育資料,技術資料,会議資料,議事録 etc.)
- 仕様書形式(設計書,試験仕様書,ROMデータ書き込み手順書,ソフトウェアインストール仕様書 etc.)
- 図面形式(組立図,加工図,ケーブル作成図 etc.)
- データ形式(ソフトウェア,CAMデータ,PLDデータ etc.)
- 作業記録形式(作業記録 etc.)
11.紙のドキュメントについて
- 保管棚を設けて保管する。
- 紙のドキュメントは台帳の保管場所の欄に保管棚の位置を記す。
- 保管棚はドキュメント番号ごとに整理される。
- 各ドキュメントには必ずトップシートを設けてドキュメントに必要な事項が記載されなければならない。
- 背表紙をつけ、ドキュメント番号を記載する。
- 複数のドキュメントを1つのファイルに閉じ込む場合は背表紙にそこに閉じ込まれるすべてのドキュメント番号が記載しなければならない。またドキュメントごとに仕切り紙を挿入し、仕切り紙にはドキュメント番号を記載したタグを貼らなければならない。
- 規格表などは背表紙にドキュメント番号を記載したラベルを貼る。
- 原則として禁帯出とし、コピー等で一時的に持ち出すときは、持ち出し台帳に記入した上で棚の管理者(統括管理者)に許可を受けて持ち出す。
12.ドキュメント管理統括者の仕事
- 台帳の発行
- 台帳の保管場所の指定
- 台帳別のドキュメント保管場所の指定
- 紙のドキュメントの保管場所の提供と、閲覧管理。
13.台帳の管理者
台帳の管理は例えば下記のものが行う。
MIRSDBMD | ->DBMD統括者 |
MIRSSTND | ->標準MIRS責任者 |
MIRS98XX | ->各チームのドキュメントマネージャ |
14.台帳管理者の仕事
台帳に記されているドキュメントの管理を行う。
- 台帳の作成、管理
- ドキュメント番号の構成を決定する。
- ドキュメント保存ディレクトリの構成の決定、作成、管理を行う。
- 台帳が管理するドキュメントの作成者からの要求に応じてドキュメント番号を発行する。この際、台帳にドキュメント番号と名称(仮名称でも可)要求者の名前を記入する。
- ドキュメント作成者または承認者の要求によりドキュメントの登録を行う。登録は、以下の手順で行う。
- ドキュメントを構成するファイルをチェックし、html形式のファイルが一つであることを確認する。
- 記載要件が整っているかを確認する。(記載要件とは、日付、作成者、承認等の体裁のことである。内容の責任はない。内容の責任は作成者および承認者にある。)
- 台帳にドキュメント名称(正式名)、作成者名、版数、保管場所、ファイル名を記入する。
- 保管場所にすべてのファイルをコピーする。
mirs.cgiの使い方
- 1.CGIの場所
- http://www2.denshi.numazu-ct.ac.jp/mirsdoc2/cgi-bin/mirs.cgi
(sun,moon:/mirsdoc2/cgi-bin/mirs.cgi)
- 2.機能
- ドキュメント番号を与えると、台帳からそのURLを検索し表示する。
台帳がフォーマット通り作成されていることが前提。
- 3.ドキュメント番号の与え方
- a.版数の最初の一文字まで与える。例:mirs9801-memo-0001a
- b.ドキュメント番号を3桁まで与える。例:mirs9801-memo-0001
- 検索するドキュメントが台帳に見当たらない場合は、台帳を表示する。
- 4.使用法
- cgi名の後に?を付け、ドキュメント番号をハイフンで区切って与える。
(大文字小文字どちらでも可)。
例1:MIRS9801-SOFT-0001を検索する。
mirs.cgi?mirs9801-soft-0001
例2:MIRS9801-SOFT-0001-Aを検索する。
mirs.cgi?mirs9801-soft-0001-a