JIS C 1082-1:1999 電気技術文書―第１部：一般要求事項 | ページ 7

                                                                                             29
                                                                                  C 1082-1 : 1999
                                図31 端子接続図の例 : 制御装置
               図32 ケーブル線図の例 : 組立品+A1,+A2及び+A3のケーブル布設

――――― [JIS C 1082-1 pdf 31] ―――――

                                                                                                                                               C1
                                                                                                                                               30
                                                                                                                                                  082-
                                                                                                                                                     1: 1999
                                                 図33 部品リストの例 : ポンプシステム=W1P1

――――― [JIS C 1082-1 pdf 32] ―――――

                                                                                                                                               C1 082-
                                                                                                                                                     1:
                                               図34 機能及び位置体系図及びそれらの相互関係の例
                                                                                                                                                        199
                                                                                                                                                          3
                                                                                                                                                           9
                                                                                                                                                           1

――――― [JIS C 1082-1 pdf 33] ―――――

32
C 1082-1 : 1999

3. 文書化の原則

3.1 総論

 技術文書化は,対象の設備又はシステム全体をまとめるために必要とする。
  電気技術分野は,次の展開を示している。
− 設備又はシステムは一段と複雑化している。
− 急速な技術的進歩によって,新たな技術及び解決策が求められている。
− 利用者及びそれをとりまく社会は,ますます複雑なシステムに依存してきており,文書媒体を通じて,
    安全で,操作及び保守が容易な設備又はシステムに対する要求が増大してきている。
  これらの展開は,設備又はシステムを全体として考えたり,個々の要素を完全な設備が集合した部分と
して考えることが必要不可欠となってきた。全体像を把握するというこの考え方は,エンジニアリングの
過程及びそれを文書化する際に第一義に考えるべきである。

3.2 目的

 文書化の目的は,最も実用的な形式で情報を提供することにある。
  技術文書は,設備又はシステムの管理,調整,運用及び保守にとって基本的なものである。
  設備及びシステムの設計に安全性を完備することは,このような文書に対して新たな重要性を加えるこ
とになる。それは,その文書が正常な運転条件を規定するようになるからである。
  技術文書化は,装置類を供給する際の契約上の重要部分であり,販売後の処理の基本的な部分を構成す
る。
  この文書化では,設備の終始全局面をカバーするよう,ソフトウェアに限らずハードウェアにも必要な
情報を提供しなくてはならないが,また,次の点にも留意するのがよい。
− 設備,システム又は装置を漏れなく説明する。
− 正確でまとまりのあるものにする。
− 分かりやすくする。
− 想定の目的と合致するようにする。
− 取扱い及び保守が簡単なようにする。

3.3 文書化の体系

 規格の体系によって文書を提供することは,下請け契約をやりやすくし,保守管理
を自動化する手段を示すことである。
  設備及びシステムについての情報を,木構造 (tree structure) で基本的に組織できることはよく知られて
いる。この体系は,過程又は製品を細かい過程又は製品に区分けする方法を示している。
  文書はいずれも,このような製品,工程,半製品又は部分工程の一つを説明しなくてはならない。
  目的によっては,例えば,機能中心体系及び位置中心体系といった別の体系も認めることもできる。図
34は,このような二つの体系の関連をある程度示すものである。
  図35は,全体図がプラント全部を説明している例である。もっと詳細な全体図及び対応する回路図で,
W1と指定する冷却水の供給システムを説明しているものもある。
  図36は,三つのポンプシステム,W1=P1,W1=P2及びW1=P3のそれぞれに対して回路図が各々存
在する図面の書き方を示している。

3.4 文書作成

 技術文書化に採用する詳細な水準は,当該装置の機能の説明(例えば,回路図)及び設
計の説明(例えば,接続を示す文書)を示すものでなくてはならない。さらに,製図及び文書の表示は,
次を必要とし,実用に的を絞るものでなくてはならない。
− 説明内容,線図及び図示をはっきりさせる。
− 内容が雑にならない程度に,本文を簡潔にする。
− 品目指定の方式を用いる。これは,利用者が利用を試みる装置の各品目を素早く識別するためである。

――――― [JIS C 1082-1 pdf 34] ―――――

                                                                                             33
                                                                                  C 1082-1 : 1999
− システムの開発にそって,内容を更新する可能性。

3.5 各種文書の相互関係

 各種文書に同じ情報をよく用いていることから,各文書間に相互関係が存在
する(図37を参照)。
  一貫した文書化を達成するために,各文書間の相互関係を,文書作成の命令に準じて決定する時期を考
慮しなくてはならない。一般的な方法として,作成は全体レベルでまず開始し,続いて,全体レベルから
特定レベルへと,より詳細レベルへ展開するようにする。例をあげると,全体図,機能線図,回路図の,3
種類のレベルの線図を区別するようにする。また,機能説明文書をこのような記述説明に先立って実施す
るようにする(図38を参照)。

3.6 CAD及び文書化

 電気技術装置の設計及び文書化の多くの領域で,コンピュータの役割はますます
重要になっている。文書作成でコンピュータの利点を十分に実現するためには,一定のガイドラインを維
持していくことが重要である。
  設計データは,ファイル又はデータベースに保存されるようにするが,これは,すべての文書,そして
設備又は装置と各文書との間に一貫性を保つ方法ですすめる。
  各計算機システム間の設計データに移動が必要な場合,当初のCAD入力(エントリー)システムを用
いるなら,規定の規格データのフォーマット及びキャラクタのセットは変換過程を簡略することができる。
  設計入力(エントリー)端末は,設計検索及び文書化でますます重要な手段となっている。このような
端末の選択及び使用に当たり,利用に際しての次の特定ガイドラインを設定することで,よりよい結果を
得ることになる。
・ 端末は,記号,キャラクタ及び必要なフォーマットの適用工業規格を守る。
・ 設計入力(エントリー)システムは,データベース及び関連図形の規格フォーマットを守る。これは,
    先行きの処理に対して,設計内容を他のシステムに移せるようにするためである。
・ 最初の設計入力(エントリー)は,必要な文書化の実施に適合するよう実施する。
・ データの収集によって,再作業なしに,追加及び修正できるようにしなくてはならない。

――――― [JIS C 1082-1 pdf 35] ―――――

次のページ PDF 36