沼津高専 電子制御工学科 |
MIRS ドキュメント作成規定
|
MIRSATLM-REGU-0001 |
|
改訂記録 |
版数 |
作成日 |
作成者 |
承認 |
改訂内容 |
A01 |
2000.6.28 |
加藤 |
大原 |
初版 |
A02 |
2000.7.6 |
加藤 |
加藤 |
各部品の名前を追加 |
A03 |
2000.9.1 |
加藤 |
加藤 |
各部品の名前に電源ボードを追加 |
A04 |
2000.9.20 |
加藤 |
加藤 |
登録可能なファイルを追加 |
目次
- はじめに
- ドキュメント作成の流れ
- ドキュメントの記載内容
- ドキュメント番号の採番権
- ドキュメントの承認
- ドキュメント作成上の注意
- ドキュメントに記載されなければならない必須事項
- ドキュメントのファイル構成
- ドキュメント内のハイパーリンクについて
- ファイルの種類
- その他の規定
- ドキュメントのフォーマット
- 各部品等の名前
1.はじめに
このドキュメントは沼津高専電子制御工学科のMIRSカリキュラムにおけるドキュメント作成方法について規定する。ここで言うドキュメントは主にファイルの形の電子ドキュメントをさす。
ドキュメント作成時に必要な規定はMIRSドキュメント管理規定と重なっても記す。
2.ドキュメント作成の流れ
ドキュメントの作成は以下のような流れに基づいて行われる。
- ドキュメント番号の取得 <−ドキュメント作成者
- ドキュメントの作成 <−ドキュメント作成者
- ドキュメントの登録願 <−ドキュメント作成者
- ドキュメントの登録 <−台帳管理者
- ドキュメントの登録通知 <−台帳管理者
- ドキュメントの改版 <−ドキュメント作成者
- ドキュメントの改版登録 <−台帳管理者
- 改版の通知 <−台帳管理者
3.ドキュメントの記載内容
ドキュメント台帳には下記の内容が記載される。
- ドキュメント名称
- ドキュメント番号
- 採番日
- 採番者
- 版数
- ドキュメント作成者名
- 登録日
- 登録者
- 保管場所(ディレクトリ/ファイル名)
ドキュメントには下記の内容が記載される。
- ドキュメント名称
- ドキュメント番号
- 作成者
- 承認
- 作成,改版日付
- 版数
- 改版記事
4.ドキュメント番号の採番権
その台帳内に登録されるドキュメントを作成する者には等しく採番権がある。
例
- MIRSDBMD ->staff
- MIRSATLM ->MY2Kチームの構成員
- MIRSMY2K ->MY2Kチームの構成員
となる。
番号の取得は、電子メール等で台帳管理者に申し出て番号の交付を受ける。
5.ドキュメントの承認
基本的に各部門のドキュメントマネージャだが、設計書や仕様書など大事なものは担当教官の承認をもらう。
また、標準MIRSの台帳に載せるものはすべて最初に教官の承認をもらわなければならない。A版からB版など、版数のアルファベット部分が変わるときも教官に見せる。
6.ドキュメント作成上の注意
ドキュメントに記載されなければならない必須事項
- ドキュメント名称
- ドキュメント番号
- 作成者
- 承認
- 作成,改版日付
- 版数
- 改版記事
ドキュメントのファイル構成
1つのドキュメントは1つのHTML形式ファイルで構成しなければならない。台帳管理者にドキュメント登録を依頼する時には図等のファイルも同時に添付すること。台帳管理者は図等のファイルを同一ディレクトリに置く。
ドキュメント内のハイパーリンクについて
- 次項の場合を除くドキュメント番号の無い文書(台帳で管理されてない文書)にリンクを張ってはならない。
- 文書内に図を張りつける場合、同一ディレクトリに図を置き、相対リンクで参照する。
- 他のドキュメント(台帳によって管理されている文書のみ)にリンクを張る場合はmirs.cgiを使ってドキュメント台帳を経由してリンクを行う。cgiについてはMIRSドキュメント管理規定参照。
ファイルの種類
原則として以下の10種類の登録を認める。
- html(文書)
- jpg(画像ファイル)
- png(画像ファイル)
- ps(jpgの基図面)
- zwd(機械図面)
- sch(回路図面)
- c(C言語ソースファイル)
- h(C言語ヘッダファイル)
- tgz(UNIX圧縮ファイル)
- zip(Windows圧縮ファイル)
その他の規定
- 日付は西暦で書く。月・日が1桁の場合は0を前に入れない。また半角文字にし、年・月・日の間はピリオドを用いる。(例:○2000.4.1 ×平成12/04/01)
- 各ドキュメントに書くドキュメント番号には版数をつけない。(例:○MIRSATLM-REGU-0001 ×MIRSATLM-REGU-0001-A01)
- ドキュメントの最後には必ず関連文書(なければバーのみ)をつける。これは後につく可能性があるからである。ただし作業記録は除く。
- 設計書などページ内で多項目に分かれるものは、始めにリンク付目次を付ける。
- 関連文書に台帳を記入してはいけない。
7.ドキュメントのフォーマット
原則として、以下の5種類の形式とする。
- 資料形式(教育資料,技術資料,会議資料,議事録 etc.)
- 仕様書形式(設計書,試験仕様書,ROMデータ書き込み手順書,ソフトウェアインストール仕様書 etc.)
- 図面形式(組立図,加工図,ケーブル作成図 etc.)
- データ形式(ソフトウェア,CAMデータ,PLDデータ etc.)
- 作業記録形式(作業記録 etc.)
8.各部品等の名前
原則として以下のようにする
・バックプレーン
- CPUボード(略称 CPU)
- テンキー(略称 TEN)
- FPGAボード(略称 FPGA)
- ドーターボード(略称 DB)
- タッチセンサ(略称 TS)
- 超音波センサボード(略称 USS)
- 赤外線センサボード(略称 IRS)
- ロータリーエンコーダ(略称 RE)
- 液晶ディスプレイボード(略称 LCD)
- モータパワー制御ボード(略称 MPC)
- 電源ボード(略称 PD)
・FPGAモジュール
- アドレスデコーダ(略称 ADR_DEC)
- タッチセンサ、赤外線センサ、パワーチェック信号処理モジュール(略称 TIP_M)
- 超音波センサ信号処理モジュール(略称 USS_M)
- 割り込み処理モジュール(略称 IRQ_M)
- ロータリーエンコーダ制御モジュール(略称 RE_M)
- 液晶ディスプレイ制御モジュール(略称 LCD_M)
- モータパワー制御モジュール(略称 MPC_M)