Clever Geek Handbook

ESPDの経隓

はじめに



このテキストの䞻なタスクは、Unified Program Documentation SystemUPRPずは䜕か、これらの暙準を実際に適甚する方法を説明するこずです。 たず、どのような暙準が存圚するかに぀いおの話から始め、各CESD暙準を個別に適甚する経隓で終わりたす。



か぀お、私がプログラマヌずしお働き始めたずき、「プログラムのドキュメントを曞いおください」ずよく耳にしたした。 私はすべおを正盎に説明し、ボスに枡した埌、黒魔術のセッションが始たりたした。 しばらくしお、䞊叞から電話がかかっおきお、はっきりしない音を぀ぶやき始め、私の「最高の」テキストの印刷物をしわにし、目を走らせたした。 圌の䜎音の䞀般的な意味は、それが「間違っおいる」、「間違っおいる」、「他人がそれをどうするかを芋る」ずいうこずでした。 他の答えを出すこずは䞍可胜だったので、私は「他の人」に文曞の䟋を求めたした。 原則ずしお、これらはおかしい人でした、スピヌチの意味は「ここに䟋がありたす」、「䞀般に、GOSTによるず」ず「誰もこれを必芁ずしたせん」でした。 それで、プログラマヌがひどいGOSTに觊れるこずができるこずを初めお知りたした。

私の同僚である非垞に愚かなプログラマヌの䞭には、GOSTを違ったやり方で扱う人がいなかったのは驚くべきこずです。 それらを知っおいお、䞀芋、文曞を䜜成する方法さえ知っおいた少数の人々でさえ、それらを軜corn的に正匏に扱いたした。 開発の管理責任者でさえ、GOSTが必芁な理由ず適甚方法を理解しおいない状況は、倚くの䌁業で垞に芋られたす。 はい、「プログラムの説明」が「アプリケヌションの説明」ずどのように異なるかを理解しおいる䌁業がありたしたが、明らかに少数掟でした。 むンタヌネットは䞀般に、プログラマヌ向けのGOSTは明確な痕跡であり、圌らの䞋で「曲がる」堎合にのみ必芁であるずいう芳点によっお支配されおいたす。 ドラフト蚭蚈は、「顧客から䜙分なお金を匕き離す比范的正盎な方法」ず芋なされたす。 比范的最近-囜内の仕様に合わせお研ぎ柄たされた芁件管理システムを開発する過皋で、それを掘り䞋げお敎理する必芁がありたした。 もちろん、「GOSTに埓っお」生成されるドキュメント。



ここでは、囜内䌁業、特に研究機関でプログラマヌが察凊しなければならない1぀のトピック、ESPD暙準セットに焊点を圓おたいず思いたす。 私は自分自身を統䞀道路亀通政策の偉倧な鑑識家ずは考えおいたせん-䜕十幎もそれに取り組んできた人々がいたす。圌らはきっず私を正しおくれるでしょう。 この蚘事はむしろ、写真を撮ろうずしおいる人たちのために、「ロヌドマップ」の茪郭を抂説しようずしおいたす。



基準



存圚する暙準を簡単に芋おみたしょうITに焊点を圓おたす。

  1. 囜際。 特城的な機胜-囜際組織で採甚されおいたす。 そのような組織の䟋は、ISO囜際暙準化機構です。 暙準の䟋ISO 2382-121988呚蟺機噚。 ISOず囜際電気暙準䌚議IEC、ロシア語-IECの共同芏栌が䞀般的です。たずえば、ISO / IEC 122072008゜フトりェアラむフサむクル。
  2. リヌゞョナル。 特城的な機胜-地域暙準化委員䌚によっお採甚されたした。 たずえば、倚くの゜ビ゚トGOSTは珟圚、地域暙準です。 旧゜ビ゚ト共和囜の䞀郚を含む州間䌚議で採択されたした。 このアドバむスにより、新しい暙準が採甚され、GOSTの指定も受けたす。 䟋GOST 12.4.240-2013;
  3. 公共団䜓の基準; たずえば、同じIECIEC 60255;
  4. 囜家暙準。 ロシアの堎合、このような基準の先頭にあるのは「GOST R」です。 次の3぀のタむプがありたす。

    1. 囜際たたは地域の正確なコピヌ。 「自蚘」囜立、独立しお曞かれたず芋分けが぀かないこずを瀺す。
    2. 远加された囜際たたは地域のコピヌ。 それらは、基瀎ずなる囜際暗号の囜内暙準を暗号に远加するこずで瀺されたす。 䟋GOST R ISO / IEC 12207;
    3. 実際、囜家暙準。 たずえば、GOST R 34.11-94。






各レベルおよび各組織の衚蚘法は異なりたす。それぞれの堎合、個別に理解する必芁がありたす。 誰の基準が目の前にあるのかをすばやく理解するには、 チヌトシヌトを䜿甚できたす。



ゎスト



そのため、暙準は囜際、州間地域、および囜家です。 わかったように、GOSTは地域の暙準です。 私の意芋では、GOSTにはかなり耇雑な衚蚘法がありたす。 これはGOST R 1.5-2004に完党に芏定されおおり、最小限の操䜜を行いたす。 たず、GOSTの指定ずその分類を区別する必芁がありたす。 指定は、倧たかに蚀っお、暙準の䞀意の識別子です。 分類子コヌドは、暙準を芋぀けたり、それが属する専門分野を決定するのに圹立぀補助コヌドです。 倚くの分類子が存圚する可胜性がありたすが、䞻に2぀が䜿甚されたす。KGS状態暙準の分類子ずその埌継ACS暙準の党ロシア分類子です。 䟋「GOST R 50628-2000」は芏栌の指定であり、指定は2000幎に採甚されたこずのみを理解しおいたす。 ACSのコヌド「33.100; 35.160」がありたす。 「33」-セクション「通信、オヌディオ、ビデオ」、「100」-サブセクション「電磁環境適合性」。 ただし、分類噚35.160ブランチにも属したす。 「35」-「情報技術。 オフィスマシン」、「160」-「マむクロプロセッサシステム....」。 たた、CSCによるず、コヌド「E02」は「E」-「電子工孊、無線電子通信」、「0」-「電子工孊、無線電子通信に関する䞀般芏則および芏範」などを意味したす。



暙準の指定がわかっおいる堎合は、たずえばこの賢明なサむトでCGSおよびACSのコヌドを取埗できたす。

それでは、GOSTの指定に戻りたしょう。 次の2぀のオプションがありたす。

  1. 暙準ずは、䞀連の暙準を指したす。 この堎合、暙準のカテゎリのむンデックスGOST、GOST R、GOST RVなどの埌に、シリヌズコヌド、ドット、およびシリヌズ内の暙準の指定がありたす。 シリヌズ内の暙準を指定するためのルヌルは、シリヌズのルヌルによっお確立されたす。 䟋GOST RV 15.201-2000、GOST R 22.8.0-99、GOST 19.101-77;
  2. 暙準は䞀連の暙準には適甚されたせん。 次に、カテゎリのむンデックスの埌には、単に暙準のシリアル番号、ダッシュ、採甚幎が続きたす。 たずえば、GOST R 50628-2000。


そのため、非垞に単玔な堎合、GOSTの指定は、序数、ダッシュ、幎、たたはシリヌズ番号、ポむント、さらにはシリヌズに応じたものになりたす。 実際には、すべおがより耇雑ですたずえば、GOST 11326.19-79のようなものに出䌚うこずができ、11326シリヌズはたったくありたせんが、プログラマヌはこれをほずんど必芁ずしたせん。詳现に぀いおは、GOST R 1.5-2004を参照しおください。



ESPD



ESPDはそのような䞀連のGOSTの1぀であり、19番です。 統䞀道路茞送芏制に関連するすべおの芏栌は、接頭蟞「19.」で始たりたす䟋GOST 19.106-78。 これは、「統合゜フトりェアドキュメントシステム」の略です。 他のシリヌズがありたす

  • GOST ESKD蚭蚈文曞甚の統䞀システム、接頭蟞「2.」;
  • GOST ESTD技術文曞の統䞀システム、接頭蟞「3」;
  • GOST R、補品の開発および補品化のためのシステム、プレフィックス「15」。
  • GOST RV、軍備および軍事機噚。 開発および補品の生産システム、プレフィックス「15」。
  • GOST、ACSの技術文曞システム、プレフィックス「24」。
  • GOST、自動システムの暙準セット、プレフィックス「34」。


そのため、ESPDには、゜フトりェア開発で䜿甚される䞀連の暙準が含たれおいたす。 さらに、ビゞネス芏制統䞀フレヌムワヌクの各暙準に぀いお、非自明なケヌスに぀いお簡単な説明ず説明が䞎えられおいたす。



19.001-77。 䞀般芏定


ESPDシリヌズの指定基準の割り圓おに関する芏則に぀いお説明したす。 実際の生掻では必芁ありたせん。



19.102-80。 アルゎリズムずプログラムのスキヌム。 実行のルヌル。


アルゎリズムを構築および蚭蚈するための芏則に぀いお説明したす。 19.103の衚蚘を䜿甚したす。 私の実践で必芁だったのは、アルゎリズムスキヌムが必芁であるずいう認定詊隓所が正匏に䌑んだずきだけでした。 私の芳点からするず、叀兞的な2本足のフロヌチャヌトは過去のものであり、倚かれ少なかれ適切なたただったのは、著者がプレれンテヌションのアルゎリズムに読者の泚意を集䞭させたい堎合だけです。



19.003-80。 アルゎリズムずプログラムのスキヌム。 グラフィック衚蚘


フロヌチャヌトの芁玠の蚱可されたタむプのグラフィック指定が䞎えられたす。 フロヌチャヌトを䜿甚する堎合に圹立ちたす。



19.004-80。 甚語ず定矩。


乏しい甚語集。 興味深いから-プログラムず運甚文曞の正匏な定矩が含たれおいたす。



19.005-85。 アルゎリズムずプログラムのPスキヌム


ほずんど忘れられた蚀語。 か぀お、P回路はロケットおよび宇宙産業で広く䜿甚され、打ち䞊げ制埡プログラムおよび打ち䞊げシミュレヌションを䜜成するための事実䞊の暙準になりたした。 しかし、珟圚この蚀語は完党に忘れられおいたす。 私の仕事では、P回路に出䌚ったこずがありたせん。 ブロック線図よりも倧きな利点がありたすが、コンパクトであり、非線圢アルゎリズムC ++のクラスなどやデヌタ構造を芖芚化するのに適しおいたす。 同時に、むンタヌネット䞊にはそれらに関する情報は事実䞊ありたせん。 このサむトずこのサむトは私にずっお有甚だず思われたした。 いずれにせよ、アルゎリズムの図をプログラムのドキュメントに挿入する必芁がある堎合、ブロックスキヌムではなくPスキヌムを遞択したす。



19.101-77。 プログラムずプログラム文曞の皮類


ドキュメントの皮類ずそのコヌドの察応衚、およびドキュメントの皮類を運甚ず゜フトりェアに分割する衚が含たれおいたす。 耇合およびコンポヌネントの抂念が導入されおいたす。 これ以䞊䟿利なものはありたせん。



19.102-77。 開発段階


文曞の皮類を説明し、プログラム文曞の皮類のコヌドを提䟛する重芁で必芁な暙準。 この暙準19.103-77ずずもには、ABVG.10473-01 32 01-1などの文曞の指定を「解明」するための鍵の1぀です。

この芏栌は、耇合䜓ずコンポヌネントの抂念を導入しおいたす倚くの䌁業は、関連のない゜フトりェア芁玠に関しおは3番目のタむプを远加したす。

開発のどの段階でどのドキュメントが実行されるかを瀺す衚4を泚意深く参照する必芁がありたす。 開発段階は通垞、蚭蚈および開発䜜業の実装に関する暙準で芏制されおおり、各段階で顧客に提瀺する必芁があるドキュメントも瀺しおいたす。



19.102-77。 開発段階


私の蚘憶では、この暙準は適甚されたこずはありたせん。誰がどの段階で䜕をし、どのレポヌトをTTZに曞くか、GOSTを参照し、より明確に蚘述されおいたすたずえば、GOST RV 15.203。 同時に、初心者にずっおは、OCDの䞻芁な段階での簡朔な䜜業の抂芁が含たれおいたす。



19.103-77。 プログラムおよびプログラム文曞の指定


䞻に䞊蚘のような文曞の指定の読み方を孊ぶために必芁です。 ただし、衚蚘䜓系を理解するこずは、暙準的な䜜業の範囲を超える必芁がある堎合に圹立ちたす。たずえば、コヌドが90以降のドキュメントはナヌザヌ定矩、぀たり どれでも。 私の実践では、「プログラム文曞の声明」ず呌ばれる文曞93、96文曞-「アセンブリ呜什」を発行したした。

䞀般的なフレヌズ「実行オプション」は統䞀道路茞送システムには存圚せず、「改蚂番号」に眮き換えられたす。 䞀方で、これは完党に正しいわけではありたせん。線集番号は、プログラムの進化を远跡するために考案されたした。最初に最初の版が出お、次に、䟋えば改良埌、2番目になりたす。 しかし実際には、耇数のオペレヌティングシステムクロスプラットフォヌム゜フトりェアの゜フトりェアバヌゞョンをリリヌスする必芁がある堎合、他の方法はありたせん。 より正確には、ありたすが、それは間違っおいたす各OSにバヌゞョンを割り圓お、独自の指定を行い、OSの数に応じおアヌカむブに゜ヌスコヌドを含む耇数のディスクを入れ、ドキュメントセット党䜓を開発実際にコピヌしたす。 たったくばかげた混乱を招く掻動。 独自のリビゞョン番号の各OSにバヌゞョンを割り圓おるずいう圢の決定により、ドキュメントの䞀郚を共通にするこずができたす。

ESPDは倚くのプログラマの恥ずかしさを利甚しお、プログラムの゜ヌスコヌドずアセンブリ結果を「ドキュメント」で瀺したす。 ドキュメント「プログラムテキスト」は、19.101-77に埓っお、12の指定を持っおいたす。さらに、゜ヌスコヌドが12 01ずしお指定されおいるず仮定したす。 01最初のタむプ12のドキュメント、およびバむナリ-12 02ずしお-すなわち 2番目のドキュメントはタむプ12です。堎合によっおは、プログラムをビルドするために、コンパむラ、むンストヌラゞェネレヌタなどの远加のツヌルが必芁です。 ぀たり 配信に含たれおいないが、アセンブリに必芁なプログラム。 解決策は、それらを12 03ずしお指定するこずです。 タむプ12の3番目のドキュメント。



19.104-78。 䞻な碑文


ドキュメントの2枚のシヌト-承認シヌトLUずタむトルペヌゞに぀いお説明したす。 ESPDの承認シヌトには、ドキュメントを承認した圓局ず、開発者、芏範管理者、承認の代衚者などの眲名が含たれおいたす。 ぀たり 䌁業にずっお非垞に倚くの機密情報が含たれおいたす。 したがっお、暙準では、コントロヌルナニットが開発䌚瀟に留たるこずが受け入れられ、特別な指瀺によっおのみ送信されたす。 繰り返しになりたすが、LUはドキュメントの䞀郚ではありたせんが、別のドキュメントであり、仕様の別の行に入力されたす。

最初に、LUをドキュメント自䜓から分離するこずの恥ずかしい奇劙さには、非垞に正圓な理由がありたす。

  • すでに述べたように、倚くの堎合、䌚瀟は開発者に関する情報を開瀺したくない。 LU分離ずその「スクむヌゞング」により、これを行うこずができたすESKDずは異なり、ドキュメントのシヌト䞊のESPDにはスタンプがありたせん。すべおの情報はLUにのみロヌカラむズされたす。
  • 倚くの䌁業では、混合文曞管理が䜿甚されおいたす。元の文曞は䌁業のアヌカむブに電子圢匏で保存され、それらのLU元の眲名付きは玙で保存されたす。


LUの蚭蚈に関しおは、ミックスは䌁業で非垞に頻繁に䜿甚されたす。LUの碑文の䞀郚は、統䞀状態暙準に埓っお䜜成され、䞀郚はESKDに埓っお䜜成され、䞀郚は独自のものに埓っお䜜成されたす。 したがっお、LUを自分で実行する前に、゚ンタヌプラむズ暙準STOを探すか、ロヌカルの芏範的制埡の䟋を䜿甚するこずをお勧めしたす。

たた、LUには番号が付けられおおらず、最初のシヌトがタむトルペヌゞであり、番号が配眮されおいる最初のシヌトがタむトルペヌゞの次であるこずに泚意しおください。 ただし、LUが耇数ある堎合すべおの眲名がシヌトに収たらない堎合に発生したす、LUには個別に番号が付けられたす。



19.105-78。 プログラム文曞の䞀般的な芁件


ドキュメントの䞀般的な構造は、実行方法に関係なく導入されたす。 ぀たり 1978幎に、文曞は必ずしも玙ではないかもしれないずいう基準で定められたした。 特に、コンテンツの抂念は、完党に電子的な文曞に導入されおいたす。 圓時の䞀般的な事務凊理では、GOST 19.106-78が採甚されたした。

珟圚、この暙準にアクセスする必芁はほずんどありたせん。ドキュメントの䞻芁郚分の順序を忘れない限り。



19.106-78。 印刷されたプログラム文曞の䞀般的な芁件


ESスキヌムの最も膚倧な暙準であり、Rスキヌムの説明のみに劣る。 これは、ドキュメントの準備における䞻芁な䜜業暙準です。 テキストのデザむン、ドキュメントの構造の芁玠、画像、匏などのルヌルを玹介したす。 ただし、ESKDの察応する2.106ずは異なり、19.106はそれほど詳现ではないため、倚くの䞍確実性が生じたす。

たず、暙準では実際に行間隔ずヘッダヌ間の垂盎むンデントの量を定矩しおいたせん。 圌は、間隔を決定するための3぀のルヌルを玹介したす。タむプラむタヌで曞かれたテキスト、機械、掻版印刷です。

入力されたテキストは入力されたテキストです。 前の行に察する次の行のシフトは、いわゆる「キャリッゞ転送」で自動的に実行されたした。これは、特別なレバヌを動かすこずで次の行を印刷する遷移です。 原則ずしお、間隔は玙送りシャフトを回しお手動で調敎でき、間隔の倀を蚭定できる「蚭定」がありたす-シングルたたはダブル。

マシン-これはおそらく印刷されたテキストです。 しかし、圌にずっおは、結果がマむクロフィルムに適しおいるべきであるずいう兆候しかない。 これは、13.1.002-2003ぞの暗黙の参照であり、残念ながら、手曞き文曞に察しおのみ行間隔および、ちなみに最小フォント高さを蚭定したすセクション4.2.5。

掻版印刷-プリントショップで入力されたテキスト。 暙準の採甚幎を考えるず、おそらく私たちは話しおいる

[ 掻版印刷 、行間は䜿甚する文字によっお決定されたす。 私は印刷ビゞネスの専門家ではありたせんが、珟圚、採甚方法に関する情報はほずんどありたせん。

最終的にどの間隔を䜿甚するかは、倚くの堎合、珟地の芏制管理たたはサヌビスステヌションによっお決定されたす。 兞型的な倀は、1.5のスペヌスず14のフォントサむズです。

倚くの堎合、ドキュメントの構造に぀いお倚くの質問がありたす。 19.106は、文曞党䜓がセクション、サブセクション、パラグラフ、サブパラグラフに分割されおいるず考えおいたす。 それらのすべおセクションずサブセクションを陀くには芋出しがある堎合ずない堎合がありたす。 この堎合

  • 「文曞の内容には、芋出しのあるセクション、サブセクション、パラグラフ、サブパラグラフの数が含たれたす」パラグラフ2.1.4。 これは、サブパラグラフに芋出しがあり、目次に含たれる可胜性があるこずを盎接瀺しおいたす。
  • 「セクションずサブセクションの芋出しの間、サブセクションず段萜の芋出しの間にはテキストを配眮できたす。」 番号付けされおいないテキストは、芋出しの間にのみ、䞊䜍2レベルにのみ配眮できるこずに泚意するこずが重芁です。


ESKDずは察照的に、ESPDは図面を蚭蚈するための奇劙な方法を採甚したした。最初に図面の名前、次に図面自䜓、次にオプションの「図面テキスト」、次に新しい行に「図 N "。

この暙準には、いく぀かの「穎」、欠点がありたす。 たずえば、次のように蚀われおいたす。「このドキュメントに耇数の図がある堎合、ドキュメント党䜓でアラビア数字で番号が付けられたす。 「でも、むラストが1぀なら、番号が付けられおいないので、どうやっおそれを参照するのでしょうか テヌブルに぀いおも同様です。 脚泚の堎合、GOSTは文曞党䜓たたはペヌゞ内での番号付け方法を瀺したせん。

テヌブル。 ドキュメント自䜓はGOST 1.5.68を参照しおいたす。 最初のシリヌズから刀断するず、これは暙準の開発のための暙準であるず結論付けるのは簡単です。 そしお、圌はここにいたす、それは䞍明瞭です。 意味に関しおは、ほずんど䟋倖はありたせんが、ESKDでテヌブルをフォヌマットするためのルヌルに準拠しおいたす。 この暙準は取り消され、代わりに、テヌブル蚭蚈の芏則が消えたばかりの1.5〜2012幎の耇数の反埩の埌、眮き換えられたした。 圌らはただ1.5-2002にあり、すでに1.5-2004に姿を消した。 実生掻では、ESKDに埓っおテヌブルを蚭蚈したす。

甹途 この芏栌は、アプリケヌションの図、匏、および衚が䞀般リストに含たれるかどうかを瀺しおいたせん。 同様に、セクション、段萜などが含たれおいる堎合、アプリケヌション構造を目次に開瀺すべきかどうかに぀いおも蚀及されおいたせん。 実際には、アプリケヌションの内郚は明らかにしたせん。

最埌に、むンデントに぀いお説明する必芁がありたす。 5文字のむンデントは次の堎合に䞀般的です

  • 赀い線;
  • セクションサブセクション、パラグラフ、サブパラグラフの埌のドキュメント構造芁玠のむンデント。
  • リスト項目。


    • この堎合、むンデントされた行の埌の次の行にあるテキストは巊マヌゞンに揃えられたす。 倚くの堎合、むンデントがゞャンプするず゚ラヌが発生したす-赀い線-1぀の倀、アむテム番号-別の間隔、リスト内のネストされたむンデント-これは䞀般に必芁です。



    次のパヌトでは、ECPDの暙準のリストの最埌に到達する予定です。


More articles:


All Articles