ÈÍÔÎÑÀÉÒ.ðó
Ãîñòû, ñòàíäàðòû, íîðìàòèâû.  áèáëèîòåêå 60000 äîêóìåíòîâ. Ðåãóëÿðíîå îáíîâëåíèå. Êðóãëîñóòî÷íûé áåñïëàòíûé äîñòóï!
ÁÈÁËÈÎÒÅÊÀ ÃÎÑÒÎÂ, ÑÒÀÍÄÀÐÒÎÂ È ÍÎÐÌÀÒÈÂÎÂ

:: ÀËÃÎÒÐÅÉÄÈÍÃ ::


ÀËÃÎÒÐÅÉÄÈÍÃ
øàã çà øàãîì


ÁÅÑÏËÀÒÍÛÅ ÓÐÎÊÈ ïî ñîçäàíèþ òîðãîâûõ ðîáîòîâ íà PYTHON ñ íóëÿ, øàã çà øàãîì.


Ìèíèìàëüíûå çíàíèÿ íà PYTHON.
Áèáëèîòåêè BackTrader è Pandas, ñèãíàëû ñ Pine Script èç TradingView.
Ñâÿçêà ñ áðîêåðàìè, òåëåãðàì.
Ñîçäàíèå ïðîñòûõ èíòåðôåéñîâ.

 

Âñå äîêóìåíòû, ïðåäñòàâëåííûå â êàòàëîãå, íå ÿâëÿþòñÿ èõ îôèöèàëüíûì èçäàíèåì è ïðåäíàçíà÷åíû èñêëþ÷èòåëüíî äëÿ îçíàêîìèòåëüíûõ öåëåé. Ýëåêòðîííûå êîïèè ýòèõ äîêóìåíòîâ ìîãóò ðàñïðîñòðàíÿòüñÿ áåç âñÿêèõ îãðàíè÷åíèé. Âû ìîæåòå ðàçìåùàòü èíôîðìàöèþ ñ ýòîãî ñàéòà íà ëþáîì äðóãîì ñàéòå.


ÃÎÑÒ Ð ÈÑÎ/ÌÝÊ 15910-2002

ÃÎÑÓÄÀÐÑÒÂÅÍÍÛÉ ÑÒÀÍÄÀÐÒ ÐÎÑÑÈÉÑÊÎÉ ÔÅÄÅÐÀÖÈÈ

Èíôîðìàöèîííàÿ òåõíîëîãèÿ

ÏÐÎÖÅÑÑ ÑÎÇÄÀÍÈß
ÄÎÊÓÌÅÍÒÀÖÈÈ ÏÎËÜÇÎÂÀÒÅËß
ÏÐÎÃÐÀÌÌÍÎÃÎ ÑÐÅÄÑÒÂÀ

ÃÎÑÑÒÀÍÄÀÐÒ ÐÎÑÑÈÈ

Ìîñêâà

Ïðåäèñëîâèå

1. ÐÀÇÐÀÁÎÒÀÍ È ÂÍÅÑÅÍ Âñåðîññèéñêèì íàó÷íî-èññëåäîâàòåëüñêèì èíñòèòóòîì ñòàíäàðòèçàöèè (ÂÍÈÈñòàíäàðò) Ãîññòàíäàðòà Ðîññèè

2. ÏÐÈÍßÒ È ÂÂÅÄÅÍ Â ÄÅÉÑÒÂÈÅ Ïîñòàíîâëåíèåì Ãîññòàíäàðòà Ðîññèè îò 25 èþíÿ 2002 ã. ¹ 249-ñò

3. Íàñòîÿùèé ñòàíäàðò ñîäåðæèò ïîëíûé àóòåíòè÷íûé òåêñò ìåæäóíàðîäíîãî ñòàíäàðòà ÈÑÎ/ÌÝÊ 15910-99 «Èíôîðìàöèîííàÿ òåõíîëîãèÿ. Ïðîöåññ ñîçäàíèÿ äîêóìåíòàöèè ïîëüçîâàòåëÿ ïðîãðàììíîãî ñðåäñòâà»

4. ÂÂÅÄÅÍ ÂÏÅÐÂÛÅ

ÑÎÄÅÐÆÀÍÈÅ

1. Îáëàñòü ïðèìåíåíèÿ. 3

2. Ñîîòâåòñòâèå. 3

3. Íîðìàòèâíûå ññûëêè. 3

4. Îïðåäåëåíèÿ. 4

5. Óïðàâëåíèå êà÷åñòâîì.. 7

6. Àäàïòàöèÿ. 7

7. Öåëè. 7

8. Òðåáîâàíèÿ. 7

8.1 Ïðîöåññ äîêóìåíòèðîâàíèÿ. 7

8.2 Ñîäåðæàíèå ñïåöèôèêàöèè ñòèëÿ. 15

Ïðèëîæåíèå À. Ïåðåêðåñòíûå ññûëêè ñ ÃÎÑÒ Ð ÈÑÎ/ÌÝÊ 12207. 22

Ïðèëîæåíèå Â. Èñïîëüçîâàíèå íàñòîÿùåãî ñòàíäàðòà â äîãîâîðå. 23

Â.1 Îáùèå ïîëîæåíèÿ. 23

Â.2 Îáðàçåö ðàçäåëà äîãîâîðà. 23

Â.3 Ïðàêòè÷åñêîå ïðèìåíåíèå íàñòîÿùåãî ñòàíäàðòà. 23

Ïðèëîæåíèå Ñ. Îáðàçåö ïëàíà äîêóìåíòèðîâàíèÿ. Äîêóìåíòàöèÿ ïîëüçîâàòåëÿ äëÿ ñèñòåìû ABC - àäìèíèñòðàòèâíîãî óïðàâëåíèÿ ìàãíèòíûìè ëåíòàìè. 23

Ñ.1 Ââåäåíèå. 23

Ñ.2 Îáëàñòü ïðèìåíåíèÿ è îãðàíè÷åíèÿ. 24

Ñ.3 Îôîðìëåíèå è ñòèëü îïèñàíèÿ. 24

Ñ.4 Àóäèòîðèÿ. 24

Ñ.5 Ïðîåêò ñîäåðæàíèÿ äîêóìåíòàöèè. 24

Ñ.6 Íîìåíêëàòóðà ïîñòàâêè. 25

Ñ.7 Àâòîðñêèå ïðàâà. 25

Ñ.8 Òðàíñïîðòèðîâàíèå. 25

Ñ.9 Ïðîöåññ ðàçðàáîòêè è êîíòðîëü. 25

Ñ.10 Òèðàæèðîâàíèå. 25

Ñ.11 Ïðîåêòàíòû.. 25

Ñ.12 Ðåñóðñû.. 26

Ñ.13 Òåñòèðîâàíèå íà ïðàêòè÷íîñòü. 26

Ñ.14 Ãðàôèê ðàáîò. 26

Ïðèëîæåíèå D. Îòíîøåíèÿ ìåæäó àóäèòîðèÿìè, âûäàííûìè çàäàíèÿìè, áóìàæíîé è äèàëîãîâîé äîêóìåíòàöèåé. 27

Ïðèëîæåíèå Å. Ðåêîìåíäàöèè ïî íàïèñàíèþ íà àíãëèéñêîì ÿçûêå äîêóìåíòàöèè, ïîäëåæàùåé ïîñëåäóþùåìó ïåðåâîäó. 29

Å.1 Îáùèå ïîëîæåíèÿ. 29

Å.2 Òåðìèíîëîãèÿ. 30

Å.3 Ñòèëü ïåðåâîäà. 30

Å.4 Ôèçè÷åñêèå ôàêòîðû.. 31

Å.5 Äèàëîãîâàÿ èíôîðìàöèÿ. 31

Å.6 Êóëüòóðíûå ôàêòîðû.. 31

Ïðèëîæåíèå F. Îöåíêà ïðîåêòà. 32

F.1 Îáùèå ïîëîæåíèÿ. 32

F.2 Ïîìèíóòíûé è ïî÷àñîâîé ìåòîäû.. 32

F.3 Ìåòîä íèñõîäÿùåãî ïðîåêòèðîâàíèÿ. 33

Ïðèëîæåíèå G. Îöåíêà ïëàíà äîêóìåíòèðîâàíèÿ. 34

Ïðèëîæåíèå Í. Îáðàçåö ñïåöèôèêàöèè ñòèëÿ. 35

Í.1 Îáùèå ïîëîæåíèÿ. 35

Í.2 Ýëåìåíòû ñòèëÿ. 35

Í.3 Ñïåöèôèêàöèÿ óêàçàòåëÿ. 38

Áèáëèîãðàôèÿ. 39

Òåìàòè÷åñêèé óêàçàòåëü. 40

Ââåäåíèå

Ñóùåñòâóþùèå ñòàíäàðòû ìîæíî îòíåñòè ê äâóì îñíîâíûì òèïàì:

a) ñòàíäàðòû íà ïðîäóêöèþ, îïðåäåëÿþùèå åå õàðàêòåðèñòèêè è òðåáîâàíèÿ ê íåé;

b) ñòàíäàðòû íà ïðîöåññû, îïðåäåëÿþùèå êîíêðåòíûå ìåòîäû ñîçäàíèÿ ïðîäóêöèè.

Âîçðàñòàþùèé ìàñøòàá ïðèìåíåíèÿ ïðîãðàììíûõ ñðåäñòâ è èõ ñëîæíîñòü âûçûâàåò íåîáõîäèìîñòü íàëè÷èÿ ïîëíîé, òî÷íîé è ïîíÿòíîé äîêóìåíòàöèè íà ýòè ñðåäñòâà, äîñòóïíîé ïîëüçîâàòåëÿì. Íàñòîÿùèé ñòàíäàðò îïðåäåëÿåò ñïîñîá äîñòèæåíèÿ äàííîé öåëè, óñòàíàâëèâàÿ ðàáîòû (÷òî äîëæíî áûòü ñäåëàíî è èñïîëíèòåëÿ), ñâÿçàííûå ñ êà÷åñòâîì äîêóìåíòàöèè ïîëüçîâàòåëÿ ïðîãðàììíûõ ñðåäñòâ.

Äîêóìåíòàöèÿ ÷àñòî ðàññìàòðèâàåò íå÷òî, ðàçðàáàòûâàåìîå ïîñëå ñîçäàíèÿ êîíêðåòíîãî ïðîãðàììíîãî ñðåäñòâà. Îäíàêî ñ òî÷êè çðåíèÿ êà÷åñòâà ðàçðàáîòêè ïðîãðàììíîé äîêóìåíòàöèè îíà äîëæíà ðàññìàòðèâàòüñÿ êàê íåîòúåìëåìàÿ ÷àñòü ïðîöåññà ñîçäàíèÿ äàííîãî ïðîãðàììíîãî ñðåäñòâà. Ïðè íàäëåæàùåì ïîäõîäå ê äàííîé ïðîáëåìå òðåáóåòñÿ äîñòàòî÷íî ñëîæíàÿ ðàáîòà ïî ïëàíèðîâàíèþ äîêóìåíòèðîâàíèÿ. Öåëüþ íàñòîÿùåãî ñòàíäàðòà ÿâëÿåòñÿ ñòèìóëèðîâàíèå ðàçðàáîò÷èêîâ ïðîãðàììíûõ ñðåäñòâ ê íàäëåæàùåìó èñïîëüçîâàíèþ ïðîöåññà äîêóìåíòèðîâàíèÿ. Ñòàíäàðò òàêæå ïðåäñòàâëÿåò ïîëüçîâàòåëÿì ìåòîä îïðåäåëåíèÿ íàäëåæàùåãî ïðèìåíåíèÿ ïðîöåññà äîêóìåíòèðîâàíèÿ ïðè ñîçäàíèè êîíêðåòíîãî ïðîãðàììíîãî ñðåäñòâà.

Îñíîâíîé ðàáîòîé ïî íàñòîÿùåìó ñòàíäàðòó ÿâëÿåòñÿ ñîçäàíèå êîìïëåêñíîãî ïëàíà ðàçðàáîòêè äîêóìåíòàöèè, ðåàëèçàöèÿ êîòîðîãî îáåñïå÷èâàåò ëó÷øåå äîêóìåíòèðîâàíèå ïðîãðàììíîãî ñðåäñòâà. Äëÿ ñîîòâåòñòâèÿ íàñòîÿùåìó ñòàíäàðòó äàííûé ïëàí äîëæåí âêëþ÷àòü â ñåáÿ òðåáîâàíèÿ (ñïåöèôèêàöèþ) ê ñòèëþ îôîðìëåíèÿ äîêóìåíòîâ. Íàñòîÿùèé ñòàíäàðò íå îïðåäåëÿåò ñîñòàâ äàííûõ òðåáîâàíèé (òî åñòü êîìïîíîâêó êîíêðåòíîãî äîêóìåíòà èëè èñïîëüçóåìûé øðèôò), íî óñòàíàâëèâàåò èõ äèàïàçîí. Ñòàíäàðò òàêæå îïðåäåëÿåò âèäû èíôîðìàöèè, ïðåäñòàâëÿåìîé çàêàç÷èêîì ðàçðàáîò÷èêó äîêóìåíòàöèè (äîêóìåíòàòîðó) äëÿ ïðîâåðÿþùèõ è ðàñïðîñòðàíÿþùèõ äîêóìåíòàöèþ.

Áîëåå ïîäðîáíàÿ èíôîðìàöèÿ ïî äàííîìó âîïðîñó ïðèâåäåíà â áèáëèîãðàôèè.

Ïðèìå÷àíèÿ

1. Îñíîâíîé ñòàíäàðò äîïîëíåí ñïðàâî÷íûìè ïðèëîæåíèÿìè, áèáëèîãðàôèåé è òåìàòè÷åñêèì óêàçàòåëåì.

2. Èñõîäíûé ñòàíäàðò ÈÑÎ/ÌÝÊ 15910 ðàçðàáîòàí íà îñíîâå àâñòðàëèéñêîãî ñòàíäàðòà AS 4258:1994.

3. Ïåðå÷åíü äîïîëíèòåëüíûõ ïóáëèêàöèé, ñâÿçàííûõ ñ òåìàòèêîé íàñòîÿùåãî ñòàíäàðòà, ïðèâåäåí â áèáëèîãðàôèè (ñì. [1] - [21]).

ÃÎÑÒ Ð ÈÑÎ/ÌÝÊ 15910-2002

ÃÎÑÓÄÀÐÑÒÂÅÍÍÛÉ ÑÒÀÍÄÀÐÒ ÐÎÑÑÈÉÑÊÎÉ ÔÅÄÅÐÀÖÈÈ

Èíôîðìàöèîííàÿ òåõíîëîãèÿ

ÏÐÎÖÅÑÑ ÑÎÇÄÀÍÈß ÄÎÊÓÌÅÍÒÀÖÈÈ ÏÎËÜÇÎÂÀÒÅËß ÏÐÎÃÐÀÌÌÍÎÃÎ ÑÐÅÄÑÒÂÀ

Information technology. Software user documentation process

Äàòà ââåäåíèÿ 2003-07-01

1. Îáëàñòü ïðèìåíåíèÿ

Íàñòîÿùèé ñòàíäàðò îïðåäåëÿåò ìèíèìàëüíî íåîáõîäèìûé ïðîöåññ ñîçäàíèÿ äîêóìåíòàöèè ïîëüçîâàòåëÿ âñåõ âèäîâ äëÿ ïðîãðàììíîãî ñðåäñòâà, èìåþùåãî èíòåðôåéñ ïîëüçîâàòåëÿ. Äàííûå âèäû îõâàòûâàþò ïå÷àòíóþ äîêóìåíòàöèþ (íàïðèìåð, ðóêîâîäñòâà ïîëüçîâàòåëÿ è êðàòêèå ñïðàâî÷íûå êàðòû), äèàëîãîâóþ (îïåðàòèâíóþ) äîêóìåíòàöèþ, ñïðàâî÷íûé òåêñò («õåëïû») è ñèñòåìû äèàëîãîâîé äîêóìåíòàöèè.

Ñòàíäàðò ñîîòâåòñòâóåò òðåáîâàíèÿì 6.1 ÃÎÑÒ Ð ÈÑÎ/ÌÝÊ 12207.

Ïðèìåíåíèå íàñòîÿùåãî ñòàíäàðòà äîëæíî îáåñïå÷èòü ðàçðàáîòêó äîêóìåíòàöèè, óäîâëåòâîðÿþùåé ïîòðåáíîñòÿì ïîëüçîâàòåëÿ.

Ñòàíäàðò ïðåäíàçíà÷åí äëÿ ðàçðàáîò÷èêîâ è ïîòðåáèòåëåé äîêóìåíòàöèè ïîëüçîâàòåëÿ.

Íàñòîÿùèé ñòàíäàðò èñïîëüçóåòñÿ äëÿ ïå÷àòíîé äîêóìåíòàöèè, à òàêæå äëÿ ñïðàâî÷íûõ ýêðàíîâ, ñïðàâî÷íîé ñèñòåìû îáåñïå÷åíèÿ ïîñòàâêè, ñïðàâî÷íîé èíôîðìàöèè è ò.ä.

Ñòàíäàðò ïðåäíàçíà÷åí äëÿ ïðèìåíåíèÿ ïðè äâóñòîðîííèõ îòíîøåíèÿõ è ìîæåò áûòü èñïîëüçîâàí, åñëè îáå ñòîðîíû êîðïîðàòèâíî ñâÿçàíû. Ñòàíäàðò òàêæå ìîæåò áûòü èñïîëüçîâàí îäíîé èç ñòîðîí äëÿ ñàìîêîíòðîëÿ.

Ïðèìå÷àíèå -  ïðèëîæåíèè  ïðèâåäåíû áîëåå ïîäðîáíûå ðåêîìåíäàöèè ïî ïðèìåíåíèþ íàñòîÿùåãî ñòàíäàðòà â äîãîâîðå ìåæäó çàêàç÷èêîì è ðàçðàáîò÷èêîì äîêóìåíòàöèè.

2. Ñîîòâåòñòâèå

Ñîîòâåòñòâèå íàñòîÿùåìó ñòàíäàðòó îïðåäåëÿþò ïî ðåçóëüòàòàì äåìîíñòðàöèè âûïîëíåíèÿ ðåàëèçàöèåé ïðîöåññà, îïèñàííîãî â ðàçäåëå 8.

3. Íîðìàòèâíûå ññûëêè

 íàñòîÿùåì ñòàíäàðòå èñïîëüçîâàíû ññûëêè íà ñëåäóþùèå ñòàíäàðòû:

ÃÎÑÒ 2.301-68 Åäèíàÿ ñèñòåìà êîíñòðóêòîðñêîé äîêóìåíòàöèè. Ôîðìàòû

ÃÎÑÒ Ð ÈÑÎ 9127-94 Ñèñòåìû îáðàáîòêè èíôîðìàöèè. Äîêóìåíòàöèÿ ïîëüçîâàòåëÿ è èíôîðìàöèÿ íà óïàêîâêå äëÿ ïîòðåáèòåëüñêèõ ïðîãðàììíûõ ïàêåòîâ

ÃÎÑÒ Ð ÈÑÎ/ÌÝÊ 12119-2000 Èíôîðìàöèîííàÿ òåõíîëîãèÿ. Ïàêåòû ïðîãðàìì. Òðåáîâàíèÿ ê êà÷åñòâó è òåñòèðîâàíèå

ÃÎÑÒ Ð ÈÑÎ/ÌÝÊ 12207-99 Èíôîðìàöèîííàÿ òåõíîëîãèÿ. Ïðîöåññû æèçíåííîãî öèêëà ïðîãðàììíûõ ñðåäñòâ

ÈÑÎ 216-75* Áóìàãà ïèñ÷àÿ è êëàññû ïå÷àòíûõ ìàòåðèàëîâ. Ðàçìåðû îáðåçêè. Ñåðèè À è Â.

* Îðèãèíàë ìåæäóíàðîäíîãî ñòàíäàðòà - âî ÂÍÈÈÊÈ Ãîññòàíäàðòà Ðîññèè.

4. Îïðåäåëåíèÿ

 íàñòîÿùåì ñòàíäàðòå èñïîëüçîâàíû ñëåäóþùèå òåðìèíû ñ ñîîòâåòñòâóþùèìè îïðåäåëåíèÿìè.

4.1 À4, À5: Ðàçìåðû ñòîðîí ëèñòà 210 ´ 297 ìì è 148 ´ 210 ìì ñîîòâåòñòâåííî (ñì. ÈÑÎ 216, ÃÎÑÒ 2.301).

4.2 çàêàç÷èê (acquirer): Îðãàíèçàöèÿ, êîòîðàÿ ïðèîáðåòàåò èëè ïîëó÷àåò ñèñòåìó, ïðîãðàììíûé ïðîäóêò èëè ïðîãðàììíóþ óñëóãó îò ïîñòàâùèêà (3.1 ÃÎÑÒ Ð ÈÑÎ/ÌÝÊ 12207).

Ïðèìå÷àíèå - Çàêàç÷èêîì ìîæåò áûòü: îïòîâûé èëè ðîçíè÷íûé ïîêóïàòåëü, êëèåíò, ñîáñòâåííèê èëè ïîëüçîâàòåëü.  êîíòåêñòå íàñòîÿùåãî ñòàíäàðòà çàêàç÷èêîì ÿâëÿåòñÿ ñòîðîíà, çàïðàøèâàþùàÿ äîêóìåíòàöèþ. Îòìåòèì, ÷òî íàëè÷èå ó çàêàç÷èêà äîêóìåíòàöèè íå ÿâëÿåòñÿ îáÿçàòåëüíûì. Çàêàç÷èê è ðàçðàáîò÷èê äîêóìåíòàöèè ìîãóò áûòü ïðåäñòàâèòåëÿìè îäíîé îðãàíèçàöèè, èëè çàêàç÷èêîì ìîæåò áûòü ðàçðàáîò÷èê äàííîãî ïðîãðàììíîãî ñðåäñòâà.

4.3 àóäèòîðèÿ (audience): Êàòåãîðèÿ ïîëüçîâàòåëåé, ïðåäúÿâëÿþùèõ ê äîêóìåíòàöèè îäèíàêîâûå èëè àíàëîãè÷íûå òðåáîâàíèÿ è õàðàêòåðèñòèêè (íàïðèìåð, â ÷àñòè èñïîëüçîâàíèÿ äîêóìåíòàöèè, åå íàçíà÷åíèÿ, óðîâíÿ îáó÷åíèÿ, âîçìîæíîñòåé è îïûòà ïåðñîíàëà), îïðåäåëÿþùèå ñîäåðæàíèå, ñòðóêòóðó è íàçíà÷åíèå äàííîé äîêóìåíòàöèè.

Ïðèìå÷àíèå - Îäíà è òà æå ïðîãðàììíàÿ äîêóìåíòàöèÿ ìîæåò èñïîëüçîâàòüñÿ ðàçëè÷íûìè àóäèòîðèÿìè (íàïðèìåð, ðóêîâîäñòâîì, îïåðàòîðàìè ïî ââîäó èñõîäíûõ äàííûõ èëè ñîïðîâîäèòåëÿìè).

4.4 èçó÷åíèå àóäèòîðèè (audience research): Ïëàíèðóåìûé ïðîöåññ îïðîñà ïîòåíöèàëüíûõ ïîëüçîâàòåëåé è àíàëèçà åãî èíäèâèäóàëüíûõ è èíòåãðàëüíûõ ðåçóëüòàòîâ.

Ïðèìå÷àíèå - Öåëüþ äàííîãî ïðîöåññà ÿâëÿåòñÿ îïðåäåëåíèå âîçìîæíîñòåé, êâàëèôèêàöèè, îïûòà, ïðåäóáåæäåííîñòè è ïðåèìóùåñòâ ïîòåíöèàëüíûõ ÷èòàòåëåé äîêóìåíòà.

4.5 Â5: Ðàçìåðû ñòîðîí ëèñòà 176 ´ 250 ìì (ñì. ÈÑÎ 216).

4.6 âñïîìîãàòåëüíûé ìàòåðèàë (back matter): Ìàòåðèàë, ñîäåðæàùèéñÿ â êîíöå êíèãè èëè ðóêîâîäñòâà, íàïðèìåð, òåìàòè÷åñêèé óêàçàòåëü.

4.7 ôîòîøàáëîíû (camera-ready originals): Íàáîð èçîáðàæåíèé íà áóìàãå, ôîòîïëåíêå èëè äðóãîì íîñèòåëå, ñ êîòîðîãî ìîæåò áûòü ñäåëàíà ôîòîêîïèÿ, ãäå êàæäîå èçîáðàæåíèå ñîäåðæèò âñå íåîáõîäèìûå òåêñòîâûå è ãðàôè÷åñêèå ýëåìåíòû îäíîé ñòðàíèöû ïå÷àòíîãî äîêóìåíòà, ñêîìïîíîâàííûå äîëæíûì îáðàçîì.

4.8 äàòà ïåðåñìîòðà (cut-off date): Äàòà, ïî èñòå÷åíèè êîòîðîé âñå èçìåíåíèÿ, âíåñåííûå â ïðîãðàììíûå ñðåäñòâà, îïèñûâàþòñÿ â íîâîé ðåäàêöèè äîêóìåíòàöèè, áîëåå âåðíîé ïî ñðàâíåíèþ ñ äåéñòâóþùåé.

4.9 íîìåíêëàòóðà ïîñòàâêè (deliverables): Îáúåêòû (ýëåìåíòû, èçäåëèÿ è ò.ä.), ïîñòàâëÿåìûå çàêàç÷èêó ïî óñëîâèÿì äîãîâîðà.

4.10 äîêóìåíò (document): Ñì. ýëåìåíò äîêóìåíòàöèè (4.26).

4.11 äîêóìåíòàöèÿ (documentation): Ïå÷àòíûå ðóêîâîäñòâà ïîëüçîâàòåëÿ, äèàëîãîâàÿ (îïåðàòèâíàÿ) äîêóìåíòàöèÿ è ñïðàâî÷íûé òåêñò («õåëïû»), îïèñûâàþùèå êàê ïîëüçîâàòüñÿ ïðîãðàììíûì ïðîäóêòîì.

4.12 ïåðñîíàë ðàçðàáîò÷èêîâ äîêóìåíòàöèè (documentation development staff): Âåñü ïåðñîíàë, ïðèâëåêàåìûé íà ëþáîì ýòàïå ïëàíèðîâàíèÿ, íàïèñàíèÿ, ðåäàêòèðîâàíèÿ è âûïóñêà äîêóìåíòàöèè.

Ïðèìå÷àíèå - Äàííûé òåðìèí îõâàòûâàåò êîëëåêòèâ àâòîðîâ, îôîðìèòåëåé, èëëþñòðàòîðîâ è àäìèíèñòðàöèè ïðîåêòà.

4.13 ïëàí äîêóìåíòèðîâàíèÿ (documentation plan): Äîêóìåíò, â êîòîðîì èçëàãàþòñÿ íåîáõîäèìûå ýëåìåíòû ïðîåêòà äîêóìåíòèðîâàíèÿ.

4.14 äîêóìåíòàòîð (documenter): Ñòîðîíà, ñîçäàþùàÿ äîêóìåíòàöèþ.

Ïðèìå÷àíèå -  íàñòîÿùåì ñòàíäàðòå íå èñïîëüçóþò òåðìèí ðàçðàáîò÷èê (developer) (â ñìûñëå 3.8 ïî ÃÎÑÒ Ð ÈÑÎ/ÌÝÊ 12207), òàê êàê â ñëó÷àå äîêóìåíòèðîâàíèÿ ðàçðàáîò÷èê ïðîãðàììíîãî ñðåäñòâà ÷àñòî ÿâëÿåòñÿ çàêàç÷èêîì äîêóìåíòàöèè, è èñïîëüçîâàíèå òåðìèíà ðàçðàáîò÷èê ìîæåò ïðèâåñòè ê ðàçíî÷òåíèþ. Ïîýòîìó èñïîëüçóþò òåðìèí äîêóìåíòàòîð.

4.15 ýëåêòðîííàÿ êîïèÿ (electronic copy): Êîìïüþòåðíûé äèñê èëè äðóãîé ìàøèíî÷èòàåìûé íîñèòåëü èíôîðìàöèè, ñîäåðæàùèé ôàéë èëè ôàéëû, ñ êîòîðîãî(ûõ) ìîæåò áûòü ðàñïå÷àòàí äîêóìåíò.

4.16 n-øòðèõ (en dash): Øòðèõ, èìåþùèé òàêóþ æå øèðèíó, êàê è ñòðî÷íàÿ áóêâà «n».

4.17 êîíöåâûå ïðèìå÷àíèÿ (endnotes): Ïðèìå÷àíèÿ, ñîáðàííûå â êîíöå ãëàâû èëè äîêóìåíòà.

4.18 ñòðàíèöà-ðàñêëàäêà (foldout): Ñòðàíèöà, ñëîæåííàÿ òàê, ÷òî åå çàäíÿÿ ÷àñòü øèðå ïåðåäíåé (íåìíîãî ïðåâûøàåò îñíîâíîé ôîðìàò), êîòîðóþ ìîæíî ðàçâåðíóòü.

4.19 íèæíèé êîëîíòèòóë (footer): Ñïðàâî÷íàÿ(ûå) ñòðîêà(è) ïîä òåêñòîì ñòðàíèöû, óêàçûâàþùàÿ(èå) íà åå ñîäåðæàíèå (íàïðèìåð, íîìåð ñòðàíèöû).

4.20 ñíîñêà (footnote): Ïîìåùàåìûé âíèçó ñòðàíèöû (êîëîíêè) òåêñò (ïðèìå÷àíèå, áèáëèîãðàôè÷åñêàÿ ññûëêà è ò.ä.), ñâÿçàííûé ñ îñíîâíûì òåêñòîì çíàêîì ñíîñêè (öèôðîâûì íîìåðîì, çâåçäî÷êîé), çàêðûâàåìûì êðóãëîé ñêîáêîé, íàáèðàåìûé îáû÷íî øðèôòîì ïîíèæåííîãî êåãëÿ ïî ñðàâíåíèþ ñî øðèôòîì îñíîâíîãî òåêñòà è îòäåëÿåìûé îò íåãî ïðîáåëîì èëè ïðîáåëîì ñ òîíêîé êîðîòêîé ëèíåéêîé.

4.21 ââîäíûé ìàòåðèàë (front matter): Íà÷àëüíàÿ ÷àñòü èëè ãëàâà èçäàíèÿ, íàïðèìåð, òèòóëüíûé ëèñò è ñîäåðæàíèå.

4.22 âåðõíèé êîëîíòèòóë (header): Ñïðàâî÷íàÿ(ûå) ñòðîêà(è) íàä òåêñòîì ñòðàíèöû.

4.23 çàãîëîâîê (heading): Íàçâàíèå âíóòðåííåãî ïîäðàçäåëà èçäàíèÿ, îïðåäåëÿþùåå òåìó, ðàñêðûâàåìóþ â ïîñëåäóþùåì òåêñòå.

4.24 ñïðàâî÷íàÿ ñèñòåìà (help system): Ñì. 4.32.

4.25 ñïðàâî÷íûé òåêñò (help text): Òåêñò, îáëåã÷àþùèé è óáûñòðÿþùèé ïîëüçîâàòåëþ, ïðè ýêñïëóàòàöèè ïðîãðàììíîãî ñðåäñòâà, ïîèñê ñîäåðæàùèõñÿ â èçäàíèè îáúåêòîâ, àâòîìàòè÷åñêè âûáèðàåìûé â çàâèñèìîñòè îò êîíòåêñòà, â êîòîðîì îí âûçûâàåòñÿ, ò.å. ñïðàâî÷íûé òåêñò êîíòåêñòíî çàâèñèì.

4.26 ýëåìåíò äîêóìåíòàöèè (item of documentation): Öåëåâàÿ èíôîðìàöèÿ, ïðåäíàçíà÷åííàÿ äëÿ êîíêðåòíîé àóäèòîðèè, ðàçìåùåííàÿ íà êîíêðåòíîì íîñèòåëå (íàïðèìåð, â êíèãå, íà äèñêå, â êðàòêîé ñïðàâî÷íîé êàðòå) â çàäàííîì ôîðìàòå.

4.27 ñïðàâî÷íàÿ ññûëêà (location reference): Ìåòêà, âûäåëÿþùàÿ çàãîëîâîê èëè ïîäçàãîëîâîê â òåìàòè÷åñêîì (ïðåäìåòíîì) óêàçàòåëå, ïîêàçûâàþùàÿ, ê êàêîé ÷àñòè äîêóìåíòà îíè îòíîñÿòñÿ.

4.28 èçìåíåííûé äîêóìåíò (èçìåíåíèå äîêóìåíòà) (mark-up): Äîêóìåíò, ñîäåðæàùèé çàïîëíåííûå ëèñòû èçìåíåíèé, à òàêæå ïðîöåññ ñîçäàíèÿ òàêîãî äîêóìåíòà.

4.29 îðèãèíàë-ìàêåò (mechanicals): Îðèãèíàë, íàïå÷àòàííûé êàê îáðàçåö äëÿ íàáîðà, ñîäåðæàùèé ïîäðîáíûå òåêñòîâûå, ïåðåïëåòíûå, èçäàòåëüñêèå è êîìïîíîâî÷íûå õàðàêòåðèñòèêè ïå÷àòíîé ïðîäóêöèè (èçäàíèÿ).

4.30 íàâèãàöèÿ (navigation): Ñïîñîá ïåðåõîäà ïîëüçîâàòåëÿ îò îäíîé ÷àñòè ïðèêëàäíûõ ïðîãðàììíûõ ñðåäñòâ ê äðóãîé.

4.31 äèàëîãîâàÿ äîêóìåíòàöèÿ (on-line documentation): Èíôîðìàöèÿ, äîñòóïíàÿ ïîëüçîâàòåëþ ïðè ýêñïëóàòàöèè ïðîãðàììíîãî ñðåäñòâà, êîòîðàÿ íå îáÿçàòåëüíî ïðèâÿçàíà ê êîíêðåòíîìó êîíòåêñòó (ñì. òàêæå 4.25).

4.32 ñèñòåìà äèàëîãîâîé äîêóìåíòàöèè èëè ñïðàâî÷íàÿ ñèñòåìà (on-line documentation system or help system): ×àñòü ïðîãðàììû (èíîãäà îòäåëüíàÿ ïðîãðàììà), çàïðàøèâàåìàÿ ïîëüçîâàòåëåì è ïîçâîëÿþùàÿ åìó ïðîñìàòðèâàòü ÷àñòè äèàëîãîâîé äîêóìåíòàöèè èëè ñïðàâî÷íîãî òåêñòà (ñì. òàêæå 4.25 è 4.31).

4.33 êîíöåâàÿ âèñÿ÷àÿ ñòðîêà (orphan): Ñòðîêà ÷àñòè òåêñòà (ãëàâû, ðàçäåëà è ò.ä.) åäèíñòâåííàÿ íà ñòðàíèöå (ïîëîñå).

4.34 áóìàæíûé äîêóìåíò (orphan): ×àñòü äîêóìåíòàöèè, ïðåäñòàâëÿåìàÿ â ïå÷àòíîì âèäå.

4.35 ýëèç (äîï. ïèêñåëü) (pixel): Íàèìåíüøèé ýëåìåíò èçîáðàæåíèÿ íà ýêðàíå äèñïëåÿ; ñîêðàùåíèå îò «ýëåìåíò èçîáðàæåíèÿ» («picture element»).

4.36 òî÷êà (point): Åäèíèöà òèïîìåòðè÷åñêîé òèïîãðàôñêîé ñèñòåìû, âûðàæàåìàÿ ðàññòîÿíèåì ïî âåðòèêàëè è ñîäåðæàùàÿ â 1 ìì ïðèáëèçèòåëüíî 2,8 òî÷åê (â îäíîì äþéìå ïðèáëèçèòåëüíî 72 òî÷êè).

4.37 ïðîöåññ (process): Íàáîð ïðåîáðàçóþùèé èñõîäíûå äàííûå â âûõîäíûå ðåçóëüòàòû (3.17 ÃÎÑÒ Ð ÈÑÎ/ÌÝÊ 12207).

4.38 ïðîäóêöèÿ (product): Ïîëíûé íàáîð êîìïüþòåðíûõ ïðîãðàìì, ïðîöåäóð è ñîîòâåòñòâóþùèõ èì äîêóìåíòàöèè è äàííûõ, ïðåäíàçíà÷åííûé äëÿ ïîñòàâêè ïîëüçîâàòåëþ.

Ïðèìå÷àíèå - Èñïîëüçóþò òàêæå òåðìèí «ïðîãðàììíûé ïðîäóêò».

4.39 ïðîèçâîäñòâî (production): Ïðåäâàðèòåëüíàÿ ïîäãîòîâêà òåêñòà ê ïåðåâîäó åãî â ôîòîøàáëîíû, çàêîí÷åííûå ñïðàâî÷íûå òåêñòû èëè äèàëîãîâóþ äîêóìåíòàöèþ.

4.40 ãðàíêè (proof): Îêîí÷àòåëüíàÿ ðåäàêöèÿ áóìàæíîãî äîêóìåíòà, ïðåäñòàâëåííàÿ ïåðåä ïå÷àòüþ çàêàç÷èêó äëÿ ðàññìîòðåíèÿ è óòâåðæäåíèÿ.

Ïðèìå÷àíèå - Ïðè îòñóòñòâèè çàìå÷àíèé îêîí÷àòåëüíûé äîêóìåíò äîëæåí áûòü âî âñåõ îòíîøåíèÿõ èäåíòè÷åí ãðàíêàì, çà èñêëþ÷åíèåì âèäà áóìàãè, ïåðåïëåòà è öâåòîâîãî îôîðìëåíèÿ. Ãðàíêè îáû÷íî ÿâëÿþòñÿ ôîòîêîïèåé ôîòîøàáëîíîâ.

4.41 ïðîòîòèï (prototype): Ìîäåëü èëè ïðåäâàðèòåëüíàÿ ðåàëèçàöèÿ ÷àñòè ïðîãðàììíîãî ñðåäñòâà, ïðèãîäíàÿ äëÿ îöåíêè ïðîåêòà ñèñòåìû, åå ïîòåíöèàëüíûõ ðàáî÷èõ õàðàêòåðèñòèê, ïðîèçâîäñòâà èëè ëó÷øåãî ïîíèìàíèÿ òðåáîâàíèé ê ïðîãðàììíîìó ñðåäñòâó.

4.42 îáîðîò (ëèñòà) (recto): Ñòðàíèöà íèæíÿÿ ïî îòíîøåíèþ ê ëåâîé èëè ïðàâîé âåðõíåé ñòîðîíå êðûøêè ïåðåïëåòà.

4.43 ðàñïå÷àòêà ýêðàíà (screen dump): Ïðåäïîëàãàåìîå èçîáðàæåíèå, êîòîðîå ïîëüçîâàòåëü äîëæåí âèäåòü íà ýêðàíå ïðè ýêñïëóàòàöèè ïðîãðàììíîãî ñðåäñòâà.

4.44 ñèñòåìà (system): Êîìïëåêñ ïðîöåññîâ, òåõíè÷åñêèõ è ïðîãðàììíûõ ñðåäñòâ, óñòðîéñòâ, îáñëóæèâàåìûé ïåðñîíàëîì è îáëàäàþùèé âîçìîæíîñòüþ óäîâëåòâîðÿòü óñòàíîâëåííûì ïîòðåáíîñòÿì è öåëÿì (3.31 ÃÎÑÒ Ð ÈÑÎ/ÌÝÊ 12207).

4.45 ñîäåðæàíèå (table of contents): Óêàçàòåëü çàãîëîâêîâ èçäàíèÿ ñ óêàçàíèåì íîìåðîâ ñòðàíèö â ïîðÿäêå èõ âîçðàñòàíèÿ.

4.46 òàáëèöà äåéñòâóþùèõ ñòðàíèö (ëèñò èçìåíåíèé) (table of effective pages): Ïåðå÷åíü ïîñëåäíèõ âåðñèé íîìåðîâ êàæäîé çàìåíåííîé ñòðàíèöû áóìàæíîãî äîêóìåíòà. Ïðè çàìåíå îòäåëüíûõ ñòðàíèö â ïåðå÷íå óêàçûâàþò ñòàðûå è íîâûå íîìåðà ñòðàíèö.

4.47 ïëàí âûáîðà ãðóïïû ïðîåêòàíòîâ (team selection plan): Äîêóìåíò, óñòàíàâëèâàþùèé òðåáîâàíèÿ ê êâàëèôèêàöèè è îïûòó ïåðñîíàëà, ðàçðàáàòûâàþùåãî äîêóìåíòàöèþ.

4.48 ñòðàíèöà-ðàçâåðòêà (throwclear): Ñòðàíèöà-ðàñêëàäêà, âûïîëíåííàÿ òàêèì îáðàçîì, ÷òî â ðàçâåðíóòîì âèäå è çàêðûòîì èçäàíèè (êíèãå, ðóêîâîäñòâå) äîñòóïíà äëÿ îáîçðåíèÿ (÷òåíèÿ) ñîâìåñòíî ñ ïðåäûäóùèìè ñòðàíèöàìè.

4.49 ïðàêòè÷åñêàÿ ëàáîðàòîðèÿ (usability laboratory): Êîìïëåêñ àíàëèòè÷åñêèõ è èññëåäîâàòåëüñêèõ ïîìåùåíèé, îñíàùåííûõ âèäåî- è àóäèîîáîðóäîâàíèåì äëÿ ðåãèñòðàöèè îòâåòîâ íà çàïðîñû ïîëüçîâàòåëåé.

4.50 òåñòèðîâàíèå íà ïðàêòè÷íîñòü (usability testing): Ôîðìàëüíûé ïðîöåññ îöåíêè ñîîòâåòñòâèÿ äîêóìåíòàöèè óñòàíîâëåííûì òðåáîâàíèÿì.

4.51 èíòåðôåéñ ïîëüçîâàòåëÿ (user interface): Èíòåðôåéñ, îáåñïå÷èâàþùèé âîçìîæíîñòü îáìåíà èíôîðìàöèåé ìåæäó ÷åëîâåêîì è òåõíè÷åñêèìè èëè ïðîãðàììíûìè êîìïîíåíòàìè âû÷èñëèòåëüíîé ñèñòåìû.

4.52 ïîëüçîâàòåëü (user): Ëèöî èëè îðãàíèçàöèÿ, êîòîðûå èñïîëüçóþò äåéñòâóþùóþ ñèñòåìó äëÿ âûïîëíåíèÿ êîíêðåòíîé ôóíêöèè (3.34 ÃÎÑÒ Ð ÈÑÎ/ÌÝÊ 12207).

Ïðèìå÷àíèå - ñì. òàêæå 4.3.

4.53 ðàçâîðîò (ëèñòà) (verso): Äâå ñìåæíûå ñòðàíèöû ðàñêðûòîãî èçäàíèÿ, ëåâàÿ è ïðàâàÿ.

4.54 ðàçäåëèòåëü àêòèâíûé (white space, active): Ïðîñòðàíñòâî (çà èñêëþ÷åíèåì ïîëåé), îõâàòûâàþùåå òåêñòîâûå è ãðàôè÷åñêèå ýëåìåíòû, ðàçäåëÿþùåå òåêñò, îòäåëÿþùåå òåìàòè÷åñêèå è ïîäòåìàòè÷åñêèå ñîñòàâëÿþùèå òåêñòà, óêàçûâàþùåå â òåêñòå òåìàòè÷åñêèå è èåðàðõè÷åñêèå îòíîøåíèÿ, âûäåëÿþùåå ñîîòâåòñòâóþùóþ èíôîðìàöèþ è îáëåã÷àþùåå ÷òåíèå òåêñòà.

4.55 ðàçäåëèòåëü ïàññèâíûé (white space, passive): Âåðõíåå, íèæíåå, ëåâîå è ïðàâîå ïîëÿ, îêðóæàþùèå òåêñò.

4.56 íà÷àëüíàÿ âèñÿ÷àÿ ñòðîêà (widow): Ïåðâàÿ ñòðîêà ÷àñòè òåêñòà (ãëàâû, ðàçäåëà è ò.ä.), çàâåðøàþùàÿ ïîñëåäíþþ ñòðîêó íà ñòðàíèöå (ïîëîñå).

5. Óïðàâëåíèå êà÷åñòâîì

Åñëè ðàçðàáîòêó ïðîãðàììíîãî ñðåäñòâà äîêóìåíòèðóþò â ñîîòâåòñòâèè ñî ñòàíäàðòîì ïî óïðàâëåíèþ êà÷åñòâîì, ïîëîæåíèÿ äàííîãî ñòàíäàðòà â ðàâíîé ìåðå ïðèìåíÿþò êàê ê ñàìîé ðàçðàáîòêå, òàê è ê ñîîòâåòñòâóþùåé äîêóìåíòàöèè.

Ïðèìå÷àíèå - Äàæå åñëè ñòàíäàðò ïî óïðàâëåíèþ êà÷åñòâîì íå óêàçàí â äîãîâîð (êîíòðàêòå), äîêóìåíòàòîðû ñòðåìÿòñÿ èñïîëüçîâàòü ñèñòåìó óïðàâëåíèÿ êà÷åñòâîì, àòòåñòîâàííóþ íà ñîîòâåòñòâèå äàííîìó(ûì) ñòàíäàðòó(àì). Îòíîñèòåëüíî êà÷åñòâà ïðîãðàììíîãî ñðåäñòâà â öåëîì ñì. ÃÎÑÒ Ð ÈÑÎ/ÌÝÊ 12119.

6. Àäàïòàöèÿ

Íàñòîÿùèé ñòàíäàðò îïðåäåëÿåò îäíó èç ðåàëèçàöèé ïðîöåññà äîêóìåíòèðîâàíèÿ, îïèñàííîãî â ÃÎÑÒ Ð ÈÑÎ/ÌÝÊ 12207, è ìîæåò áûòü àäàïòèðîâàí ê óñëîâèÿì êîíêðåòíûõ ïðîåêòîâ (ñì. ïðèëîæåíèå Â).

7. Öåëè

Íàñòîÿùèé ñòàíäàðò ïî ñóùåñòâó ÿâëÿåòñÿ ñòàíäàðòîì íà ïðîöåññ. Ñòàíäàðò íå îïðåäåëÿåò êîìïîíîâêó êîíêðåòíîãî äîêóìåíòà, åãî ñîäåðæàíèå è äðóãèå àñïåêòû êîìïëåêòíîñòè äîêóìåíòàöèè, îäíàêî îí óñòàíàâëèâàåò ìåòîä ïëàíèðîâàíèÿ è ïðîâåäåíèÿ ïðîöåññà äîêóìåíòèðîâàíèÿ.

8. Òðåáîâàíèÿ

8.1 Ïðîöåññ äîêóìåíòèðîâàíèÿ

8.1.1 Îáùèå ïîëîæåíèÿ

Ïðîöåññ äîêóìåíòèðîâàíèÿ äîëæåí áûòü âûïîëíåí â äâà ýòàïà â ïîñëåäîâàòåëüíîñòè, ïðåäñòàâëåííîé íà ðèñóíêå 1 â çàòåíåííûõ ïðÿìîóãîëüíèêàõ. Ïîýòàïíûå ðàáîòû íå âûïîëíÿþòñÿ îäíîâðåìåííî. Íà îòäåëüíûõ ýòàïàõ ðàáîòû ìîãóò ïðîâîäèòüñÿ ïàðàëëåëüíî. Âîçìîæíûå èòåðàöèè ðàáîò ïîêàçàíû ïóíêòèðíûìè ëèíèÿìè.

Êîãäà ìèíèìàëüíûé ñîñòàâ äîêóìåíòàöèè îïðåäåëÿåòñÿ çàêàç÷èêîì (íàïðèìåð, ñ èñïîëüçîâàíèåì ÃÎÑÒ Ð ÈÑÎ 9127 èëè ÈÑÎ/ÌÝÊ 6592 [1]), ýòî äîëæíî áûòü ó÷òåíî äîêóìåíòàòîðîì ïðè ðàçðàáîòêå ïëàíà äîêóìåíòèðîâàíèÿ.

8.1.2 Ïðåäñòàâëåíèå èñõîäíûõ ìàòåðèàëîâ

Çàêàç÷èê äîëæåí îáåñïå÷èâàòü äîêóìåíòàòîðó äîñòóï:

a) êî âñåì ñîîòâåòñòâóþùèì ñïåöèôèêàöèÿì, ôîðìàòàì çàïèñåé, êîìïîíîâêàì ýêðàíîâ è îò÷åòîâ, âûõîäíûì ðåçóëüòàòàì ðàáîòû ñðåäñòâ àâòîìàòèçàöèè ïðîãðàììèðîâàíèÿ (CASE tool) è äðóãîé èíôîðìàöèè, íåîáõîäèìîé äëÿ ïîäãîòîâêè äîêóìåíòàöèè;

b) ê ðàáî÷åé êîïèè ïðîãðàììíîãî ñðåäñòâà (ïðè íåîáõîäèìîñòè);

c) ê àíàëèòèêàì è ïðîãðàììèñòàì, âêëþ÷àÿ ñâîåâðåìåííîå ïðàâèëüíîå ðåøåíèå âîïðîñîâ, âîçíèêàþùèõ ó ïåðñîíàëà ðàçðàáîò÷èêîâ äîêóìåíòàöèè;

d) ê òèïè÷íûì ïîëüçîâàòåëÿì (ïî âîçìîæíîñòè) äëÿ àíàëèçà àóäèòîðèè è òåñòèðîâàíèÿ íà ïðàêòè÷íîñòü.

 îáÿçàííîñòè äîêóìåíòàòîðà âõîäèò îáåñïå÷åíèå ïëîäîòâîðíîñòè êîíòàêòîâ ñ ðàçðàáîò÷èêàìè ïðîãðàììíûõ ñðåäñòâ çàêàç÷èêà, ãàðàíòèðóþùåå êàê ìèíèìóì ïîíèìàíèå ñóòè âûïóñêàåìîé ïðîäóêöèè è ñîîòâåòñòâóþùèõ åé àóäèòîðèé.

Ïðèìå÷àíèå - Äîêóìåíòàòîð íå îòâå÷àåò çà ðàçðàáîòêó, ïðîâåðêó èëè êîððåêòèðîâêó èñõîäíûõ ìàòåðèàëîâ, à òîëüêî çà èõ ïîëó÷åíèå.

Íåçàâèñèìî îò òîãî, ÿâëÿåòñÿ ëè äîêóìåíòàòîð îäíîâðåìåííî ðàçðàáîò÷èêîì ïðîãðàììíîãî ñðåäñòâà, çàêàç÷èê äîëæåí îáåñïå÷èòü åãî êîïèÿìè âñåõ ïðèìåíÿåìûõ ñòàíäàðòîâ, ðóêîâîäñòâàìè ïî ñòèëÿì è ôîðìàòàì, à òàêæå ñîîòâåòñòâóþùèìè ìàòåðèàëàìè (åñëè îíè íå ÿâëÿþòñÿ îáùåäîñòóïíûìè). Äîêóìåíòàòîð äîëæåí îáåñïå÷èòü äàííûìè ìàòåðèàëàìè ñîîòâåòñòâóþùèé ïåðñîíàë ðàçðàáîò÷èêîâ äîêóìåíòàöèè.

Îáÿçàííîñòüþ ðàçðàáîò÷èêà ÿâëÿåòñÿ îáåñïå÷åíèå ïîëíîòû, ïðàâèëüíîñòè è àêòóàëüíîñòè âñåõ ìàòåðèàëîâ, ïðåäúÿâëÿåìûõ ðàçðàáîò÷èêó íà ìîìåíò èõ ïîñòàâêè.

Ðàçðàáîò÷èê äîëæåí ãàðàíòèðîâàòü, ÷òî ïðåäñòàâëåíèå äîêóìåíòàòîðó äàííûõ ìàòåðèàëîâ íå íàðóøàåò ïðàâ èíòåëëåêòóàëüíîé ñîáñòâåííîñòè ëþáîé òðåòüåé ñòîðîíû.

Äîêóìåíòàòîð äîëæåí ïðåäïðèíÿòü ñîîòâåòñòâóþùèå øàãè ïî ñîõðàíåíèþ ìàòåðèàëîâ, ïðåäñòàâëåííûõ çàêàç÷èêîì, îáåñïå÷èòü çàùèòó èíôîðìàöèè î òðåáîâàíèÿõ çàêàç÷èêà è âîçâðàòèòü âñå ìàòåðèàëû çàêàç÷èêó ïî çàâåðøåíèè ïðîåêòà äîêóìåíòèðîâàíèÿ.

Ïðèìå÷àíèå -  ðÿäå ñëó÷àåâ íåò íåîáõîäèìîñòè âîçâðàùàòü âñå ìàòåðèàëû; äàííûé âîïðîñ äîëæåí áûòü îãîâîðåí â äîãîâîðå.  ðÿäå ñëó÷àåâ òðåáóåòñÿ ñîõðàíèòü êîíôèäåíöèàëüíîñòü è ñåêðåòíîñòü ïðåäîñòàâëåííûõ ìàòåðèàëîâ.  äîãîâîðå äîëæíû áûòü óñòàíîâëåíû óðîâíè (ãðèôû) êîíôèäåíöèàëüíîñòè èëè ñåêðåòíîñòè ìàòåðèàëîâ, ïðåäñòàâëÿåìûõ çàêàç÷èêîì äîêóìåíòàòîðó.

Ðèñóíîê 1 - Îáçîð ïðîöåññà äîêóìåíòèðîâàíèÿ

8.1.3 Ïëàí äîêóìåíòèðîâàíèÿ

8.1.3.1 Îáùèå ïîëîæåíèÿ

Äîêóìåíòàòîð äîëæåí ïîäãîòîâèòü ïëàí äîêóìåíòèðîâàíèÿ, â êîòîðîì äîëæíû áûòü îïðåäåëåíû çàäàíèÿ, âûïîëíÿåìûå ïðè ñîçäàíèè êîíêðåòíîé äîêóìåíòàöèè. Äàííûé ïëàí äîëæåí áûòü îôèöèàëüíî ñîãëàñîâàí çàêàç÷èêîì, ÷òî ïîäòâåðæäàåò ïîëíûé ó÷åò â ýòîì ïëàíå âñåõ òðåáîâàíèé çàêàç÷èêà.

Ïðèìå÷àíèå - Îáû÷íî ïëàí äîêóìåíòèðîâàíèÿ äîëæåí îõâàòûâàòü âåñü êîìïëåêò äîêóìåíòàöèè, íàïðèìåð ðóêîâîäñòâà ïîëüçîâàòåëÿ, äèàëîãîâóþ äîêóìåíòàöèþ, ñïðàâî÷íûå òåêñòû è êðàòêèå ñïðàâî÷íûå êàðòû. Ïðèìåð ïëàíà ïðèâåäåí â ïðèëîæåíèè Ñ. Ïðîöåññ ïðîåêòèðîâàíèÿ äîêóìåíòàöèè îïèñàí â ïðèëîæåíèè D.

 ïëàíå äîêóìåíòèðîâàíèÿ äîëæíû áûòü ÷åòêî îïèñàíû îáëàñòü ïðèìåíåíèÿ è îãðàíè÷åíèÿ ïî èñïîëüçîâàíèþ ïëàíèðóåìîé äîêóìåíòàöèè, à òàêæå îñíîâíûå ðåøåíèÿ ïî àíàëèçó è ïðîåêòèðîâàíèþ ýòîé äîêóìåíòàöèè.  ïëàíå òàêæå äîëæíû áûòü îïðåäåëåíû ïðîöåññû è ïðîâåðêè, âûïîëíÿåìûå ïðè ðàçðàáîòêå äîêóìåíòàöèè.

Ïëàí äîêóìåíòèðîâàíèÿ äîëæåí îõâàòûâàòü ñëåäóþùèå âîïðîñû (íî íå îãðàíè÷èâàòüñÿ èìè):

a) ðàáî÷åå íàèìåíîâàíèå, íàçíà÷åíèå, îáëàñòü ïðèìåíåíèÿ è îãðàíè÷åíèÿ ïî èñïîëüçîâàíèþ ïëàíèðóåìîé äîêóìåíòàöèè;

b) ñïåöèôèêàöèþ ñòèëÿ â ñîîòâåòñòâèè 8.2;

c) îïðåäåëåíèå àóäèòîðèè ïîëüçîâàòåëåé (ñì. 8.1.3.2);

d) îáîñíîâàíèå ïðè÷èí èñïîëüçîâàíèÿ äîêóìåíòàöèè äàííîé àóäèòîðèåé è åå öåëåâîå íàçíà÷åíèå;

e) ñîäåðæàíèå (ïëàí-ïðîñïåêò) äîêóìåíòàöèè, ñ îöåíêîé åå ïîñòðàíè÷íîãî îáúåìà, è ñîîòâåòñòâóþùèå óòî÷íåíèÿ äëÿ äðóãèõ ìàøèííûõ íîñèòåëåé äîêóìåíòàöèè;

f) íîìåíêëàòóðó ïîñòàâêè - ÷èñëî ïå÷àòíûõ êîïèé, íàëè÷èå ýëåêòðîííûõ êîïèé, ôîðìàòû äèñêîâ è ôàéëîâ (âêëþ÷àÿ âåðñèè ïðîãðàììíûõ ñðåäñòâ) è îòêóäà îíè ìîãóò áûòü ïîñòàâëåíû;

g) óñòàíîâëåíèå ñîáñòâåííèêà àâòîðñêèõ ïðàâ íà äîêóìåíòàöèþ è ëþáûõ äðóãèõ ïðàâ ñîáñòâåííîñòè.

Ïðèìå÷àíèå - Âîïðîñ ïðàâ ñîáñòâåííîñòè ÿâëÿåòñÿ ñëîæíûì. Âî âñåõ äîãîâîðàõ íà äîêóìåíòàöèþ äîëæíû áûòü óêàçàíû ñîáñòâåííèêè ñîîòâåòñòâóþùèõ ïðàâ. Ïðè ýòîì ìîæåò áûòü óêàçàíà ïîñëåäóþùàÿ âîçìîæíîñòü ïåðåäà÷è àâòîðñêèõ ïðàâ îò äîêóìåíòàòîðà ê çàêàç÷èêó. Ïåðåäà÷à àâòîðñêèõ ïðàâ öåëåñîîáðàçíà ïðè îïðåäåëåíèè ìåñòà è ñïîñîáà òèðàæèðîâàíèÿ äîêóìåíòàöèè;

h) îáåñïå÷åíèå ïåðåâîäà äîêóìåíòàöèè íà äðóãèå ÿçûêè.

Ïðèìå÷àíèå - Ïîäðîáíåå ñì. â ïðèëîæåíèè Å;

i) óðîâíè (ãðèôû) ñåêðåòíîñòè è êîíôèäåíöèàëüíîñòè (ïðè íåîáõîäèìîñòè);

j) ïðîöåäóðû è ïðîâåðêè, ìîãóùèå âëèÿòü íà ïðîöåññ ðàçðàáîòêè äîêóìåíòàöèè, âêëþ÷àÿ, ïðè íåîáõîäèìîñòè, õðàíåíèå, ïîèñê, ðåçåðâèðîâàíèå, ïåðåäà÷ó è îöåíêó êà÷åñòâà;

k) ìåòîäû è ñðåäñòâà ïðîèçâîäñòâà (òèðàæèðîâàíèÿ) è èñïîëüçóåìûå âåðñèè äàííûõ ñðåäñòâ;

l) ñòðóêòóðó êîëëåêòèâà ðàçðàáîò÷èêîâ äîêóìåíòàöèè è, âîçìîæíî, ïëàíà âûáîðà äàííîé ñòðóêòóðû.

Ïðèìå÷àíèå - Êîíêðåòíûå ëèöà ïðèâëåêàþòñÿ íà ðàçëè÷íûõ ýòàïàõ íàïèñàíèÿ è ïðîèçâîäñòâà (òèðàæèðîâàíèÿ) äîêóìåíòàöèè â çàâèñèìîñòè îò óðîâíÿ ñâîåãî îïûòà è çíàíèé. Íàïðèìåð, ìîæåò áûòü íåîáõîäèìûì õîðîøåå çíàíèå àâòîðîì äîêóìåíòèðóåìîé ñèñòåìû è îïûò â íàïèñàíèè äîêóìåíòàöèè; äëÿ ðåäàêòîðà ìîæåò ïîòðåáîâàòüñÿ òîëüêî îïûò ðåäàêòèðîâàíèÿ, íî íå çíàíèå ñèñòåìû; îò êîìïîíîâùèêà (îôîðìèòåëÿ) ìîæåò íå òðåáîâàòüñÿ äðóãèõ çíàíèé êðîìå çíàíèÿ ñðåäñòâ îôîðìëåíèÿ;

m) âçàèìîñâÿçè (ïîä÷èíåííîñòè) ïðîåêòà;

n) ïî÷àñîâóþ çàãðóçêó è çàðïëàòó ïåðñîíàëà (ðóêîâîäñòâî ïî îöåíêå ýòèõ ôàêòîðîâ ïðèâåäåíî â ïðèëîæåíèè F);

o) òðåáîâàíèÿ ê ïðîåêòíûì ðåñóðñàì, âêëþ÷àÿ èíôîðìàöèîííûå è ïðî÷èå ðåñóðñû, ïðåäñòàâëÿåìûå çàêàç÷èêîì, è ñðîêàì èõ ïðåäñòàâëåíèÿ;

ð) ìåòîä ïåðåäà÷è äîêóìåíòàòîðó èíôîðìàöèè îá èçìåíåíèÿõ ïðîãðàììíîãî ñðåäñòâà â ïðîöåññå åãî ðàçðàáîòêè;

q) ïëàíû êîíòðîëÿ èçìåíåíèé è ñîïðîâîæäåíèÿ äîêóìåíòàöèè (ôàêóëüòàòèâíî);

r) ïëàíû ïðîâåðêè äîêóìåíòàöèè ïîñëå åå ñîçäàíèÿ;

s) êàëåíäàðíîå ïëàíèðîâàíèå (ãðàôèêè) ïî êîíòðîëüíûì òî÷êàì (milestones), âêëþ÷àÿ (ïðè íåîáõîäèìîñòè):

1) óòâåðæäåíèå ïëàíà äîêóìåíòèðîâàíèÿ,

2) ïîäãîòîâêó, ïðîâåðêó è êîððåêòèðîâêó ïðîåêòà êàæäîãî äîêóìåíòà,

3) òåñòèðîâàíèå íà ïðàêòè÷íîñòü,

4) ïîäãîòîâêó îðèãèíàëîâ ôîòîøàáëîíîâ,

5) ðàñïå÷àòêó, ïåðåïëåòåíèå è ðàñïðîñòðàíåíèå äîêóìåíòàöèè.

Ïðè íåîáõîäèìîñòè êàæäûé èç ïóíêòîâ ïëàíà äîëæåí áûòü îïèñàí äëÿ êàæäîãî ýëåìåíòà äîêóìåíòàöèè.

Ïðèìå÷àíèÿ

1. Ïîëåçíî òàêæå âêëþ÷èòü â ïëàí äîêóìåíòèðîâàíèÿ îáðàçöû àíàëîãè÷íîé äîêóìåíòàöèè, âûïóñêàåìîé äîêóìåíòàòîðîì èëè äðóãèìè ñòîðîíàìè, ÷òîáû ïîêàçàòü åå ñòèëè è êîìïîíîâêó.

2. Ïëàí äîêóìåíòèðîâàíèÿ äîëæåí áûòü ïîäãîòîâëåí è óòâåðæäåí äî íà÷àëà ðàçðàáîòêè äîêóìåíòàöèè, ÷òîáû ãàðàíòèðîâàòü ñîãëàñîâàíèå âñåìè ñòîðîíàìè ïîñòàâëåííûõ çàäà÷ è èñïîëüçóåìûõ ìåòîäîâ. Ïîñëå óòâåðæäåíèÿ ïëàíà îí äîëæåí áûòü äîâåäåí äî âñåõ çàèíòåðåñîâàííûõ ñòîðîí, âêëþ÷àÿ ïåðñîíàë ðàçðàáîò÷èêîâ äîêóìåíòàöèè, à òàêæå çàêàç÷èêà è ñóáïîäðÿä÷èêîâ (íàïðèìåð, ïå÷àòíèêîâ, íàáîðùèêîâ, ïåðåâîä÷èêîâ).

8.1.3.2 Îïðåäåëåíèå àóäèòîðèè ïîëüçîâàòåëåé

Ïëàí äîêóìåíòèðîâàíèÿ äîëæåí âêëþ÷àòü îïðåäåëåíèå àóäèòîðèè(é) ïîëüçîâàòåëåé äîêóìåíòàöèè, óðîâíÿ îáðàçîâàíèÿ, ñïîñîáíîñòåé, ïîäãîòîâêè, îïûòà äàííûõ ïîëüçîâàòåëåé è äðóãèõ õàðàêòåðèñòèê, ñâÿçàííûõ ñ ñîäåðæàíèåì, ñòðóêòóðîé è èñïîëüçîâàíèåì äîêóìåíòàöèè.

Îáû÷íî èìååòñÿ ðÿä ðàçëè÷íûõ ãðóïï ïîëüçîâàòåëåé, ïðåñëåäóþùèõ ðàçëè÷íûå öåëè ïðè èñïîëüçîâàíèè êîíêðåòíîé äîêóìåíòàöèè. Êàæäûé òèï ïîëüçîâàòåëåé, âêëþ÷àÿ èõ õàðàêòåðèñòèêè è çàäà÷è, ðåøàåìûå èìè ïðè ïîìîùè äîêóìåíòàöèè, äîëæåí áûòü îïðåäåëåí îòäåëüíî.

Ïðèìå÷àíèÿ

1. Äàííûå îá îïðåäåëåíèè àóäèòîðèè ïîëüçîâàòåëåé ìîãóò áûòü ïîëó÷åíû èç:

a) ðåçóëüòàòîâ èçó÷åíèÿ àóäèòîðèè, ïðîâåäåííîãî çàêàç÷èêîì èëè äîêóìåíòàòîðîì;

b) îïèñàíèé, ïðåäñòàâëÿåìûõ çàêàç÷èêîì;

c) îïðåäåëåíèé àóäèòîðèè, ïîëó÷åííûõ èç äðóãèõ èñòî÷íèêîâ.

2. Ïî âîçìîæíîñòè ïåðñîíàë ðàçðàáîò÷èêîâ äîêóìåíòàöèè äîëæåí îðãàíèçîâàòü âñòðå÷è ñ òèïîâûìè ïîëüçîâàòåëÿìè â èõ ðàáî÷åé îáñòàíîâêå è îáñëåäîâàòü èõ ðàáîòó.

8.1.3.3 Êîíòðîëü ïëàíà äîêóìåíòèðîâàíèÿ

Ïîñëå îôèöèàëüíîãî ñîãëàñîâàíèÿ ïëàíà äîêóìåíòàòîð äîëæåí íåñòè îòâåòñòâåííîñòü çà êîíòðîëü è ðàñïðîñòðàíåíèå äàííîãî ïëàíà. Äîêóìåíòàòîðîì äîëæåí áûòü ñîñòàâëåí ñïèñîê ïî ðàñïðîñòðàíåíèþ ó÷òåííûõ êîïèé äàííîãî ïëàíà.

 ñëó÷àå âíåñåíèÿ â ïëàí ïîñëåäóþùèõ èçìåíåíèé (ñîãëàñîâàííûõ äîêóìåíòàòîðîì è çàêàç÷èêîì) äîêóìåíòàòîð äîëæåí ãàðàíòèðîâàòü ïîëó÷åíèå ýòèõ èçìåíåíèé âñåìè äåðæàòåëÿìè ó÷òåííûõ êîïèé.

Ïðèìå÷àíèå - Âñëåäñòâèå ïðîáëåì, âîçíèêàþùèõ ïðè íàëè÷èè óñòàðåëûõ êîïèé ïëàíà, äîêóìåíòàòîð äîëæåí çàïðåòèòü åãî íåñàíêöèîíèðîâàííîå êîïèðîâàíèå è ïðåäóñìîòðåòü ïðîöåäóðû àóäèòà âñåõ îáíîâëÿåìûõ êîïèé ïëàíà.

8.1.4 Ïðîâåðêà (àíàëèç)

8.1.4.1 Îáùèå ïîëîæåíèÿ

Ñîîòâåòñòâóþùèå ïðîâåðêè äîëæíû ïðîâîäèòüñÿ çàêàç÷èêîì ñ ïðèâëå÷åíèåì äîêóìåíòàòîðà (ïðè íåîáõîäèìîñòè).

Ïðèìå÷àíèå - Öåëüþ ïðîâåðêè ÿâëÿåòñÿ ãàðàíòèðîâàíèå ïîëíîòû è ïðàâèëüíîñòè ïðåäñòàâëåííûõ ìàòåðèàëîâ è óäîâëåòâîðåíèÿ èìè ïîòðåáíîñòåé çàêàç÷èêà â ñîîòâåòñòâèè ñ óñëîâèÿìè äîãîâîðà è ïëàíîì äîêóìåíòèðîâàíèÿ.

Ïðîâåðêà äîëæíà ïðîâîäèòüñÿ ïåðñîíàëîì çàêàç÷èêà, îáëàäàþùèì ñîîòâåòñòâóþùåé êâàëèôèêàöèåé è ïîëíîìî÷èÿìè ïî ïðåäëîæåíèþ èçìåíåíèé â äîêóìåíòàöèþ è óòâåðæäåíèþ èçìåíåííîé äîêóìåíòàöèè.

Ïðèìå÷àíèå - Çàêàç÷èê äîëæåí îãðàíè÷èòü êîëè÷åñòâî ïðîâåðÿþùèõ ëèö äî ïðåäåëîâ, íåîáõîäèìûõ äëÿ ðåàëèçàöèè ôóíêöèè ïðîâåðêè.

Ïðè óòâåðæäåíèè (ñîãëàñîâàíèè) êàæäîãî ïðîåêòà äîêóìåíòàöèè çàêàç÷èê äîëæåí ãàðàíòèðîâàòü ïðàâèëüíîñòü ðåøåíèÿ âîïðîñîâ åå çàùèòû è çàêîííîñòè.

Äîêóìåíòàöèÿ äëÿ ïðîâåðêè äîëæíà ïðåäñòàâëÿòüñÿ ñ ñîïðîâîäèòåëüíûì ïèñüìîì îò äîêóìåíòàòîðà, â êîòîðîì äîëæíû áûòü óêàçàíû öåëè ïðîâåðêè è îáÿçàííîñòè ïðîâåðÿþùåé ñòîðîíû (ýêñïåðòà).

Ïðèìå÷àíèÿ

1. Êà÷åñòâî äîêóìåíòàöèè è óñïåøíîñòü ïðîâåðîê ïîâûøàþòñÿ ïðè íàëè÷èè õîðîøèõ êîíòàêòîâ ìåæäó çàêàç÷èêîì è äîêóìåíòàòîðîì â ïðîöåññå ðàçðàáîòêè äîêóìåíòàöèè. Ïðè ýòîì äîëæíî áûòü ïðåäóñìîòðåíî íåôîðìàëüíîå îáñóæäåíèå âîçíèêàþùèõ âîïðîñîâ è ïî âîçìîæíîñòè ðàííåå ïðåäñòàâëåíèå çàêàç÷èêó îáðàçöîâ äîêóìåíòàöèè èëè ïðåäâàðèòåëüíûõ ìàòåðèàëîâ.

2. Äîãîâîð ìîæåò áûòü ñêîððåêòèðîâàí ïðè íåîáõîäèìîñòè âíåñåíèÿ â íåãî èçìåíåíèé, íå ñâÿçàííûõ ñ îáëàñòüþ äåéñòâèÿ äîãîâîðà èëè ïëàíà äîêóìåíòèðîâàíèÿ.

3. Îòìåòèì, ÷òî ïðîâåäåíèå ïðîâåðêè íå îñâîáîæäàåò äîêóìåíòàòîðîâ îò îáÿçàííîñòåé ïî ãàðàíòèðîâàíèþ ìàêñèìàëüíî âîçìîæíîé ïîëíîòû è òî÷íîñòè äîêóìåíòàöèè.

4. Íåïîñðåäñòâåííî ïåðåä ïðåäñòàâëåíèåì ëþáîé ïóáëèêàöèè íà óòâåðæäåíèå, â íåé äîëæíû áûòü îáíîâëåíû âñå ðàñïå÷àòêè ýêðàíîâ äëÿ ãàðàíòèðîâàíèÿ åå àêòóàëüíîñòè.

5. Ðåçóëüòàòû ïðîâåðîê ïðåäñòàâëÿþòñÿ çàêàç÷èêîì äîêóìåíòàòîðó â âèäå ïîìåòîê â ïðîåêòå äîêóìåíòàöèè èëè ïèñüìåííûõ êîììåíòàðèåâ ïî åãî ñîäåðæàíèþ. Çàêàç÷èê äîëæåí õðàíèòü êîïèè âñåõ âíîñèìûõ èçìåíåíèé äëÿ ñðàâíåíèÿ èõ ñ ïîñëåäóþùèìè ïðîåêòàìè äîêóìåíòàöèè. Ïðåäñòàâëÿåìûå çàêàç÷èêîì êîììåíòàðèè äîëæíû áûòü â âèäå, ïîçâîëÿþùåì ïåðñîíàëó ðàçðàáîò÷èêîâ äîêóìåíòàöèè âíåñòè ïðåäëàãàåìûå èçìåíåíèÿ â ïðîåêò äîêóìåíòàöèè áåç äàëüíåéøèõ ïîÿñíåíèé.

6. Äëÿ áîëüøèõ ñëîæíûõ ñèñòåì èëè ñèñòåì, ðàçðàáàòûâàåìûõ îäíîâðåìåííî ñ äîêóìåíòàöèåé, ìîæåò áûòü íåîáõîäèìî áîëåå äâóõ ïðîåêòîâ äîêóìåíòàöèè è íàëè÷èå ãðàíîê.  ýòîì ñëó÷àå ìàêñèìàëüíîå ÷èñëî ïðîåêòîâ (ðåäàêöèé) äîêóìåíòàöèè äîëæíî áûòü îãîâîðåíî ìåæäó çàêàç÷èêîì è äîêóìåíòàòîðîì è óêàçàíî â ïëàíå äîêóìåíòèðîâàíèÿ.

7. Ïðè ïðîâåðêå ïðîåêòîâ äîêóìåíòàöèè èñïîëüçóþò ðåäàêöèîííûå ðàçìåòêè (çíàêè, öâåòà, ðàçìåòêà øðèôòîâ è ïðî÷åå). Öåëüþ ðåäàêöèîííûõ ðàçìåòîê ÿâëÿåòñÿ âûäåëåíèå ÷àñòåé ïóáëèêàöèè, íóæäàþùèõñÿ â óòî÷íåíèè. Òåì ñàìûì ïðåäîòâðàùàåòñÿ íåîáõîäèìîñòü â ïîâòîðíûõ ïðîâåðêàõ ïðîåêòîâ. Íàñòîÿòåëüíî ðåêîìåíäóåòñÿ äëÿ âíåñåíèÿ ðåäàêöèîííîé ðàçìåòêè èñïîëüçîâàòü ñðåäñòâà àâòîìàòèçèðîâàííîãî ñðàâíåíèÿ äîêóìåíòîâ (ïðè èõ íàëè÷èè).

Ïðè ðåäàêöèîííîé ðàçìåòêå ðåêîìåíäóåòñÿ:

a) íå âíîñèòü ðàçìåòêó â ðàñïå÷àòêó ïåðâîãî ïðîåêòà (ðåäàêöèè) íîâîé ïóáëèêàöèè;

b) èñïîëüçîâàòü ðàçìåòêó äëÿ ïîêàçà èçìåíåíèé, âíîñèìûõ â îðèãèíàë ïðîâåðÿåìîé ïóáëèêàöèè;

c) âî âòîðîì ïðîåêòå èñïîëüçîâàòü ðàçìåòêè ñ íîìåðîì 1 äëÿ óêàçàíèÿ èçìåíåíèé, âíåñåííûõ ïî ðåçóëüòàòàì ïðîâåðêè ïåðâîé ðåäàêöèè;

d) â òðåòüåì ïðîåêòå èñïîëüçîâàòü ðàçìåòêè ñ íîìåðîì 2 àíàëîãè÷íî íîìåðó 1;

e) ïîñëå ïðèíÿòèÿ òðåòüåãî ïðîåêòà âñå ðàçìåòêè â íåì äîëæíû áûòü ñîõðàíåíû äî ïðîâåðêè ãðàíîê ïóáëèêàöèè.

8.1.4.2 Ïðîâåðêà ïëàíà äîêóìåíòèðîâàíèÿ

Äàííàÿ ïðîâåðêà äîëæíà ãàðàíòèðîâàòü, ÷òî äîêóìåíòàöèÿ, ïðåäóñìîòðåííàÿ ïëàíîì äîêóìåíòèðîâàíèÿ, ïîñëå åãî âûïîëíåíèÿ áóäåò óäîâëåòâîðÿòü öåëÿì çàêàç÷èêà. Ïðè óòâåðæäåíèè ïëàíà äîêóìåíòèðîâàíèÿ çàêàç÷èê ñîãëàñîâûâàåò âñå õàðàêòåðèñòèêè íîìåíêëàòóðû ïîñòàâêè, ïðåäóñìîòðåííîé ïëàíîì.

Ïðèìå÷àíèå - Çàêàç÷èêè äîëæíû óäåëÿòü îñîáîå âíèìàíèå ñòðóêòóðå, ïîëíîòå è ïðàêòè÷íîñòè äîêóìåíòàöèè â ñîîòâåòñòâèè ñ ïëàíîì-ïðîñïåêòîì åå ñîäåðæàíèÿ. Ïëàí äîêóìåíòèðîâàíèÿ äîëæåí áûòü ïðîâåðåí è óòâåðæäåí (ñîãëàñîâàí) äî íà÷àëà ðàáîò íàä ïåðâûì ïðîåêòîì äîêóìåíòàöèè. Ðåêîìåíäàöèè ïî îöåíêå ïëàíà ïðèâåäåíû â ïðèëîæåíèè G.

8.1.4.3 Ïðîâåðêà ïåðâîé ðåäàêöèè

Ïåðâàÿ ðåäàêöèÿ (ïðîåêò) äîëæíà ñîäåðæàòü îñíîâíóþ ÷àñòü äîêóìåíòàöèè â ñîîòâåòñòâèè ñ ïëàíîì äîêóìåíòèðîâàíèÿ, à òàêæå ñîäåðæàíèå, ïðèëîæåíèÿ è ñëîâàðü (ñëîâíèê, îïðåäåëåíèÿ). Ïðè ïðèìåíåíèè ñðåäñòâ àâòîìàòè÷åñêîãî ñîçäàíèÿ óêàçàòåëÿ êàæäàÿ åãî ïðåäìåòíàÿ ðóáðèêà (èíäåêñ) äîëæíà ññûëàòüñÿ íà êîíêðåòíûå ïóíêòû äîêóìåíòàöèè. Îðôîãðàôèÿ, ïóíêòóàöèÿ, ñòèëü è êîìïîíîâêà äîêóìåíòàöèè äîëæíû ñîîòâåòñòâîâàòü óêàçàííûì â ïëàíå äîêóìåíòèðîâàíèÿ.

Ïåðâûé ïðîåêò äîêóìåíòàöèè äîëæåí áûòü ïðîâåðåí çàêàç÷èêîì. Äàííàÿ ïðîâåðêà ïðåäíàçíà÷åíà äëÿ êîíòðîëÿ òåõíè÷åñêîé ïðàâèëüíîñòè è ïîëíîòû äîêóìåíòàöèè è äîëæíà ãàðàíòèðîâàòü ñîîòâåòñòâèå äàííîãî ïðîåêòà çàäàíèÿì ïëàíà äîêóìåíòèðîâàíèÿ. Òàêæå ïðîâåðÿþò ñîîòâåòñòâèå îðôîãðàôèè, ïóíêòóàöèè, ñòèëÿ è êîìïîíîâêè äîêóìåíòàöèè òðåáîâàíèÿì ïëàíà äîêóìåíòèðîâàíèÿ.

Ïðè óòâåðæäåíèè ïåðâîãî ïðîåêòà çàêàç÷èê ñîãëàñîâûâàåò òåõíè÷åñêóþ ïðàâèëüíîñòü, ñòðóêòóðó, ïîíÿòíîñòü è ïîëíîòó äîêóìåíòàöèè, èñêëþ÷àÿ ïðåäëîæåííûå èçìåíåíèÿ.

Ïðèìå÷àíèÿ

1. Ïåðåä ïðåäúÿâëåíèåì çàêàç÷èêó ïåðâûé ïðîåêò äîëæåí áûòü îòðåäàêòèðîâàí ïî ñëåäóþùèì ïðè÷èíàì:

a) ÷òîáû ïðîâåðÿþùèé íå îòâëåêàëñÿ íà êîððåêòèðîâêó òèïîãðàôñêèõ è êîìïîíîâî÷íûõ îøèáîê;

b) ÷òîáû ëþáûå òåõíè÷åñêèå íåòî÷íîñòè, âíåñåííûå ïðè ðåäàêòèðîâàíèè, áûëè îáíàðóæåíû ïðîâåðÿþùèì.

2. Ïðîåêò äîëæåí áûòü ïðîâåðåí íà ñîîòâåòñòâèå âûäàííûì çàäàíèÿì, óêàçàííîé àóäèòîðèè, ñîäåðæàíèþ è äðóãèì õàðàêòåðèñòèêàì, ñîãëàñîâàííûì â ïëàíå äîêóìåíòèðîâàíèÿ. Ïåðåä âîçâðàòîì ïåðâîãî ïðîåêòà ñ êîììåíòàðèÿìè äîêóìåíòàòîðó çàêàç÷èê äîëæåí áûòü óâåðåí, ÷òî ïðîåêò, âêëþ÷àÿ âñå êîððåêòèðîâêè, ñîîòâåòñòâóåò ïëàíó äîêóìåíòèðîâàíèÿ.

8.1.4.4 Ïðîâåðêà âòîðîãî ïðîåêòà

Âî âòîðîé ïðîåêò äîêóìåíòàöèè äîëæíû áûòü âêëþ÷åíû âñå èçìåíåíèÿ, ñîãëàñîâàííûå ñ çàêàç÷èêîì ïðè ïðîâåðêå ïåðâîãî ïðîåêòà, à êîìïëåêòíîñòü ïîñòàâêè âòîðîãî ïðîåêòà ïî âîçìîæíîñòè äîëæíà ñîîòâåòñòâîâàòü íîìåíêëàòóðå ïîñòàâêè, îãîâîðåííîé â ïëàíå äîêóìåíòèðîâàíèÿ.

Äàííàÿ ïðîâåðêà ïðåäíàçíà÷åíà äëÿ êîíòðîëÿ ïðàâèëüíîñòè âíåñåíèÿ â äîêóìåíòàöèþ âñåõ èçìåíåíèé, óêàçàííûõ çàêàç÷èêîì íà ýòàïå ïåðâîãî ïðîåêòà.

Ïðè óòâåðæäåíèè âòîðîãî ïðîåêòà çàêàç÷èê ñîãëàñîâûâàåò âñå àñïåêòû äîêóìåíòàöèè çà èñêëþ÷åíèåì ôèçè÷åñêîé ôîðìû ïðåäñòàâëåíèÿ äîêóìåíòàöèè ïî äàííîìó ïðîåêòó, êîòîðàÿ ìîæåò íå ñîîòâåòñòâîâàòü óêàçàííîé â íîìåíêëàòóðå ïîñòàâêè.

Ïðèìå÷àíèå - Ïðè óòâåðæäåíèè âòîðîãî ïðîåêòà çàêàç÷èê äîëæåí áûòü óâåðåí, ÷òî ïî äàííîìó ïðîåêòó (âêëþ÷àÿ âíåñåííûå èçìåíåíèÿ ïî ðåçóëüòàòàì ïðîâåðêè ïåðâîãî ïðîåêòà) ìîãóò áûòü èçãîòîâëåíû ãðàíêè.

8.1.4.5 Ïðîâåðêà ãðàíîê

 ïîäãîòîâëåííûå ãðàíêè äîêóìåíòàöèè äîëæíû áûòü âíåñåíû âñå èçìåíåíèÿ, óêàçàííûå çàêàç÷èêîì ïðè ïðîâåðêå âòîðîãî ïðîåêòà.

Äàííàÿ ïðîâåðêà ïðåäíàçíà÷åíà äëÿ êîíòðîëÿ ïðàâèëüíîñòè âíåñåíèÿ â äîêóìåíòàöèþ âñåõ èçìåíåíèé, óêàçàííûõ çàêàç÷èêîì íà ýòàïå âòîðîãî ïðîåêòà. Ëþáûå îáíàðóæåííûå çàêàç÷èêîì íåñîîòâåòñòâèÿ äîëæíû áûòü íåìåäëåííî äîâåäåíû äî ñâåäåíèÿ äîêóìåíòàòîðà, êîòîðûé äîëæåí ñîîòâåòñòâóþùèì îáðàçîì ìîäèôèöèðîâàòü äîêóìåíòàöèþ è ïðåäñòàâèòü êîïèè èçìåíåííûõ ðàçäåëîâ çàêàç÷èêó äëÿ äàëüíåéøåé ïðîâåðêè.

Óòâåðæäàÿ (ñîãëàñîâûâàÿ) ãðàíêè äîêóìåíòàöèè, çàêàç÷èê ïîäòâåðæäàåò ãîòîâíîñòü êîíêðåòíîãî äîêóìåíòà ê ïðîèçâîäñòâó (òèðàæèðîâàíèþ).

8.1.5 Òåñòèðîâàíèå äîêóìåíòàöèè íà ïðàêòè÷íîñòü

8.1.5.1 Îáùèå ïîëîæåíèÿ

 ïëàíå äîêóìåíòèðîâàíèÿ äîëæåí áûòü óêàçàí òðåáóåìûé óðîâåíü òåñòèðîâàíèÿ äîêóìåíòàöèè íà ïðàêòè÷íîñòü.

Ìèíèìàëüíî äîëæíî áûòü ïðîâåäåíî îäíî òåñòèðîâàíèå íà ïðàêòè÷íîñòü äîêóìåíòàöèè, èñïîëüçóåìîé äëÿ âûïóñêàåìîé âåðñèè ïðîãðàììíîãî ñðåäñòâà.

Ïðèìå÷àíèÿ

1. Òåñòèðîâàíèå íà ïðàêòè÷íîñòü ñëåäóåò ðàññìàòðèâàòü êàê äîïîëíåíèÿ ê ïðîâîäèìûì ïðîâåðêàì è àíàëèçàì äîêóìåíòàöèè. Ïîäîáíîå òåñòèðîâàíèå ïðè ðàçðàáîòêå äîëæíî ïðîâîäèòüñÿ íà ïðîòîòèïå äîêóìåíòàöèè, íàèáîëåå ïîëíî ìîäåëèðóþùåì åå îêîí÷àòåëüíóþ âåðñèþ.

2. Ïðè óñòàíîâëåíèè óñëîâèé äàííîãî òåñòèðîâàíèÿ äîëæåí áûòü ïîëíîñòüþ óêàçàí ñòàíäàðò íà õàðàêòåðèñòèêè ïðàêòè÷íîñòè, ïî êîòîðîìó ïðîâîäÿò èçìåðåíèå. Ñëåäóåò òàêæå îïðåäåëèòü ñîîòâåòñòâóþùèé(å) ìåòîä(û) èçìåðåíèÿ è ïðîöåññ îïèñàíèÿ ðåçóëüòàòîâ çàìåðîâ.

3. Ïðè íåîáõîäèìîñòè â ïëàíå äîêóìåíòèðîâàíèÿ ñëåäóåò îïðåäåëèòü ñðåäó òåñòèðîâàíèÿ, êîòîðàÿ äîëæíà ïîëíîñòüþ ñîîòâåòñòâîâàòü ýêñïëóàòàöèîííîé ñðåäå êîíå÷íîãî ïîëüçîâàòåëÿ.

4. Òåñòèðîâàíèå íà ïðàêòè÷íîñòü ìîæåò áûòü èñïîëüçîâàíî äëÿ îöåíêè (èçìåðåíèÿ) ïðàêòè÷íîñòè ïî ÃÎÑÒ Ð ÈÑÎ/ÌÝÊ 12119.

8.1.5.2 Ïëàíèðîâàíèå

 ïëàíå äîêóìåíòèðîâàíèÿ äîëæíû áûòü ïîëíîñòüþ îïèñàíû óñëîâèÿ òåñòèðîâàíèÿ, âêëþ÷àÿ:

a) ýòàï(û) æèçíåííîãî öèêëà ðàçðàáîòêè, íà êîòîðîì(ûõ) äîëæíî ïðîâîäèòüñÿ òåñòèðîâàíèå;

b) öåëè òåñòèðîâàíèÿ;

c) èñïîëüçóåìûå ïîêàçàòåëè (íàïðèìåð, âðåìÿ ðåàêöèè çàäà÷);

d) ñðåäó òåñòèðîâàíèÿ;

e) ÷èñëî è âèä ïðèâëåêàåìûõ ïîëüçîâàòåëåé;

f) ïðîöåññ îïèñàíèÿ ðåçóëüòàòîâ òåñòèðîâàíèÿ è ðåêîìåíäàöèé ïî íèì;

g) ïðîöåññ îáåñïå÷åíèÿ ðåàëèçàöèè ðåêîìåíäàöèé ïî ðåçóëüòàòàì òåñòèðîâàíèÿ;

h) ïðîöåññ äîâåäåíèÿ ðåçóëüòàòîâ òåñòèðîâàíèÿ äî âñåãî ïåðñîíàëà ðàçðàáîò÷èêîâ äîêóìåíòàöèè è çàêàç÷èêà;

i) îáÿçàííîñòè ïåðñîíàëà ðàçðàáîò÷èêîâ äîêóìåíòàöèè, ó÷àñòâóþùåãî â òåñòèðîâàíèè;

j) ïðîöåññ îïðåäåëåíèÿ íåîáõîäèìîñòè ïîñëåäóþùåãî òåñòèðîâàíèÿ.

Ïðèìå÷àíèÿ

1. Ïðè ïðîâåäåíèè òåñòèðîâàíèÿ äîêóìåíòàöèè íà ïðàêòè÷íîñòü íåîáõîäèìî ïðîâåðèòü ñîîòâåòñòâèå äîêóìåíòîâ êîíêðåòíîìó ïðîãðàììíîìó ñðåäñòâó. Äëÿ ïîâûøåíèÿ ýôôåêòèâíîñòè äàííîãî òåñòèðîâàíèÿ åãî íåîáõîäèìî ïðîâîäèòü êàê ìîæíî ðàíüøå, âíîñÿ íåîáõîäèìûå èçìåíåíèÿ êàê â ñàìî ïðîãðàììíîå ñðåäñòâî, òàê è â åãî äîêóìåíòàöèþ.

2. Ïðè ñîñòàâëåíèè ãðàôèêà òåñòèðîâàíèÿ íåîáõîäèìî ó÷èòûâàòü òåñòèðîâàíèå îòäåëüíûõ êîìïîíåíòîâ (÷àñòåé) ïðîãðàììíîãî ñðåäñòâà è âûïîëíÿåìûõ èìè ôóíêöèé.

8.1.5.3 Ïðîãðàììíûå ñðåäñòâà

Êîãäà òåñòèðîâàíèå çàïëàíèðîâàíî äî çàâåðøåíèÿ ðàçðàáîòêè ïðîãðàììíîãî ñðåäñòâà, ïðè åãî ïðîâåäåíèè äîëæíà áûòü èñïîëüçîâàíà ðàáî÷àÿ ìîäåëü èëè ïðîòîòèï äàííîãî ñðåäñòâà. Ïðè ïðîâåäåíèè òåñòèðîâàíèÿ ïîñëå çàâåðøåíèÿ ðàçðàáîòêè ïðîãðàììíîãî ñðåäñòâà ñëåäóåò èñïîëüçîâàòü âûïóñêàåìóþ âåðñèþ äàííîãî ïðîãðàììíîãî ñðåäñòâà.

8.1.5.4 Òèïîâûå ïîëüçîâàòåëè

 ïðîâåäåíèè òåñòèðîâàíèÿ äîêóìåíòàöèè íà ïðàêòè÷íîñòü äîëæíû ó÷àñòâîâàòü ïðåäñòàâèòåëè çàêàç÷èêà. Äàííûìè ïðåäñòàâèòåëÿìè äîëæíû ÿâëÿòüñÿ ëèöà, èìåþùèå òîò æå îïûò (íàâûêè, îáðàçîâàíèå è ò.ä.), ÷òî è ïîëüçîâàòåëè èç êîíêðåòíîé àóäèòîðèè. Öåëè èõ ó÷àñòèÿ â òåñòèðîâàíèè äîëæíû áûòü îïðåäåëåíû çàêàç÷èêîì.

Ïðèìå÷àíèå - Äëÿ ó÷àñòèÿ â òåñòèðîâàíèè ïî âîçìîæíîñòè äîëæíû áûòü ïðèâëå÷åíû ëèöà èç êîíêðåòíîé àóäèòîðèè.

8.1.6 Äîêóìåíòàöèÿ, ðàçðàáîòàííàÿ äðóãèìè êîìïàíèÿìè ïî ñóáïîäðÿäàì

Äîêóìåíòàòîð (ãîëîâíîé ïîäðÿä÷èê) äîëæåí ãàðàíòèðîâàòü ñîîòâåòñòâèå äîêóìåíòàöèè, ðàçðàáîòàííîé ñóáïîäðÿä÷èêàìè, íàñòîÿùåìó ñòàíäàðòó, ïëàíó äîêóìåíòèðîâàíèÿ è äîãîâîðó.

 îòíîøåíèè äîêóìåíòàöèè, ðàçðàáàòûâàåìîé ñóáïîäðÿä÷èêîì, äîêóìåíòàòîð âûñòóïàåò â ðîëè çàêàç÷èêà, à ñóáïîäðÿä÷èê - äîêóìåíòàòîðà.

Ïðèìå÷àíèå - Äîêóìåíòàòîð äîëæåí çàêëþ÷èòü ñîãëàøåíèÿ ñ ñóáïîäðÿä÷èêàìè â ñîîòâåòñòâèè ñ íàñòîÿùèì ñòàíäàðòîì.

8.1.7 Êîíòðîëü èçìåíåíèé è ñîïðîâîæäåíèå äîêóìåíòàöèè

8.1.7.1 Îáùèå ïîëîæåíèÿ

 ïëàíå äîêóìåíòèðîâàíèÿ äîëæíû áûòü ïðåäóñìîòðåíû ñëåäóþùèå ÷åòûðå òèïà èçìåíåíèé äîêóìåíòàöèè:

a) ôóíêöèîíàëüíûå èçìåíåíèÿ äàííîé âåðñèè (this-version function changes) - èçìåíåíèÿ ôóíêöèè ïðîãðàììíîãî ñðåäñòâà, âíåñåííûå ïðè ðàçðàáîòêå äîêóìåíòàöèè è îòðàæåííûå â îïóáëèêîâàííîé äîêóìåíòàöèè;

b) ôóíêöèîíàëüíûå èçìåíåíèÿ ïîñëåäóþùåé âåðñèè (next-version function changes) - èçìåíåíèÿ ôóíêöèè ïðîãðàììíîãî ñðåäñòâà, âíåñåííûå ïðè ðàçðàáîòêå äîêóìåíòàöèè è íå îòðàæåííûå â îïóáëèêîâàííîé äîêóìåíòàöèè, íî ïîäëåæàùèå ó÷åòó â ïîñëåäóþùåé ðåäàêöèè äîêóìåíòàöèè.

Ïðèìå÷àíèå - Ðàçëè÷èå ìåæäó ïåðå÷èñëåíèÿìè à) è b) îáû÷íî îïðåäåëÿåòñÿ òåðìèíîì «äàòà ïåðåñìîòðà (cut-off date)»;

c) èçìåíåíèÿ ïðîãðàììíîãî ñðåäñòâà ïîñëå ïóáëèêàöèè (post-publication software changes) - èçìåíåíèÿ êîíêðåòíûõ ôóíêöèé ïðîãðàììíîãî ñðåäñòâà ïîñëå èçäàíèÿ äàííîé äîêóìåíòàöèè;

d) èçìåíåíèÿ äîêóìåíòà ïîñëå ïóáëèêàöèè (post-publication document changes) - èçìåíåíèÿ â îïóáëèêîâàííîé äîêóìåíòàöèè, îáóñëîâëåííûå èçìåíåíèÿìè ïðîãðàììíîãî ñðåäñòâà èëè îáíàðóæåíèåì ïîãðåøíîñòåé â äàííîé äîêóìåíòàöèè.

8.1.7.2 Ïðîöåäóðû

Äîêóìåíòàòîð äîëæåí îáåñïå÷èòü ïðîåêòèðîâàíèå äîêóìåíòàöèè òàê, ÷òîáû äîïóñòèòü âíåñåíèå â íåå èçìåíåíèé âñåõ ÷åòûðåõ òèïîâ. Äëÿ ýòîãî íåîáõîäèìî, ÷òîáû:

a) áûëà ïðåäóñìîòðåíà ïðîöåäóðà âíåñåíèÿ êàæäîãî òèïà èçìåíåíèé â äîêóìåíò.

Ïðèìå÷àíèå - Ðàçðàáîò÷èêè äîêóìåíòàöèè îáû÷íî äîëæíû ïîëó÷àòü ó÷òåííûå êîïèè èçìåíåíèé ïðîãðàììíîãî ñðåäñòâà, ïîäòâåðæäàþùèå âíåñåíèå ñîîòâåòñòâóþùèõ èçìåíåíèé â äàííîå ñðåäñòâî ïîñëå êîíêðåòíîé äàòû åãî ïåðåñìîòðà;

b) íàèìåíîâàíèå äîêóìåíòà è íîìåð âåðñèè èëè äàòà áûëè óêàçàíû â âåðõíåì èëè íèæíåì êîëîíòèòóëå êîíêðåòíîãî äîêóìåíòà;

c) â áóìàæíîì äîêóìåíòå ñ çàìåíåííûìè ñòðàíèöàìè áûëà ïðåäóñìîòðåíà òàáëèöà äåéñòâóþùèõ ñòðàíèö (ëèñò èçìåíåíèé) èëè íå÷òî ïîäîáíîå, ïîçâîëÿþùåå ïîëüçîâàòåëþ êîíòðîëèðîâàòü íàëè÷èå êàæäîé ñòðàíèöû äîêóìåíòà;

d) äîïîëíèòåëüíî áûëè ïðåäóñìîòðåíû ìåòîäû, îáåñïå÷èâàþùèå âíåñåíèå èçìåíåíèé â êàæäóþ ó÷òåííóþ êîïèþ êîíêðåòíîãî äîêóìåíòà;

e) äîïîëíèòåëüíî áûë ïðåäóñìîòðåí ìåòîä, ïîçâîëÿþùèé ïîëüçîâàòåëþ êîíòðîëèðîâàòü ñîîòâåòñòâèå êîíêðåòíîé êîïèè äàííîãî äîêóìåíòà èñïîëüçóåìîé âåðñèè ïðîãðàììíîãî ñðåäñòâà.

 äîãîâîðå äîëæíî áûòü îãîâîðåíî, ÷òî èçìåíåíèÿ êàæäîãî òèïà âíîñÿòñÿ â äîêóìåíòàöèþ äîêóìåíòàòîðîì.

8.2 Ñîäåðæàíèå ñïåöèôèêàöèè ñòèëÿ

8.2.1 Îáùèå ïîëîæåíèÿ

 äàííîì ïîäðàçäåëå îïðåäåëåíî ñîäåðæàíèå ñïåöèôèêàöèè ñòèëÿ äîêóìåíòàöèè.

Ïðèìå÷àíèå - Äîïîëíèòåëüíûå ðåêîìåíäàöèè ïî äàííîìó âîïðîñó ïðèâåäåíû â ïðèëîæåíèè Í.  äàííóþ ñïåöèôèêàöèþ äîïîëíèòåëüíî ìîãóò áûòü âêëþ÷åíû êîíêðåòíûå ñòàíäàðòû è ðóêîâîäñòâà èëè ïðèâåäåíû ññûëêè íà ñîîòâåòñòâóþùèå ðàçäåëû ïëàíà äîêóìåíòèðîâàíèÿ.

8.2.2 Ñòèëü îïèñàíèÿ

8.2.2.1 ßçûê

Äîëæåí áûòü óêàçàí ÿçûê, íà êîòîðîì ñîñòàâëåíà äîêóìåíòàöèÿ äëÿ êîíêðåòíîé ñòðàíû, íàïðèìåð ôðàíöóçñêèé (äëÿ Êàíàäû).

8.2.2.2 Îðôîãðàôèÿ

Ïðè íåîáõîäèìîñòè äëÿ ïðèíÿòîãî ÿçûêà äîëæåí áûòü óêàçàí ñîîòâåòñòâóþùèé îðôîãðàôè÷åñêèé ñëîâàðü è, ïî âîçìîæíîñòè, ñïèñîê èñêëþ÷åíèé èç íåãî.

Ïðèìå÷àíèå - Äîëæåí áûòü îïðåäåëåí íàöèîíàëüíûé îðôîãðàôè÷åñêèé ñëîâàðü, óäîâëåòâîðÿþùèé èíòåðåñàì îñíîâíîé àóäèòîðèè ïîëüçîâàòåëåé â äàííîé ñòðàíå. Ïî âîçìîæíîñòè ñëîâàðü ñëåäóåò ïðåäñòàâèòü â âèäå ôàéëà îðôîãðàôè÷åñêîãî êîíòðîëÿ.

8.2.2.3 Ãðàììàòèêà è åå ïðèìåíåíèå

Äîëæíû áûòü ïðèâåäåíû ðåêîìåíäàöèè ïî ãðàììàòèêå ÿçûêà è ñòèëþ åå ïðèìåíåíèÿ.

Ïðèìå÷àíèå - Äîëæåí áûòü îïðåäåëåí ñòàíäàðò ïî íàöèîíàëüíîé ãðàììàòèêå è åå ïðèìåíåíèþ â èíòåðåñàõ îñíîâíîé àóäèòîðèè ïîëüçîâàòåëåé â äàííîé ñòðàíå.

8.2.3 Áóìàæíàÿ äîêóìåíòàöèÿ

8.2.3.1 Êîìïîíîâêà è îðèãèíàë-ìàêåòû

8.2.3.1.1 Ðàçìåð (ôîðìàò) áóìàãè

Äîëæåí áûòü îïðåäåëåí èñïîëüçóåìûé ðàçìåð áóìàãè.

Ïðèìå÷àíèå - Ïðè âûáîðå ðàçìåðà áóìàãè äîëæíî áûòü ó÷òåíî ñëåäóþùåå:

à) ôîðìàòû À4, À5 è Â5 óêàçàíû â íàñòîÿùåì ñòàíäàðòå (ñì. 4.1 è 4.5);

b) êàê áóäóò õðàíèòüñÿ äàííûå äîêóìåíòû (â íåêîòîðûõ àðõèâàõ âîçíèêàþò ïðîáëåìû ñ õðàíåíèåì äîêóìåíòîâ â êîíêðåòíûõ ôîðìàòàõ);

c) èñïîëüçóþòñÿ ëè ðàñïå÷àòêè ýêðàíîâ (ðàñïå÷àòêè öåëûõ ýêðàíîâ â ôîðìàòå À5 íåäîñòàòî÷íî ðàçáîð÷èâû);

d) èñïîëüçóåìûé íàöèîíàëüíûé ñòàíäàðòíûé ôîðìàò áóìàãè, åñëè äîêóìåíòàöèÿ ïðåäñòàâëÿåòñÿ â âèäå ôîòîêîïèé;

e) òðåáîâàíèÿ ê ìîáèëüíîñòè è ðàáî÷åé îáëàñòè äîêóìåíòàöèè.

8.2.3.1.2 Îðèåíòàöèÿ (ðàñïîëîæåíèå)

Äîëæíà áûòü îïðåäåëåíà îðèåíòàöèÿ êîíêðåòíîé ñòðàíèöû äîêóìåíòà êàê êíèæíàÿ (âåðòèêàëüíàÿ) èëè àëüáîìíàÿ (ãîðèçîíòàëüíàÿ). Ïðè íåîáõîäèìîñòè äëÿ ÿçûêîâ, äîïóñêàþùèõ âàðèàíòû îðèåíòàöèè òåêñòà, ñëåäóåò åå óêàçàòü (íàïðèìåð, ñâåðõó âíèç, ñïðàâà íàëåâî, íà ðàçâîðîòå èëè îáîðîòå ïî îòíîøåíèþ ê êðûøêå ïåðåïëåòà).

8.2.3.1.3 Îäíî- èëè äâóñòîðîííÿÿ ïå÷àòü

Ñëåäóåò óêàçàòü, áóäåò ëè äîêóìåíòàöèÿ ïå÷àòàòüñÿ â îäíî- èëè äâóñòîðîííåì ôîðìàòå.

Ïðèìå÷àíèå - Äâóñòîðîííèé ôîðìàò ñëåäóåò ïðèìåíÿòü ïðè ïå÷àòíîì ñïîñîáå âûïóñêà èñõîäíîãî ìàòåðèàëà, òàê êàê ïðè ýòîì ðàñõîäóåòñÿ ìåíüøå áóìàãè. Äâóñòîðîííèé ôîðìàò ìîæíî èñïîëüçîâàòü ïðè âûïóñêå ôîòîêîïèé èñõîäíîãî ìàòåðèàëà. Îäíîñòîðîííèé ôîðìàò ìîæåò áûòü âûáðàí èç-çà ñîîáðàæåíèé ïðàêòè÷íîñòè äîêóìåíòàöèè.

8.2.3.1.4 Ðàçðåøàþùàÿ ñïîñîáíîñòü òèïîãðàôñêîãî èëè ëàçåðíîãî ñïîñîáà ïå÷àòè

Äîëæíà áûòü îïðåäåëåíà ìèíèìàëüíî äîïóñòèìàÿ ðàçðåøàþùàÿ ñïîñîáíîñòü ïå÷àòè (êîëè÷åñòâî òî÷åê â 1 äþéìå/1 ìì).

Ïðèìå÷àíèå - Ìèíèìàëüíî ðåêîìåíäóåìîé ÿâëÿåòñÿ ðàçðåøàþùàÿ ñïîñîáíîñòü 300 òî÷åê/äþéì.

8.2.3.1.5 Øèðèíà âíóòðåííåãî ïîëÿ

Äîëæíî áûòü îïðåäåëåíî ðàññòîÿíèå îò ïîëîñû íàáîðà äî êîðåøêà ïåðåïëåòà.

8.2.3.1.6. Øèðèíà âíåøíèõ ïîëåé

Äîëæíû áûòü îïðåäåëåíû ðàññòîÿíèÿ îò ïîëîñû íàáîðà äî âíåøíèõ êðàåâ ñòðàíèöû.

8.2.3.1.7 Öâåòà êðàñîê

Äîëæíû áûòü îïðåäåëåíû öâåòà êðàñîê, èñïîëüçóåìûõ ïðè ïå÷àòè.

Ïðèìå÷àíèå - Åñëè â ïëàíå äîêóìåíòèðîâàíèÿ èëè â äîãîâîðå óêàçàíî íåñêîëüêî öâåòîâ, ëþáîé äîêóìåíòàòîð, íå êîìïåòåíòíûé â îáëàñòè ìíîãîöâåòíîé ïå÷àòè, äîëæåí çàðàíåå (äî ïðåäúÿâëåíèÿ ãðàíîê çàêàç÷èêó) îáðàòèòüñÿ çà êîíñóëüòàöèåé ê ñîîòâåòñòâóþùèì ñïåöèàëèñòàì.

8.2.3.1.8 Öâåò, ìàññà è êà÷åñòâî áóìàãè

Äîëæíû áûòü îïðåäåëåíû öâåò, ìàññà è êà÷åñòâî (íîìåð) áóìàãè, èñïîëüçóåìîé äëÿ äîêóìåíòàöèè.

Ïðèìå÷àíèå - Åñëè òðåáóåòñÿ êîíêðåòíûé íîìåð áóìàãè, ýòî äîëæíî áûòü óêàçàíî.

8.2.3.1.9 Ðàçäåëèòåëè

Åñëè â äîêóìåíòàöèè ïðèìåíÿþòñÿ ðàçäåëèòåëè, äîëæíû áûòü óêàçàíû èõ öâåò, ìàññà è êà÷åñòâî.  ñïåöèôèêàöèè ñòèëÿ äîëæíà áûòü îïðåäåëåíà èíôîðìàöèÿ, ïå÷àòàåìàÿ íà ðàçäåëèòåëÿõ, à òàêæå èõ ôîðìàò, îðèåíòàöèÿ è èñïîëüçóåìûé øðèôò.

8.2.3.1.10 Ìåòîä âîñïðîèçâåäåíèÿ (òèðàæèðîâàíèÿ) è êà÷åñòâî

Äîëæåí áûòü óêàçàí ìåòîä òèðàæèðîâàíèÿ äîêóìåíòàöèè (ïå÷àòíûé, ôîòîêîïèðîâàëüíûé è ò.ä.), à òàêæå ñîîòâåòñòâóþùèå åìó ïîêàçàòåëè êà÷åñòâà.

8.2.3.1.11 Ïåðåïëåò

Äîëæåí áûòü óêàçàí ìåòîä ïåðåïëåòåíèÿ äîêóìåíòàöèè.

8.2.3.2 Ñõåìû íóìåðàöèè

8.2.3.2.1 Íóìåðàöèÿ ñòðàíèö

Äîëæíà áûòü îïðåäåëåíà ñõåìà íóìåðàöèè ñòðàíèö.

Ïðèìå÷àíèÿ

1. Êàæäàÿ ñòðàíèöà äîëæíà èìåòü èíäèâèäóàëüíûé íîìåð. Íîìåðà ñòðàíèö äîëæíû áûòü ïðîñòàâëåíû â ïîðÿäêå èõ áðîøþðîâàíèÿ.

2. Ïðè áðîøþðîâêå äîêóìåíòà ñ çàìåíÿåìûìè ñòðàíèöàìè ñõåìà íóìåðàöèè äîëæíà ó÷èòûâàòü íîìåð òåêóùåé ãëàâû (ðàçäåëà) ñ íîìåðîì ñòðàíèöû â äàííîé ãëàâå (ðàçäåëå), íàïðèìåð «1-1», «1-2» è ò.ä. (òåì ñàìûì îáåñïå÷èâàåòñÿ âñòàâêà ñòðàíèö â äîêóìåíò áåç ïåðåíóìåðàöèè âñåõ ïîñëåäóþùèõ ñòðàíèö).

3.  ñëó÷àå áðîøþðîâêè äîêóìåíòà áåç çàìåíû ñòðàíèö èñïîëüçóþò ïîðÿäêîâóþ íîìåðàöèþ, íàïðèìåð «1», «2» è ò.ä. Èíîãäà äëÿ íóìåðàöèè ñòðàíèö ñîäåðæàíèÿ èñïîëüçóþò äðóãóþ ñõåìó («i», «ii» è ò.ä.). Ñëåäóåò èçáåãàòü ñõîæèõ ìåòîäîâ íóìåðàöèè ñòðàíèö âñïîìîãàòåëüíîãî (óêàçàòåëÿ è ò.ä.) è ââîäíîãî ìàòåðèàëîâ, òàê êàê ýòî ìîæåò ïðèâåñòè ê íåîäíîçíà÷íîñòè â ñëó÷àå èçúÿòèÿ èëè âñòàâêè ñòðàíèö.

8.2.3.2.2 Íóìåðàöèÿ òàáëèö è ðèñóíêîâ

Äîëæíû áûòü îïðåäåëåíû ñõåìû íóìåðàöèè ðèñóíêîâ è òàáëèö (ïðè íåîáõîäèìîñòè èõ íóìåðàöèè).

Ïðèìå÷àíèå - Ðèñóíêè è òàáëèöû â äîêóìåíòå (÷àñòÿõ äîêóìåíòà) äîëæíû èìåòü èíäèâèäóàëüíóþ íóìåðàöèþ. Ðèñóíêè è òàáëèöû äîëæíû íóìåðîâàòüñÿ â ïîðÿäêå èõ ðàñïîëîæåíèÿ â äîêóìåíòå (÷àñòÿõ äîêóìåíòà). Ìîæåò áûòü èñïîëüçîâàíà åäèíàÿ, ïîñëåäîâàòåëüíàÿ íóìåðàöèÿ ðèñóíêîâ è òàáëèö.

8.2.3.3 Èñïîëüçîâàíèå ñíîñîê èëè êîíöåâûõ ïðèìå÷àíèé

Äîëæíû áûòü óêàçàíû âîçìîæíîñòè ïðèìåíåíèÿ ñíîñîê èëè êîíöåâûõ ïðèìå÷àíèé.

Ïðèìå÷àíèå -  äîêóìåíòàöèè ïîëüçîâàòåëÿ ïðîãðàììíîãî ñðåäñòâà äàííûå ýëåìåíòû îáû÷íî íå èñïîëüçóþò; â ñïåöèôèêàöèè ñòèëÿ ñëåäóåò çàïðåòèòü èõ ïðèìåíåíèå.

8.2.3.4 Ïðàâèëà ïàãèíàöèè è ïëîòíîñòè äîêóìåíòà

Äîëæíû áûòü îïðåäåëåíû ïðàâèëà ïàãèíàöèè (ïîñòðàíè÷íîãî ðàçáèåíèÿ, íàïðèìåð, ÷òîáû çàãîëîâêè íå ïðîñòàâëÿëèñü â êîíöå ñòðàíèöû) è ïëîòíîñòè äîêóìåíòà (íàïðèìåð, ðåãóëèðîâàíèå êîëè÷åñòâà ÷èñòûõ ñòðàíèö, íà÷àëüíûõ è êîíöåâûõ âèñÿ÷èõ ñòðîê).

8.2.3.5 Ââîäíûå è âñïîìîãàòåëüíûå ìàòåðèàëû

Äîëæíû áûòü îïðåäåëåíû âèäû ââîäíûõ è âñïîìîãàòåëüíûõ ìàòåðèàëîâ, âêëþ÷àÿ (ïðè íåîáõîäèìîñòè) òðåáîâàíèÿ ê ñîäåðæàíèþ è îôîðìëåíèþ:

a) òèòóëüíîãî ëèñòà;

b) èíôîðìàöèè î ãàðàíòèÿõ, àâòîðñêèõ ïðàâàõ, êîìïåíñàöèÿõ è òîðãîâîé ìàðêå;

c) ñîäåðæàíèÿ;

d) ñïèñêà ðèñóíêîâ è òàáëèö;

e) ïðèëîæåíèé;

f) ñëîâàðÿ (ãëîññàðèÿ);

g) ïåðå÷íåé îáîçíà÷åíèé è ñîêðàùåíèé;

h) óêàçàòåëÿ.

Äîëæåí áûòü îïðåäåëåí ïîðÿäîê ðàñïîëîæåíèÿ äàííûõ ýëåìåíòîâ â äîêóìåíòå.

Ïðèìå÷àíèå - Ñëåäóåò óñòàíîâèòü òðåáîâàíèÿ ê ñîäåðæàíèþ è îôîðìëåíèþ ââîäíûõ è âñïîìîãàòåëüíûõ ìàòåðèàëîâ òîëüêî íåîáõîäèìûõ âèäîâ.

8.2.3.6 Òåêñò îñíîâíîé ÷àñòè äîêóìåíòà

8.2.3.6.1 Ãàðíèòóðû è êåãëè øðèôòîâ

Äîëæíû áûòü îïðåäåëåíû ãàðíèòóðû è êåãëè øðèôòîâ, èñïîëüçóåìûõ â îñíîâíîé ÷àñòè äîêóìåíòà.

8.2.3.6.2 ×èñëî êîëîíîê

Äîëæíî áûòü óêàçàíî ÷èñëî êîëîíîê, èñïîëüçóåìûõ ïðè îôîðìëåíèè ñòðàíèö äîêóìåíòà.

Ïðèìå÷àíèå - Íàèáîëåå ÷àñòî â äîêóìåíòàöèè ïîëüçîâàòåëÿ ïðîãðàììíîãî ñðåäñòâà èñïîëüçóþò îäíîêîëîííîå îôîðìëåíèå ñòðàíèö, íî ìîæåò áûòü òàêæå èñïîëüçîâàíî äâóõêîëîííîå îôîðìëåíèå.

8.2.3.6.3 Îòñòóïû ïî ãîðèçîíòàëè è ïðîáåëû ïî âåðòèêàëè

Äëÿ òåêñòà îñíîâíîé ÷àñòè èçäàíèÿ äîëæíû áûòü îïðåäåëåíû îòñòóïû (âòÿæêè) ñëåâà èëè ñïðàâà îò êðàÿ íàáîðà îñíîâíîãî äëÿ èçäàíèÿ ôîðìàòà, êîãäà ÷àñòü ñòðîê ïîëîñû íàáèðàþò íà áîëåå óçêèé ôîðìàò ñî ñäâèãîì âëåâî (ïðàâîñòîðîííÿÿ âòÿæêà), âïðàâî (ëåâîñòîðîííÿÿ), ñ îáåèõ ñòîðîí (äâóñòîðîííÿÿ), à òàêæå ïðîáåëû ïî âåðòèêàëè (íàïðèìåð, ìåæñòðî÷íûå, ìåæàáçàöåâûå).

Ïðèìå÷àíèÿ

1. Äëÿ ÿçûêîâ ðîìàíñêîé ãðóïïû â òåêñòå îñíîâíîé ÷àñòè äîêóìåíòà ñëåäóåò èçáåãàòü ñòðîê äëèíîé áîëåå 65 è ìåíåå 30 ñèìâîëîâ.

2. Äëÿ ïîäñ÷åòà ñîîòâåòñòâóþùåé äëèíû ñòðîêè èçíà÷àëüíî âûáèðàþò ñòðîêó äëèíîé 5 ñì è ñ÷èòàþò êîëè÷åñòâî ñèìâîëîâ (âêëþ÷àÿ ïðîáåëû), ñîäåðæàùèõñÿ â äåñÿòè ñòðîêàõ îáû÷íîãî òåêñòà (áåç ðàçáèâêè íà àáçàöû) äàííîé äëèíû. Ïîëó÷åííîå ÷èñëî äåëÿò íà 50 äëÿ îïðåäåëåíèÿ ñðåäíåãî ÷èñëà ñèìâîëîâ íà 1 ñì. Çàòåì ïðèíèìàþò ðåøåíèå î íåîáõîäèìîì êîëè÷åñòâå ñèìâîëîâ â ñòðîêå (êîòîðîå äîëæíî áûòü ìåæäó 30 è 65) è äåëÿò åãî íà ðàíåå îïðåäåëåííîå ñðåäíåå ÷èñëî ñèìâîëîâ íà 1 ñì äëÿ ïîëó÷åíèÿ íåîáõîäèìîé äëèíû ñòðîêè â ñàíòèìåòðàõ.

8.2.3.6.4 Âûðàâíèâàíèå

Äîëæíû áûòü îïðåäåëåíû ïàðàìåòðû âûðàâíèâàíèÿ òåêñòà îñíîâíîé ÷àñòè íà âûáðàííîì ÿçûêå (íàïðèìåð, ëåâîñòîðîííåå èëè ïî øèðèíå).

8.2.3.7 Çàãîëîâêè

8.2.3.7.1 Êîëè÷åñòâî óðîâíåé è íàèìåíîâàíèÿ çàãîëîâêîâ

Äîëæíî áûòü îïðåäåëåíî êîëè÷åñòâî óðîâíåé çàãîëîâêîâ, à äëÿ êàæäîãî óðîâíÿ çàäàíî åãî îáîçíà÷åíèå èëè íóìåðàöèÿ.

Ïðèìå÷àíèå - Ñëåäóåò èçáåãàòü èñïîëüçîâàíèÿ áîëåå òðåõ óðîâíåé çàãîëîâêîâ. Òðåõ óðîâíåé îáû÷íî äîñòàòî÷íî.

8.2.3.7.2 Ñòèëü òåêñòà çàãîëîâêîâ

Äîëæåí áûòü îïðåäåëåí ñòèëü òåêñòà çàãîëîâêîâ äëÿ èñïîëüçóåìûõ â äîêóìåíòàöèè ÿçûêîâ (íàïðèìåð, «Ñòèëü îñíîâíûõ ïðåäëîæåíèé», «Âñå áóêâû çàãëàâíûå»).

8.2.3.7.3 Ãàðíèòóðû, êåãëè øðèôòîâ è îòñòóïû äëÿ çàãîëîâêîâ êàæäîãî óðîâíÿ

Äîëæíû áûòü îïðåäåëåíû ãàðíèòóðû è êåãëè øðèôòîâ, îòñòóïû ïî ãîðèçîíòàëè è èíòåðâàëû ïî âåðòèêàëè äëÿ êàæäîãî óðîâíÿ çàãîëîâêîâ.

8.2.3.7.4 Ãðàôè÷åñêèå ýëåìåíòû, èñïîëüçóåìûå â çàãîëîâêàõ

Äîëæíû áûòü îïðåäåëåíû ãðàôè÷åñêèå ýëåìåíòû (íàïðèìåð, ïîä÷åðêèâàíèå, ðàñêðàñêà, ïèêòîãðàììû), ïðèìåíÿåìûå íà êàæäîì óðîâíå çàãîëîâêîâ.

8.2.3.8 Âåðõíèå è íèæíèå êîëîíòèòóëû

8.2.3.8.1 Ñîäåðæàíèå êîëîíòèòóëîâ

Äîëæíî áûòü îïðåäåëåíî ñîäåðæàíèå çàïîëíåíèÿ âåðõíèõ è íèæíèõ êîëîíòèòóëîâ.

Ïðèìå÷àíèå - Íàïðèìåð, òàêîâûìè ìîãóò áûòü íîìåðà ñòðàíèö, ïðîñòàâëÿåìûå íà ïîëÿõ.

8.2.3.8.2 Ãàðíèòóðû, êåãëè øðèôòîâ è ðàñïîëîæåíèå êîëîíòèòóëîâ

Äîëæíû áûòü îïðåäåëåíû ãàðíèòóðû è êåãëè øðèôòîâ, à òàêæå ãîðèçîíòàëüíîå è âåðòèêàëüíîå ðàñïîëîæåíèå âåðõíèõ è íèæíèõ êîëîíòèòóëîâ. Ïðè äâóñòîðîííåé ïå÷àòè îòäåëüíî äîëæíî áûòü îïðåäåëåíî ñîäåðæàíèå è îôîðìëåíèå âåðõíèõ è íèæíèõ êîëîíòèòóëîâ ëåâûõ è ïðàâûõ ñòðàíèö.

Ïðèìå÷àíèå - Íàïðèìåð, ðàñïîëîæåíèå íîìåðîâ ñòðàíèö íà ñòðàíèöàõ êàæäîãî òèïà.

8.2.3.8.3 Èñïîëüçóåìûå ãðàôè÷åñêèå ýëåìåíòû

Äîëæíû áûòü îïðåäåëåíû ãðàôè÷åñêèå ýëåìåíòû (íàïðèìåð, ïîä÷åðêèâàíèå, ðàñêðàñêà, ïèêòîãðàììû), ïðèìåíÿåìûå äëÿ êîëîíòèòóëà êàæäîãî òèïà.

8.2.3.9 Íàäïèñè

8.2.3.9.1 Ñîäåðæèìîå

Äîëæíî áûòü îïðåäåëåíî ñîäåðæèìîå íàäïèñåé.

8.2.3.9.2 Ãàðíèòóðû, êåãëè øðèôòîâ è ðàñïîëîæåíèå

Äîëæíû áûòü îïðåäåëåíû ãàðíèòóðû è êåãëè øðèôòîâ, à òàêæå ðàñïîëîæåíèå íàäïèñåé â äîêóìåíòå.

8.2.3.10 Òàáëèöû

8.2.3.10.1 Ïðàâèëà îôîðìëåíèÿ

Äîëæíû áûòü îïðåäåëåíû ïðàâèëà îôîðìëåíèÿ òàáëèö, íàïðèìåð ãîëîâêè òàáëèö ñëåäóåò ïîâòîðÿòü ïðè ïåðåõîäå íà äðóãóþ ñòðàíèöó.

8.2.3.10.2 Ãàðíèòóðû è ìèíèìàëüíûå êåãëè øðèôòîâ

Äîëæíû áûòü îïðåäåëåíû ãàðíèòóðû è ìèíèìàëüíûå êåãëè øðèôòîâ, èñïîëüçóåìûõ â òàáëèöàõ.

8.2.3.11 Îò÷åòû (ñîîáùåíèÿ)

8.2.3.11.1. Îáùèå ïîëîæåíèÿ

Îò÷åòû (ñîîáùåíèÿ) ÿâëÿþòñÿ ðåçóëüòàòàìè ðàáîòû ïðèêëàäíûõ ïðîãðàììíûõ ñðåäñòâ, âûäàâàåìûå â ïå÷àòíîì èëè ýêðàííîì âèäå. Îáðàçöû îò÷åòîâ îáû÷íî âêëþ÷àþò â äîêóìåíòàöèþ ïîëüçîâàòåëÿ ïðîãðàììíîãî ñðåäñòâà.

8.2.3.11.2 Ñîäåðæàíèå

Ìîãóò áûòü óñòàíîâëåíû ïðàâèëà îôîðìëåíèÿ è ñîäåðæàíèÿ îò÷åòîâ.

Ïðèìå÷àíèå - Îò÷åòû ëó÷øå ïîíèìàþòñÿ, êîãäà íà êàæäîì èõ ïîëå ðàñïå÷àòêè ýêðàíîâ îòðàæåíû ðåàëüíûå äàííûå.  îò÷åòàõ òàêæå äîëæíû áûòü èñïîëüçîâàíû ôóíêöèîíàëüíûå äàííûå.

8.2.3.11.3 Ãàðíèòóðû è ìèíèìàëüíûå êåãëè øðèôòîâ

Äîëæíû áûòü îïðåäåëåíû ãàðíèòóðû è ìèíèìàëüíûå êåãëè øðèôòîâ, èñïîëüçóåìûå â îò÷åòàõ.

8.2.3.11.4 Èñïîëüçîâàíèå ãîðèçîíòàëüíîé êîìïîíîâêè è ñòðàíèö-ðàñêëàäîê

Äîëæíû áûòü îïðåäåëåíû ïðàâèëà ïî èñïîëüçîâàíèþ ãîðèçîíòàëüíîé êîìïîíîâêè (òî åñòü àëüáîìíûõ ôîðìàòîâ) äëÿ î÷åíü øèðîêèõ èëè äëèííûõ îò÷åòîâ. Äîëæíû áûòü òàêæå óñòàíîâëåíû ïðàâèëà èñïîëüçîâàíèÿ â îò÷åòàõ ñòðàíèö-ðàñêëàäîê è ñòðàíèö-ðàçâåðòîê.

8.2.3.12 Ðàñïå÷àòêè ýêðàíîâ

8.2.3.12.1 Ñîäåðæàíèå

Äîëæíû áûòü óñòàíîâëåíû îáùèå ïðàâèëà ñîäåðæàíèÿ ðàñïå÷àòîê ýêðàíîâ.

Ïðèìå÷àíèå - Ðàñïå÷àòêè ýêðàíîâ ëó÷øå ïîíèìàþòñÿ, êîãäà íà êàæäîé èç íèõ îòðàæåíû ðåàëüíûå äàííûå.  ðàñïå÷àòêàõ òàêæå äîëæíû áûòü èñïîëüçîâàíû ôóíêöèîíàëüíûå äàííûå.

8.2.3.12.2 Îôîðìëåíèå (êîìïîíîâêà)

Äîëæíû áûòü óñòàíîâëåíû îáùèå ïðàâèëà îôîðìëåíèÿ (êîìïîíîâêè) ðàñïå÷àòîê ýêðàíîâ.

8.2.3.12.3 Îôîðìëåíèå ÷àñòè÷íûõ ðàñïå÷àòîê ýêðàíîâ

Äîëæíû áûòü óñòàíîâëåíû (ïðè íåîáõîäèìîñòè) ïðàâèëà îôîðìëåíèÿ ÷àñòè÷íûõ (íåïîëíûõ) ðàñïå÷àòîê ýêðàíîâ.

8.2.3.13 Ðèñóíêè

8.2.3.13.1 Ìèíèìàëüíàÿ òîëùèíà ëèíèé, ãàðíèòóðû è êåãëè øðèôòîâ

Äîëæíû áûòü óñòàíîâëåíû, èñïîëüçóåìûå â ðèñóíêàõ ãàðíèòóðû è êåãëè øðèôòîâ, à òàêæå ìèíèìàëüíàÿ òîëùèíà ëèíèé.

8.2.3.13.2 Ðàñïîëîæåíèå

Äîëæíû áûòü óñòàíîâëåíû ïðàâèëà ðàñïîëîæåíèÿ (îðèåíòàöèè) ðèñóíêîâ.

8.2.3.14 Óâåäîìëåíèÿ è ïðåäîñòåðåæåíèÿ

8.2.3.14.1 Ñòèëü òåêñòà

Äîëæåí áûòü îïðåäåëåí ñòèëü òåêñòà óâåäîìëåíèé è ïðåäîñòåðåæåíèé äëÿ èñïîëüçóåìûõ â äîêóìåíòàöèè ÿçûêîâ (íàïðèìåð, «Ñòèëü îñíîâíûõ ïðåäëîæåíèé», «Âñå áóêâû çàãëàâíûå»).

8.2.3.14.2 Ãàðíèòóðû, êåãëè øðèôòîâ è îòñòóïû

Äîëæíû áûòü îïðåäåëåíû ãàðíèòóðû è êåãëè øðèôòîâ, îòñòóïû ïî ãîðèçîíòàëè è èíòåðâàëû ïî âåðòèêàëè äëÿ óâåäîìëåíèé è ïðåäîñòåðåæåíèé.

8.2.3.14.3 Ãðàôè÷åñêèå ýëåìåíòû, èñïîëüçóåìûå â çàãîëîâêàõ

Äîëæíû áûòü îïðåäåëåíû ãðàôè÷åñêèå ýëåìåíòû (íàïðèìåð, ïîä÷åðêèâàíèå, ðàñêðàñêà, ïèêòîãðàììû), èñïîëüçóåìûå â óâåäîìëåíèÿõ è ïðåäîñòåðåæåíèÿõ.

8.2.4 Ýëåêòðîííàÿ äîêóìåíòàöèÿ

8.2.4.1 Òèïû ñïðàâî÷íîé èíôîðìàöèè

 ñïåöèôèêàöèè ñòèëÿ äîêóìåíòàöèè ìîãóò áûòü óêàçàíû îäèí èëè íåñêîëüêî èç ñëåäóþùèõ òèïîâ ñïðàâî÷íîé èíôîðìàöèè:

a) êîíòåêñòíàÿ ñïðàâêà (context help) - èíôîðìàöèÿ î òåêóùåì ïîëå, â êîòîðîì íàõîäèòñÿ êóðñîð èëè âûñâå÷åíà ïðîãðàììà, âêëþ÷àÿ åå íåîáõîäèìîå èëè öåëåâîå (ïðåäìåòíîå) ñîäåðæàíèå, åå íàçíà÷åíèå è ïîòåíöèàëüíîå âëèÿíèå íà ðàáîòó ïðîãðàììíîãî ñðåäñòâà;

b) ðàñøèðåííàÿ ñïðàâêà (extended help) - èíôîðìàöèÿ î òåêóùåì ýêðàíå èëè îêíå, âêëþ÷àÿ åå íàçíà÷åíèå è òðåáóåìûé ðåæèì èñïîëüçîâàíèÿ;

c) ñïðàâêà î êëàâèøàõ (keys help) - èíôîðìàöèÿ î ïðèìåíåíèè êëàâèàòóðû, ôóíêöèîíàëüíîì íàçíà÷åíèè êëàâèø è èõ ïåðåíàèìåíîâàíèè (îáîçíà÷åíèè);

d) ñïðàâêà î ñïðàâêàõ (help to help) - èíôîðìàöèÿ îá èñïîëüçîâàíèè ñïðàâî÷íîé ñèñòåìû â öåëîì;

e) ñïðàâêà î ñîîáùåíèè (message help) - èíôîðìàöèÿ î òîì, ÷òî ïîëüçîâàòåëü äîëæåí èëè ìîæåò ñäåëàòü â îòâåò íà êîíêðåòíûå ñèñòåìíûå ñîîáùåíèÿ, íàïðèìåð ñîîáùåíèÿ îá îøèáêàõ;

f) òåðìèíîëîãè÷åñêàÿ ñïðàâêà (reference phrase help) - îïðåäåëåíèÿ êîíêðåòíûõ ýëåìåíòîâ, ñâÿçåé ñ êîíêðåòíîé òåìàòèêîé è ðàñøèôðîâêà îáîçíà÷åíèé è ñîêðàùåíèé;

g) ïîíÿòèéíàÿ ñïðàâêà (intelligent help) - ñïðàâî÷íàÿ èíôîðìàöèÿ, âûäàâàåìàÿ ñèñòåìîé äëÿ ïðåäóïðåæäåíèÿ ïîëüçîâàòåëÿ îá îøèáêàõ. Ìîæåò áûòü ñòðóêòóðèðîâàíà, ÷òîáû ïåðâîíà÷àëüíî ïîëüçîâàòåëü ïîëó÷àë êðàòêîå ñïðàâî÷íîå ñîîáùåíèå, à ïðè ïîâòîðåíèè òîé æå îøèáêè - áîëåå ïîäðîáíîå ñîîáùåíèå, è íàîáîðîò, ïîëüçîâàòåëü ìîæåò ïîëó÷èòü ðàçâåðíóòîå ñîîáùåíèå ïðè ïåðâîé îøèáêå è êðàòêîå - ïðè åå ïîâòîðåíèè.

8.2.4.2 Òèïû äèàëîãîâîé (îïåðàòèâíîé) äîêóìåíòàöèè

 ñïåöèôèêàöèè ñòèëÿ ýëåêòðîííîé äîêóìåíòàöèè ìîãóò áûòü óêàçàíû îäèí èëè íåñêîëüêî èç ñëåäóþùèõ òèïîâ äèàëîãîâîé äîêóìåíòàöèè:

a) ðóêîâîäñòâà èëè ðåêîìåíäàöèè ïîëüçîâàòåëÿ (user guide or reference) - îïèñûâàþò ïðîöåäóðû ïî ïðèìåíåíèþ ïðîäóêòà;

b) êîìàíäíûå ñïðàâêè (command reference) - îïðåäåëÿþò ñèíòàêñèñ, ðåçóëüòàòû è öåëåâîå íàçíà÷åíèå êàæäîé êîìàíäû (òîëüêî äëÿ êîìàíä óïðàâëåíèÿ ñèñòåìîé);

c) ðåêîìåíäàöèè ïî ñîîáùåíèþ (message reference) - îïðåäåëÿþò, ÷òî ïîëüçîâàòåëü äîëæåí èëè ìîæåò ñäåëàòü â îòâåò íà êîíêðåòíûå ñèñòåìíûå ñîîáùåíèÿ, íàïðèìåð ñîîáùåíèÿ îá îøèáêàõ;

d) àäìèíèñòðàòèâíàÿ èíôîðìàöèÿ (administration information) - èíôîðìàöèÿ î êîíôèãóðàöèè è çàùèòå ñèñòåìû, à ïðè íåîáõîäèìîñòè - î åå èíñòàëëÿöèè, ïðåäíàçíà÷åííàÿ äëÿ àäìèíèñòðàòîðà ñèñòåìû.

8.2.4.3 Îôîðìëåíèå

8.2.4.3.1 Îáùåå ïîëîæåíèå

Îôîðìëåíèå (êîìïîíîâêà) èíôîðìàöèè â ñèñòåìàõ ñïðàâî÷íîé è äèàëîãîâîé (îïåðàòèâíîé) äîêóìåíòàöèè âî ìíîãîì ìîæåò îïðåäåëÿòüñÿ âîçìîæíîñòÿìè èíñòðóìåíòàëüíûõ ñðåäñòâ, èñïîëüçóåìûõ ïðè èõ ñîçäàíèè.

8.2.4.3.2 Ñîïóòñòâóþùèå ìàòåðèàëû

Äîëæíû áûòü óñòàíîâëåíû ïðàâèëà ðàçìåùåíèÿ ìàòåðèàëîâ, ñâÿçàííûõ ñ ýëåêòðîííîé äîêóìåíòàöèåé, è èõ ìåñòîïîëîæåíèå.

8.2.4.3.3 Ïîäñâåòêà è èñïîëüçîâàíèå öâåòà

Äîëæíû áûòü óñòàíîâëåíû ïðàâèëà èñïîëüçîâàíèÿ â ýëåêòðîííîé äîêóìåíòàöèè ïîäñâåòîê âûäåëÿåìûõ ýëåìåíòîâ è èñïîëüçîâàíèå öâåòîâîãî îôîðìëåíèÿ.

Ïðèìå÷àíèÿ

1. Èñïîëüçîâàíèå ïîäñâåòîê è öâåòîâ äëÿ âûäåëåíèÿ ýëåìåíòîâ äîêóìåíòàöèè äîëæíî áûòü ìèíèìèçèðîâàíî, îñîáåííî â ñëó÷àå âîçìîæíîé ïóòàíèöû ìåæäó âûäåëåííûì òåêñòîì è ãèïåðòåêñòîâûìè ñâÿçÿìè.

2. Öâåòà ñëåäóåò èñïîëüçîâàòü îñòîðîæíî, îñîáåííî ïðè îòñóòñòâèè óâåðåííîñòè â òîì, ÷òî òîò æå öâåò íå èñïîëüçóåòñÿ äëÿ óâåäîìëåíèÿ î áîëåå âàæíîé èíôîðìàöèè. Ýòî îñîáåííî âàæíî ïðè íàëè÷èè ó ïîëüçîâàòåëåé âîçìîæíîñòåé âûáîðà ðàçëè÷íîãî öâåòîâîãî îôîðìëåíèÿ ýêðàíîâ.

3. Äëÿ ÷åòêîãî âûäåëåíèÿ ýëåìåíòîâ è âî èçáåæàíèå âîçíèêíîâåíèÿ ïðè ýòîì ïðîáëåì ïî âîçìîæíîñòè ñëåäóåò îñíîâíûå öâåòà (êðàñíûé, çåëåíûé è ñèíèé) èñïîëüçîâàòü íà ôîíå áåëîãî èëè ÷åðíîãî.

4. Ðàçëè÷íûå ÿðêèå öâåòà íå ñëåäóåò èñïîëüçîâàòü ïîñëåäîâàòåëüíî, òàê êàê ýòî ìîæåò ïðèâåñòè ê âîçíèêíîâåíèþ íà ýêðàíå òðåõìåðíûõ ýôôåêòîâ.

5. Îáû÷íî íåêîòîðûå öâåòà èìåþò îïðåäåëåííûå ñìûñëîâûå çíà÷åíèÿ (íàïðèìåð, êðàñíûé - «ñòîé» èëè «îïàñíî», çåëåíûé - «ïðîäîëæèòü» èëè «áåçîïàñíî») è ìîãóò áûòü âûáðàíû ñîîòâåòñòâåííî ýòîìó çíà÷åíèþ. Äàííûé òèï öâåòîñî÷åòàíèÿ ñëåäóåò èñïîëüçîâàòü îñòîðîæíî, åñëè ïîëüçîâàòåëè ìîãóò âûáèðàòü ðàçëè÷íûå öâåòîâûå îôîðìëåíèÿ ýêðàíîâ.

6. Êîëîðèñòèêà ýêðàíîâ äèñïëååâ ÿâëÿåòñÿ ñëîæíûì âîïðîñîì è ÷àñòî ñâÿçàíà ñ íåäîñòàòî÷íîé ïðîåêòíîé ïðîðàáîòêîé. Äîêóìåíòàòîðàì â ýòîì ñëó÷àå ñëåäóåò îáðàùàòüñÿ çà ïîìîùüþ ê ñîîòâåòñòâóþùèì ñïåöèàëèñòàì.

8.2.4.3.4 Îôîðìëåíèå äèàëîãîâîé äîêóìåíòàöèè è ñïðàâî÷íîãî òåêñòà

Äîëæíû áûòü óñòàíîâëåíû ïðàâèëà îôîðìëåíèÿ ñîîòâåòñòâóþùèõ òåêñòîâ.

8.2.4.3.5 Çàãîëîâêè

Äîëæíû áûòü óñòàíîâëåíû ïðàâèëà îôîðìëåíèÿ ñîîòâåòñòâóþùèõ çàãîëîâêîâ.

8.2.4.3.6 Òåêñò îñíîâíîé ÷àñòè

Äëÿ òåêñòà îñíîâíîé ÷àñòè ýëåêòðîííîé äîêóìåíòàöèè äîëæíû áûòü îïðåäåëåíû ñëåäóþùèå ýëåìåíòû:

a) âûðàâíèâàíèå (äëÿ ñîîòâåòñòâóþùèõ ÿçûêîâ);

b) îòñòóïû è èíòåðâàëû.

Ïðèìå÷àíèå - Äëÿ ÿçûêîâ ðîìàíñêîé ãðóïïû ñëåäóåò èçáåãàòü ñòðîê äëèíîé áîëåå 65 è ìåíåå 30 ñèìâîëîâ. Èíòåðâàë ìåæäó ñòðîêàìè ñëåäóåò óñòàíàâëèâàòü íå ìåíåå äâóõ ïèêñåëåé èëè 15 % îò âûñîòû ñèìâîëà, íåçàâèñèìî îò åãî âåëè÷èíû. Ýòî íå ðàñïðîñòðàíÿåòñÿ íà çíàêè óäàðåíèÿ èëè âûíîñíûå ýëåìåíòû ñòðî÷íûõ ñèìâîëîâ;

c) ìèíèìàëüíàÿ âûñîòà ñèìâîëà.

Ïðèìå÷àíèå - Äëÿ ÿçûêîâ ðîìàíñêîé ãðóïïû âûñîòà ñèìâîëîâ äîëæíà áûòü íå ìåíåå 16 è íå áîëåå 45 óãëîâûõ ìèíóò. Ïðåäïî÷òèòåëüíîé âûñîòîé ñèìâîëà ÿâëÿþòñÿ 20-22 óãëîâûå ìèíóòû. Óãëîâûå ìèíóòû èñïîëüçóþòñÿ â êà÷åñòâå ïîêàçàòåëÿ âûñîòû ñèìâîëà íà âèäåîäèñïëåå; äàííûé ïîêàçàòåëü îòðàæàåò îõâàò ñèìâîëà ãëàçîì. Îí çàâèñèò íå òîëüêî îò ôàêòè÷åñêîé âûñîòû ñèìâîëà íà ýêðàíå, íî òàêæå îò íîðìàëüíîãî ðàññòîÿíèÿ äî ýêðàíà.  òàáëèöå 1 ïîêàçàíî îòíîøåíèå ìåæäó âûñîòîé ñèìâîëà â óãëîâûõ ìèíóòàõ è ìèëëèìåòðàõ íà ðàññòîÿíèè â 1 ì. Íàïðèìåð, íà áîëåå êîðîòêîì ðàññòîÿíèè âûñîòà ïðîïîðöèîíàëüíî óìåíüøàåòñÿ ïî ñðàâíåíèþ ñ çàäàííîé â òàáëèöå.  òàáëèöå äëÿ ñðàâíåíèÿ òàêæå ïîêàçàíî ñîîòâåòñòâóþùåå ÷èñëî îòîáðàæàåìûõ òî÷åê äëÿ ãàðíèòóðû «Times Roman».

Òàáëèöà 1 - Óãîë îáçîðà è ÷èñëî òî÷åê

Óãîë îáçîðà, óãëîâûå ìèíóòû

Âûñîòà, ìì

Ïðèáëèçèòåëüíîå ÷èñëî òî÷åê

10

2,9

12

15

4,4

18

20

5,8

24

25

7,3

30

30

8,8

36

35

10,2

42

40

11,6

48

45

13,1

54

50

14,6

60

8.2.4.3.7 Íàâèãàöèÿ

Äîëæíû áûòü óñòàíîâëåíû ïðàâèëà íàâèãàöèè ïî ýëåêòðîííîé äîêóìåíòàöèè.

Ïðèìå÷àíèÿ

1. Óðîâíè ñâÿçåé èíôîðìàöèè â äîêóìåíòàöèè äîëæíû êîíòðîëèðîâàòüñÿ, îáåñïå÷èâàÿ ïîëüçîâàòåëþ âîçìîæíîñòè âîçâðàòà â èñõîäíûé ïóíêò, ñîäåðæàíèå èëè óêàçàòåëü áåç áëóæäàíèÿ â äîêóìåíòå.

2. Äîëæíû áûòü âûðàáîòàíû è ïðèìåíåíû ïðàâèëà ñòðóêòóðèðîâàíèÿ äîêóìåíòà. Íàïðèìåð, êîëè÷åñòâî ñâÿçåé â êàæäîé èíôîðìàöèîííîé öåïî÷êå äîëæíî áûòü îãðàíè÷åíî ÷èñëîì X. Çíà÷åíèå X äîëæíî áûòü òàêèì, ÷òîáû ïîëüçîâàòåëè èìåëè ñîîòâåòñòâóþùèå âîçìîæíîñòè äëÿ âîçâðàòà ê ñîäåðæàíèþ èëè ïåðåõîäà ê äðóãèì ñòðóêòóðíûì ýëåìåíòàì äîêóìåíòà. Óðîâíè çàãîëîâêîâ òàêæå ìîãóò áûòü âçàèìîóâÿçàíû ñ óðîâíÿìè ñëîæíîñòè äîêóìåíòà (íàïðèìåð, «Â çàãîëîâêàõ ïåðâîãî óðîâíÿ ïðåäñòàâëÿåòñÿ òîëüêî îáùàÿ èíôîðìàöèÿ»).

3. Ïðîáëåìíî îðèåíòèðîâàííàÿ è îáùàÿ èíôîðìàöèÿ äîëæíû áûòü âûäåëåíû â îòäåëüíûå ðàçäåëû ñ âõîäÿùèìè ñâÿçÿìè ìåæäó íèìè, òåì ñàìûì ïîçâîëÿÿ ïîëüçîâàòåëþ èçó÷èòü êîíêðåòíóþ çàäà÷ó áåç íåïðåäíàìåðåííîãî ïîèñêà â îáùèõ ìàòåðèàëàõ, ÷òî ìîæåò äåçîðèåíòèðîâàòü è îòâëåêàòü åãî.

4. Ñëåäóåò èñïîëüçîâàòü ãðàôè÷åñêèå ìàòåðèàëû. Îáùàÿ ñõåìà, îòðàæàþùàÿ îñíîâíûå ðàçäåëû äîêóìåíòà ñ ãèïåðòåêñòîâûìè ñâÿçÿìè ìåæäó íèìè, äàåò ïîëüçîâàòåëþ ÿñíîå âèçóàëüíîå ïðåäñòàâëåíèå î ñòðóêòóðå äîêóìåíòà.

5.  íà÷àëå äîêóìåíòà äîëæåí áûòü ðàçäåë ñ ðåêîìåíäàöèÿìè ïîëüçîâàòåëþ, ñîäåðæàùèé èíôîðìàöèþ ïî ïðèìåíåíèþ äèàëîãîâîé äîêóìåíòàöèè. Äàííûé ðàçäåë ñëåäóåò èñïîëüçîâàòü äëÿ ïîÿñíåíèÿ ñòðóêòóðû äîêóìåíòà è ïðàâèë ïî åãî ïðèìåíåíèþ.

8.2.4.3.8 Èñïîëüçîâàíèå êëàâèàòóðû

Äîëæíû áûòü îïðåäåëåíû ïðàâèëà èñïîëüçîâàíèÿ ñïåöèàëüíûõ êëàâèø â äèàëîãîâîé äîêóìåíòàöèè.

Ïðèìå÷àíèÿ

1. Ïîëüçîâàòåëü äîëæåí èìåòü âîçìîæíîñòü âûçîâà ñïðàâêè, èñïîëüçóÿ êîíêðåòíóþ êëàâèøó èëè êîìáèíàöèþ êëàâèø, â ëþáîé òî÷êå ïðîãðàììû. Ïîëüçîâàòåëü òàêæå äîëæåí èìåòü âîçìîæíîñòü âûçîâà äèàëîãîâîé äîêóìåíòàöèè ñ èñïîëüçîâàíèåì åäèíñòâåííîé êëàâèøè èëè êîìáèíàöèè êëàâèø.

2.  ïëàíå äîêóìåíòèðîâàíèÿ äîëæíû áûòü îïðåäåëåíû óñëîâíûå íàèìåíîâàíèÿ è ôóíêöèè âñåõ ñïåöèàëüíûõ ôóíêöèîíàëüíûõ êëàâèø, èñïîëüçóåìûõ â ñèñòåìå äèàëîãîâîé èëè ñïðàâî÷íîé äîêóìåíòàöèè.

3. Ïðèìåíåíèå ñïåöèàëüíîé ôóíêöèîíàëüíîé êëàâèøè â äîêóìåíòàöèè äîëæíî áûòü ñîîòíåñåíî ñ èñïîëüçîâàíèåì ôóíêöèîíàëüíûõ êëàâèø â ñàìîì ïðîãðàììíîì ïðèëîæåíèè.

ÏÐÈËÎÆÅÍÈÅ À

(ñïðàâî÷íîå)

Ïåðåêðåñòíûå ññûëêè ñ ÃÎÑÒ Ð ÈÑÎ/ÌÝÊ 12207

Íàñòîÿùèé ñòàíäàðò ñîîòâåòñòâóåò ÃÎÑÒ Ð ÈÑÎ/ÌÝÊ 12207 â ÷àñòè ðåàëèçàöèè åãî ïîäðàçäåëà 6.1 ïî îòíîøåíèþ ê äîêóìåíòàöèè ïîëüçîâàòåëÿ (ñì. òàáëèöó À.1).

Òàáëèöà À.1 - Ïåðåêðåñòíûå ññûëêè ñ ÃÎÑÒ Ð ÈÑÎ/ÌÝÊ 12207

Ïóíêòû ÃÎÑÒ Ð ÈÑÎ/ÌÝÊ 12207

Ïóíêòû íàñòîÿùåãî ñòàíäàðòà

6.1.1.1

8.1.3 Ïëàí äîêóìåíòèðîâàíèÿ

6.1.2.1

8.2 Ñîäåðæàíèå ñïåöèôèêàöèè ñòèëÿ

6.1.2.2

8.1.2 Ïðåäñòàâëåíèå èñõîäíûõ ìàòåðèàëîâ

6.1.2.3

8.1.4 Ïðîâåðêà (àíàëèç)

6.1.3.1

8.2 Ñîäåðæàíèå ñïåöèôèêàöèè ñòèëÿ. 8.1.3 Ïëàí äîêóìåíòèðîâàíèÿ

6.1.3.2

8.1.3.3 Ïðîâåðêà ïëàíà äîêóìåíòèðîâàíèÿ

6.1.4.1

8.1.7 Êîíòðîëü èçìåíåíèé è ñîïðîâîæäåíèå äîêóìåíòàöèè

ÏÐÈËÎÆÅÍÈÅ Â

(ñïðàâî÷íîå)

Èñïîëüçîâàíèå íàñòîÿùåãî ñòàíäàðòà â äîãîâîðå

Â.1 Îáùèå ïîëîæåíèÿ

 íàñòîÿùåì ñòàíäàðòå èìåþòñÿ ðàçäåëû, òðåáîâàíèÿ êîòîðûõ íåîáõîäèìî ïîÿñíèòü ïðèìåíèòåëüíî ê êîíêðåòíîìó äîãîâîðó èëè äðóãèì ññûëî÷íûì äîêóìåíòàì (íàïðèìåð, ìåæäóíàðîäíûì).

 ñâîþ î÷åðåäü, ïëàí äîêóìåíòèðîâàíèÿ òàêæå íóæäàåòñÿ â ïîÿñíåíèè.

 äîãîâîðå äîëæíû áûòü äàíû îòâåòû íà ñëåäóþùèå âîïðîñû:

a) îòêóäà ïîñòóïàåò èíôîðìàöèÿ î èçó÷åíèè àóäèòîðèè? (Îòâåò ðåêîìåíäóåìûé);

b) íåîáõîäèìî ëè ãîòîâèòü áîëåå äâóõ ïðîåêòîâ êîìïëåêòà äîêóìåíòàöèè è îäíîãî êîìïëåêòà ãðàíîê? (Ïðè íåîáõîäèìîñòè, â íàñòîÿùåì ñòàíäàðòå ïî óìîë÷àíèþ ïðåäóñìîòðåíû äâà ïðîåêòà êîìïëåêòîâ äîêóìåíòàöèè è îäèí êîìïëåêò ãðàíîê);

c) êòî ïðåäñòàâëÿåò èñõîäíûå ìàòåðèàëû? (Îáû÷íî ýòî î÷åâèäíî, íî äëÿ ïðîåêòîâ ñî ñëîæíûìè âçàèìîñâÿçÿìè ìåæäó âîâëå÷åííûìè ñòîðîíàìè íóæäàåòñÿ â óòî÷íåíèè);

d) êàêèå óðîâíè êîíôèäåíöèàëüíîñòè èëè ñåêðåòíîñòè íåîáõîäèìî èñïîëüçîâàòü äëÿ ìàòåðèàëîâ, ïðåäîñòàâëÿåìûõ çàêàç÷èêîì äîêóìåíòàòîðó?

e) èìååòñÿ ëè ñòàíäàðò íà îôîðìëåíèå áóìàæíîé äîêóìåíòàöèè? (Ýòî íå îáÿçàòåëüíî; ïî óìîë÷àíèþ ìîæåò áûòü èñïîëüçîâàíà ñïåöèôèêàöèÿ ñòèëÿ äîêóìåíòàöèè, óñòàíîâëåííàÿ â íàñòîÿùåì ñòàíäàðòå; çàòåì â ïëàíå äîêóìåíòèðîâàíèÿ ìîæåò áûòü îãîâîðåíî êîëè÷åñòâî ïðîåêòîâ äîêóìåíòàöèè è ò.ä.).

Â.2 Îáðàçåö ðàçäåëà äîãîâîðà

 ñîîòâåòñòâèè ñ íàñòîÿùèì ñòàíäàðòîì îáðàçåö ðàçäåëà äîãîâîðà ìîæåò áûòü ïðåäñòàâëåí â ñëåäóþùåì âèäå.

Ïðèìåð

Ðàçäåë 123 Äîêóìåíòàöèÿ

Âñÿ äîêóìåíòàöèÿ ïîëüçîâàòåëÿ äîëæíà ñîîòâåòñòâîâàòü ÃÎÑÒ Ð ÈÑÎ/ÌÝÊ 15910.

 êîìïëåêò äîêóìåíòàöèè íå ñëåäóåò âêëþ÷àòü äèàëîãîâóþ äîêóìåíòàöèþ è ñïðàâî÷íûå òåêñòû. Âñÿ èíôîðìàöèÿ îá èçó÷åíèè àóäèòîðèè è äðóãèå èñõîäíûå ìàòåðèàëû äîëæíû ïðåäñòàâëÿòüñÿ çàêàç÷èêîì.

Äîëæíî áûòü ïðîâåäåíî îäíî òåñòèðîâàíèå íà ïðàêòè÷íîñòü ïðè ïîñòàâêå ïåðâîãî ìîäóëÿ ïðîãðàììíîãî ñðåäñòâà, êîòîðîå äîëæíî ïðåäóñìàòðèâàòü ïðîâåðêè âñåõ ôóíêöèîíàëüíûõ âîçìîæíîñòåé äàííîãî ìîäóëÿ â èíòåðåñàõ ïÿòè ðàçëè÷íûõ òèïîâûõ ïîëüçîâàòåëåé.

Â.3 Ïðàêòè÷åñêîå ïðèìåíåíèå íàñòîÿùåãî ñòàíäàðòà

Íåîáõîäèìà àäàïòàöèÿ íàñòîÿùåãî ñòàíäàðòà â èíòåðåñàõ ïîòðåáèòåëåé è ïîëüçîâàòåëåé â öåëÿõ åãî ïðàêòè÷åñêîãî ïðèìåíåíèÿ.

Ïðàêòè÷åñêîå ïðèìåíåíèå íàñòîÿùåãî ñòàíäàðòà îáû÷íî çàêëþ÷àåòñÿ â èñêëþ÷åíèè è äîáàâëåíèè ðÿäà ðàçäåëîâ, ÷òî äîëæíî áûòü îãîâîðåíî ñîîòâåòñòâóþùèì ñîãëàøåíèåì (êàê ïðàâèëî, â äîãîâîðå, íî âîçìîæíî è â ïëàíå äîêóìåíòèðîâàíèÿ).

Ïðàêòè÷åñêîå ïðèìåíåíèå íàñòîÿùåãî ñòàíäàðòà ñëåäóåò ïðîâîäèòü òùàòåëüíî, ñ ó÷åòîì åãî îáùåé ñòðóêòóðû.

ÏÐÈËÎÆÅÍÈÅ Ñ

(ñïðàâî÷íîå)

Îáðàçåö ïëàíà äîêóìåíòèðîâàíèÿ. Äîêóìåíòàöèÿ ïîëüçîâàòåëÿ äëÿ ñèñòåìû ABC - àäìèíèñòðàòèâíîãî óïðàâëåíèÿ ìàãíèòíûìè ëåíòàìè

Ñ.1 Ââåäåíèå

 íàñòîÿùåì ïëàíå îïèñàíà ñòðàòåãèÿ ðàçðàáîòêè äîêóìåíòàöèè ïîëüçîâàòåëÿ äëÿ ñèñòåìû ABC, ïðåäñòàâëÿåìîé â âèäå êîìïëåêòà äîêóìåíòàöèè XYZ. Îïðåäåëåíà îáëàñòü ïðèìåíåíèÿ ïðîåêòà, íîìåíêëàòóðà ïîñòàâêè äîêóìåíòàöèè è ðåñóðñû, íåîáõîäèìûå äëÿ åå ñîçäàíèÿ.

Äàííàÿ ñòðàòåãèÿ ïðåäóñìàòðèâàåò ñîçäàíèå òâåðäûõ êîïèé äîêóìåíòàöèè è äèàëîãîâîé äîêóìåíòàöèè â âèäå ñïðàâî÷íûõ òåêñòîâ.

 ñëó÷àå èçìåíåíèÿ äàííîé ñòðàòåãèè ñëåäóåò ïåðåñìîòðåòü ïëàí äîêóìåíòèðîâàíèÿ.

Ñ.2 Îáëàñòü ïðèìåíåíèÿ è îãðàíè÷åíèÿ

 êîìïëåêòå äîêóìåíòàöèè íå ïðåäóñìîòðåíû èíñòðóêöèè ïî ïðèìåíåíèþ îïåðàöèîííîé ñèñòåìû, íà êîòîðîé ïðîãîíÿåòñÿ ñèñòåìà ABC. Îäíàêî äëÿ ÷èòàòåëÿ äîëæíû áûòü óêàçàíû ññûëêè íà ñîîòâåòñòâóþùèå ðóêîâîäñòâà ïî äàííîìó âîïðîñó.

Èíñòàëëÿöèÿ, ââîä â äåéñòâèå è óïðàâëåíèå äîêóìåíòàöèåé ñèñòåìû ABC óæå ðåàëèçîâàíû è íå ðàññìàòðèâàþòñÿ â íàñòîÿùåì ïðîåêòå.

Ñ.3 Îôîðìëåíèå è ñòèëü îïèñàíèÿ

Ïî óìîë÷àíèþ ñëåäóåò èñïîëüçîâàòü îôîðìëåíèå è ñòèëü îïèñàíèÿ, óêàçàííûå â ÃÎÑÒ Ð ÈÑÎ/ÌÝÊ 15910. Îáðàçåö ñòðàíèöû ïðèëîæåí ê ïëàíó äîêóìåíòèðîâàíèÿ.

Òàáëèöà Ñ.1 - Ðóêîâîäñòâî ïî ñòèëþ

Ýëåìåíò

Çíà÷åíèå

Ñîäåðæàíèå ñïðàâî÷íîãî òåêñòà

Äîëæåí áûòü îïèñàí òîëüêî êîíòåêñò ñïðàâêè

Ñîäåðæàíèå äèàëîãîâîé äîêóìåíòàöèè

Îòñóòñòâóåò

Ñîïóòñòâóþùèå ìàòåðèàëû

Ñïðàâî÷íûé òåêñò äëÿ êàæäîãî îáúåêòà äîëæåí áûòü ïðåäñòàâëåí íà îäíîì ýêðàíå

Çàñâåòêè è èñïîëüçîâàíèå öâåòîâ

 ñïðàâî÷íîì òåêñòå íå ñëåäóåò èñïîëüçîâàòü öâåòà è äðóãèå çàñâåòêè

Îôîðìëåíèå äèàëîãîâîé äîêóìåíòàöèè è ñïðàâî÷íîãî òåêñòà

Äîëæåí áûòü èñïîëüçîâàí îäíîêîëîííûé ôîðìàò

Îôîðìëåíèå çàãîëîâêîâ äèàëîãîâîé äîêóìåíòàöèè è ñïðàâî÷íîãî òåêñòà

Ââåðõó êàæäîé ñòðàíèöû ñïðàâî÷íîãî òåêñòà äîëæåí áûòü ïðîñòàâëåí çàãîëîâîê ïåðâîãî óðîâíÿ: êåãëü 14 ï, ãàðíèòóðà Times Roman

Îôîðìëåíèå îñíîâíîé ÷àñòè äîêóìåíòà

Òåêñò äîëæåí áûòü âûðîâíåí ïî ëåâîìó êðàþ è íàáðàí îäíèì øðèôòîì

Ïðàâèëà íàâèãàöèè

 ñîîòâåòñòâèè ñî ñïðàâî÷íûì ìåõàíèçìîì ñèñòåìû ABC

Èñïîëüçîâàíèå êëàâèàòóðû

 ñîîòâåòñòâèè ñî ñòàíäàðòàìè íà ñèñòåìó ABC

Ñ.4 Àóäèòîðèÿ

 àóäèòîðèþ ïîëüçîâàòåëåé äàííîé ñèñòåìû âõîäÿò îïåðàòîðû êîìïüþòåðîâ, îáëàäàþùèå ìèíèìàëüíûìè òåõíè÷åñêèìè çíàíèÿìè. Ìèíèìàëüíîå îáðàçîâàíèå îïåðàòîðîâ äîëæíî ñîîòâåòñòâîâàòü 12-ëåòíåìó ñðåäíåìó (øêîëüíîìó) îáðàçîâàíèþ.

Àóäèòîðèÿ íå îõâàòûâàåò áåçãðàìîòíûõ ïîëüçîâàòåëåé; âñå ïîëüçîâàòåëè äîëæíû îáëàäàòü õîðîøèìè íàâûêàìè ÷òåíèÿ.

Ïîëüçîâàòåëè äîëæíû èìåòü îäíîëåòíèé (äâóõëåòíèé) îïûò ðàáîòû â êà÷åñòâå îïåðàòîðîâ âû÷èñëèòåëüíîãî öåíòðà, âêëþ÷àÿ íàâûêè ïî ýêñïëóàòàöèîííûì ïðîöåäóðàì çàïóñêà, îñòàíîâêè, ðåçåðâèðîâàíèÿ è ñîõðàíåíèÿ ñèñòåì, à òàêæå çàãðóçêè è ðàçãðóçêè ìàãíèòíûõ ëåíò.  èõ îáÿçàííîñòè òàêæå äîëæåí âõîäèòü êîíòðîëü äèàãíîñòè÷åñêèõ ñîîáùåíèé îò ñèñòåìû è ðåàêöèÿ íà íèõ.

Ïðåäïîëàãàåòñÿ, ÷òî ïîëüçîâàòåëè:

a) ïîíèìàþò îáùèå ïðîöåäóðû óïðàâëåíèÿ ìàãíèòíûìè ëåíòàìè;

b) îáëàäàþò àäåêâàòíûì âîñïðèÿòèåì ñîîòâåòñòâóþùèõ êîìàíä îïåðàöèîííîé ñèñòåìû;

c) íå èìåþò íàâûêîâ ðàáîòû ñ ìàãíèòíûìè ëåíòàìè â ñèñòåìå ABC.

Ñ.5 Ïðîåêò ñîäåðæàíèÿ äîêóìåíòàöèè

Ñîäåðæàíèå âêëþ÷àåò â ñåáÿ ñëåäóþùåå:

a) ââåäåíèå - êîíöåïöèÿ ABC è åå ñâÿçü ñ ñèñòåìîé (ïÿòü ñòðàíèö);

b) îáçîð - îáùèå ôóíêöèè ñèñòåìû ABC (òðè ñòðàíèöû);

c) óñòàíîâêà ëåíòû (ïÿòü ñòðàíèö);

d) ñíÿòèå ëåíòû (ïÿòü ñòðàíèö);

e) ïðîáëåìû - ðóêîâîäñòâî ïî îïðåäåëåíèþ äåôåêòîâ, âêëþ÷àÿ ñèñòåìíûå ñîîáùåíèÿ (÷åòûðå ñòðàíèöû);

f) ñëîâàðü òåðìèíîâ è îïðåäåëåíèé (îäíà ñòðàíèöà);

g) óêàçàòåëü (îäíà ñòðàíèöà).

Âñåãî 24 ñòðàíèöû.

Ñ.6 Íîìåíêëàòóðà ïîñòàâêè

Ïî îêîí÷àíèè ïðîåêòà äîëæíû áûòü ïîñòàâëåíû ñëåäóþùèå îáúåêòû:

a) 500 ïåðåïëåòåííûõ êîïèé ðóêîâîäñòâà;

b) ýëåêòðîííàÿ êîïèÿ âñåé äîêóìåíòàöèè íà äèñêåòàõ åìêîñòüþ 1,44 Ìáàéò, äèàìåòðîì 3,5 äþéìà â ôîðìàòå DEF 3.0 (ïðèãîäíàÿ äëÿ ðàñïå÷àòêè äîêóìåíòàöèè íà ïðèíòåðå);

c) ýëåêòðîííàÿ êîïèÿ ñïðàâî÷íîãî òåêñòà.

Ñ.7 Àâòîðñêèå ïðàâà

Àâòîðñêèå ïðàâà íà âñå ìàòåðèàëû ïðèíàäëåæàò îðãàíèçàöèè XYZ.

Ñ.8 Òðàíñïîðòèðîâàíèå

Îñîáûõ óñëîâèé ïî òðàíñïîðòèðîâàíèþ ïðîäóêöèè íå òðåáóåòñÿ.

Ñ.9 Ïðîöåññ ðàçðàáîòêè è êîíòðîëü

Ïðè ñîçäàíèè ðóêîâîäñòâ ïîëüçîâàòåëÿ ñèñòåìû ABC äîëæíû èñïîëüçîâàòüñÿ ïðîöåäóðû ðàçðàáîòêè è êîíòðîëÿ, óñòàíîâëåííûå â Ðóêîâîäñòâå ïî êà÷åñòâó îðãàíèçàöèè XYZ.

Ñ.10 Òèðàæèðîâàíèå

Ïðè ïðîèçâîäñòâå ðóêîâîäñòâ ïîëüçîâàòåëÿ ñèñòåìû ABC ñëåäóåò èñïîëüçîâàòü òèïîãðàôñêóþ ñèñòåìó DEF (âåðñèÿ 3.0). Ãðàôè÷åñêèå ìàòåðèàëû ñëåäóåò ðàçðàáàòûâàòü ñ èñïîëüçîâàíèåì ãðàôè÷åñêîãî ïàêåòà JKL.

Âèäû ýêðàíîâ äèñïëåÿ äëÿ ñèñòåìû ABC ñëåäóåò ñîáðàòü â ýëåêòðîííîì âèäå, à èõ êîïèè - âíåñòè â îêîí÷àòåëüíûé äîêóìåíò.

Ñîäåðæàíèå è óêàçàòåëü äîëæíû áûòü ïîäãîòîâëåíû è âûïóøåíû íà ñèñòåìå DEF.

Êîïèè ôîòîøàáëîíîâ äîëæíû áûòü îòïå÷àòàíû íà ëàçåðíîì ïðèíòåðå ñ ïëîòíîñòüþ ïå÷àòè 300 òî÷åê íà äþéì; çà îòäåëüíóþ ïëàòó îíè ìîãóò áûòü ðàñïå÷àòàíû íà ëàçåðíîì ïðèíòåðå âûñîêîãî êà÷åñòâà ñ ïëîòíîñòüþ ïå÷àòè 1275 òî÷åê íà äþéì.

Êàæäîå ðóêîâîäñòâî äîëæíî áûòü âûïîëíåíî â ôîðìàòå À4 ñ äâóñòîðîííåé ïå÷àòüþ è ñáðîøþðîâàíî òàê, ÷òîáû áûëà âîçìîæíîñòü çàìåíÿòü ëèñòû.

Ïåðåïëåò äîëæåí áûòü ôîðìàòà À4 è ñêðåïëåí êîëüöàìè äèàìåòðîì 25 ìì. Íà îáëîæêå äîëæíû áûòü ïðèâåäåíû ðàñïå÷àòêè ýêðàíîâ ñèñòåìû ABC.

Áóìàãà äëÿ ðóêîâîäñòâ äîëæíà áûòü ìàòîâîé è èìåòü ïëîòíîñòü 103 ã/ñì2.

Ñïðàâî÷íûå òåêñòû äîëæíû áûòü ðàçðàáîòàíû ñ èñïîëüçîâàíèåì ìàêåòèðîâàíèÿ â ñèñòåìå DEF.

Ñ.11 Ïðîåêòàíòû

Ñîñòàâ êîëëåêòèâà ðàçðàáîò÷èêîâ è èõ îáÿçàííîñòè ïðèâåäåíû â òàáëèöå Ñ.2.

Òàáëèöà Ñ.2 - Ïðîåêòàíòû

Ôàìèëèÿ, èìÿ

Ðîëü

Îáÿçàííîñòü

Î’Áðàéåí Ï.

Àâòîð

Èçó÷åíèå ïëàíà è íàïèñàíèå ðóêîâîäñòâ

Êîñòà À.

Ðåäàêòîð

Ðåäàêòèðîâàíèå ðóêîâîäñòâ

Ðè÷àðäñ Ð.

Íîðìîêîíòðîëåð

Ïðîâåðêà òåõíè÷åñêîãî ñîäåðæàíèÿ ðóêîâîäñòâ

Äæîíñ Å.

Òåõíè÷åñêèé àóäèòîð

Ïðîâåäåíèå òåõíè÷åñêèõ ïðîâåðîê è âûäà÷à ðåêîìåíäàöèé

Âîíã Ñ.

Ðàçðàáîò÷èê

Íàáîð òåêñòà è ïîäãîòîâêà ãðàôè÷åñêèõ ìàòåðèàëîâ

Êåëëè À.

Îòâåòñòâåííûé çà êà÷åñòâî

Óïðàâëåíèå êà÷åñòâîì

Äàóíå Ì.

Îòâåòñòâåííûé çà òåñòèðîâàíèå

Òåñòèðîâàíèå ãîòîâîãî ðóêîâîäñòâà ïðè îïðåäåëåííûõ óñëîâèÿõ è ïîäãîòîâêà îò÷åòà î ðåçóëüòàòàõ òåñòèðîâàíèÿ

Ñ.12 Ðåñóðñû

Èíôîðìàöèþ, íåîáõîäèìóþ äëÿ ðàçðàáîòêè ðóêîâîäñòâ, ñëåäóåò âûáèðàòü èç ïðîåêòíîé äîêóìåíòàöèè íà ñèñòåìó ABC, ïîëó÷àòü îò ðàçðàáîò÷èêîâ ïðîãðàììíûõ ñðåäñòâ è îòáèðàòü ïî ðåçóëüòàòàì îïûòíîé ýêñïëóàòàöèè äàííîé ñèñòåìû.

Ðàçðàáîò÷èêàì äîêóìåíòàöèè íåîáõîäèìû ñëåäóþùèå ðåñóðñû:

a) êîïèè ôóíêöèîíàëüíîé ïðîåêòíîé äîêóìåíòàöèè íà ñèñòåìó ABC;

b) äîñòóï ê ñèñòåìå ABC;

c) äîñòóï ê ðàçðàáîò÷èêàì ïðîãðàììíîãî îáåñïå÷åíèÿ ñèñòåìû ABC.

Ñ.13 Òåñòèðîâàíèå íà ïðàêòè÷íîñòü

Ïîñëå êîððåêòèðîâêè âòîðîãî ïðîåêòà äîêóìåíòàöèè ïî çàìå÷àíèÿì çàêàç÷èêà äîëæíî áûòü ïðîâåäåíî òåñòèðîâàíèå íà ïðàêòè÷íîñòü ðóêîâîäñòâà ïîëüçîâàòåëÿ è ñïðàâî÷íûõ òåêñòîâ äëÿ ñèñòåìû ABC.

Öåëüþ òåñòèðîâàíèÿ ÿâëÿåòñÿ îöåíêà ñòåïåíè, â êîòîðîé ÿçûê, ñîäåðæàíèå è îôîðìëåíèå ðóêîâîäñòâà ïîëüçîâàòåëÿ è ñïðàâî÷íûõ òåêñòîâ äëÿ ñèñòåìû ABC îáëåã÷àþò ïîëüçîâàòåëÿì ïðàêòè÷åñêîå ïðèìåíåíèå ïðîãðàììíûõ ñðåäñòâ äàííîé ñèñòåìû.

Òåñòèðîâàíèå äîëæíî ïðîâîäèòüñÿ â ìàøèííîì çàëå ñ èñïîëüçîâàíèåì áåòà-âåðñèè òåñòîâ äëÿ ABC; â òåñòèðîâàíèè äîëæíî ó÷àñòâîâàòü ïî îäíîìó ïðåäñòàâèòåëþ îò ðàçðàáîò÷èêîâ ïðîãðàììíûõ ñðåäñòâ è ðàçðàáîò÷èêîâ äîêóìåíòàöèè (äàëåå - ïðåäñòàâèòåëè).

Òåñòèðîâàíèå äîëæíî ïðîâîäèòüñÿ ñ ïðèâëå÷åíèåì ÷åòûðåõ òèïîâûõ ïîëüçîâàòåëåé, ïåðå÷èñëåííûõ â Ñ.4, âûáðàííûõ ïðîèçâîëüíî èç ïåðñîíàëà íî÷íîé ñìåíû, ýêñïëóàòèðóþùåãî ñèñòåìó. Êàæäîìó èç íèõ äîëæíû áûòü äàíû êîïèè ðóêîâîäñòâà ïîëüçîâàòåëÿ è ñïðàâî÷íûõ òåêñòîâ äëÿ ñèñòåìû ABC ñ ïðîñüáîé âûïîëíèòü ðÿä äåéñòâèé (ïåðå÷èñëåííûõ â ïëàíå òåñòèðîâàíèÿ).

Ïðåäñòàâèòåëè çàïèñûâàþò âðåìÿ âûïîëíåíèÿ êàæäîãî äåéñòâèÿ, çàìå÷àíèÿ ïîëüçîâàòåëÿ è ïðîöåññû, âûïîëíÿåìûå ïîëüçîâàòåëÿìè ïðè ðåàëèçàöèè êàæäîãî äåéñòâèÿ.

Ïðè ïðåâûøåíèè ëþáûì ïîëüçîâàòåëåì âðåìåíè âûïîëíåíèÿ äåéñòâèÿ, óêàçàííîãî â ïëàíå òåñòèðîâàíèÿ, èëè íåïðàâèëüíîì âûïîëíåíèè äàííîãî äåéñòâèÿ ïðåäñòàâèòåëè çàïèñûâàþò ñîîòâåòñòâóþùèå çàìå÷àíèÿ ïîëüçîâàòåëÿ î ïðè÷èíàõ âîçíèêøåé ïðîáëåìû.

Ýòè çàìå÷àíèÿ ïðåäñòàâëÿþòñÿ ïà ñîâåùàíèè ïî ðàññìîòðåíèþ äîêóìåíòàöèè è â êà÷åñòâå èçìåíåíèé â ïðîåêò äîêóìåíòàöèè. Íà ñîâåùàíèè îïðåäåëÿþò öåëåñîîáðàçíîñòü ïðîâåäåíèÿ ïîâòîðíîãî òåñòèðîâàíèÿ.

Ñ.14 Ãðàôèê ðàáîò

Ãðàôèê ðàáîò ïîêàçàí â òàáëèöå Ñ.3.

Òàáëèöà Ñ.3 - Ãðàôèê ðàáîò

Ýòàï

Ñðîê

Îòíîøåíèÿ

Ïðåäñòàâëåíèå ïåðâîãî ïðîåêòà

01.01.99

Ïëàí äîêóìåíòèðîâàíèÿ óòâåðæäåí 15.12.98

Ïðåäñòàâëåíèå âòîðîãî ïðîåêòà

15.02.99

Òðè íåäåëè íà ïðîâåðêó ïåðâîãî ïðîåêòà

Òåñòèðîâàíèå íà ïðàêòè÷íîñòü

15.03.99

 

Ïðåäñòàâëåíèÿ ñïðàâî÷íûõ òåêñòîâ

15.04.99

Òåñòèðîâàíèå íà ïðàêòè÷íîñòü

Ïðåäñòàâëåíèå ãðàíîê

15.04.99

Òåñòèðîâàíèå íà ïðàêòè÷íîñòü; äâå íåäåëè íà ïðîâåðêó âòîðîãî ïðîåêòà

Ïîäãîòîâêà ôîòîøàáëîíîâ

30.04.99

Òåñòèðîâàíèå íà ïðàêòè÷íîñòü

Ðàñïå÷àòêà è áðîøþðîâêà

15.05.99

Íàëè÷èå ïåðåïëåòåííûõ òîìîâ

ÏÐÈËÎÆÅÍÈÅ D

(ñïðàâî÷íîå)

Îòíîøåíèÿ ìåæäó àóäèòîðèÿìè, âûäàííûìè çàäàíèÿìè, áóìàæíîé è äèàëîãîâîé äîêóìåíòàöèåé

Ïðîåêòèðîâàíèå äîêóìåíòàöèè íà÷èíàåòñÿ ñ àíàëèçà ïîëüçîâàòåëåé äîêóìåíòèðóåìîé ñèñòåìû. Êàê ïðàâèëî, ñóùåñòâóþò îïðåäåëåííûå ãðóïïû ïîëüçîâàòåëåé, îáúåäèíÿåìûå â îïðåäåëåííûå àóäèòîðèè â ñîîòâåòñòâèè ñ èõ ïîòðåáíîñòÿìè.

 ðÿäå ñëó÷àåâ èåðàðõèþ àóäèòîðèé öåëåñîîáðàçíî ïðåäñòàâëÿòü â âèäå îòäåëüíûõ ãðóïï, êàê ïîêàçàíî íà ðèñóíêå D.1.

Ðèñóíîê D.1 - Èåðàðõèÿ àóäèòîðèé

 ðÿäå ñëó÷àåâ ñëåäóåò âûáèðàòü àóäèòîðèþ, èñõîäÿ èç îïûòíîñòè ïîëüçîâàòåëÿ äàííîé àóäèòîðèè ïî èñïîëüçîâàíèþ ñèñòåìû. Íàïðèìåð, àóäèòîðèè ìîãóò áûòü îïðåäåëåíû êàê «Íåîïûòíûå ïîëüçîâàòåëè» èëè «Îïûòíûå ïîëüçîâàòåëè».

Ïîñëå îïðåäåëåíèÿ ïåðå÷íÿ àóäèòîðèé äëÿ êîíêðåòíîé ñèñòåìû íà ñëåäóþùåì ýòàïå ñëåäóåò îïðåäåëèòü çàäàíèÿ (tasks), âûïîëíÿåìûå êàæäîé àóäèòîðèåé. ×àñòî äàííûå çàäàíèÿ ïðåäñòàâëÿþò â âèäå èåðàðõè÷åñêîé ñòðóêòóðû (ñì. ðèñóíîê D.2).

Ðèñóíîê D.2 - Èåðàðõèÿ çàäàíèé

Íà ñëåäóþùåì ýòàïå äëÿ îïðåäåëåííîé àóäèòîðèè â ðàìêàõ âûäàííûõ åé çàäàíèé îïðåäåëÿþò ïåðå÷åíü åå ïîòðåáíîñòåé â èíôîðìàöèè (information needs). Íà îñíîâå äàííîãî ïåðå÷íÿ îïðåäåëÿþò ñîäåðæàíèå êîíêðåòíîãî äîêóìåíòà, êàê ïîêàçàíî íà ðèñóíêå 3.

Ðèñóíîê D.3 - Èíôîðìàöèîííûå ïîòðåáíîñòè

Íà äàííîì ýòàïå (íî íå ðàíåå) ñëåäóåò îïðåäåëèòü âèä (òèï) êîíêðåòíîãî äîêóìåíòà è ìàøèííûé íîñèòåëü, íà êîòîðîì îí ïîñòàâëÿåòñÿ.

Íàïðèìåð, èíôîðìàöèîííûå ïîòðåáíîñòè äàííîé àóäèòîðèè â ðàìêàõ êîíêðåòíîãî çàäàíèÿ ìîãóò áûòü óäîâëåòâîðåíû â ôîðìàòå ïå÷àòíîãî ðóêîâîäñòâà, äèàëîãîâîãî ðóêîâîäñòâà, êîíòåêñòíî-çàâèñèìûõ ñïðàâî÷íûõ ýêðàíîâ, ñïðàâî÷íûõ ñõåì èëè âèäåî- è îïåðàòèâíûõ ðóêîâîäñòâ.

Îáû÷íî ñòðåìÿòñÿ ñîêðàòèòü íîìåíêëàòóðó ðàçðàáàòûâàåìûõ äîêóìåíòîâ. Ïðè ýòîì ñòàðàþòñÿ îäèí äîêóìåíò èñïîëüçîâàòü â ðàçíûõ öåëÿõ.

Íà ðèñóíêå D.4 ïîêàçàíû âèäû äåÿòåëüíîñòè (ðàáîòû), âûïîëíÿåìûå â ïðîöåññå ïðîåêòèðîâàíèÿ äîêóìåíòàöèè. Îäíèì èç âàæíûõ ìîìåíòîâ ÿâëÿåòñÿ ïðåäñòàâëåíèå ïîëüçîâàòåëþ íåîáõîäèìûõ ñâåäåíèé íà ðàçëè÷íûõ íîñèòåëÿõ; ïîòðåáíîñòü â ýòîì íå ïðåäîïðåäåëÿåòñÿ ðîëüþ äèàëîãîâîé èëè áóìàæíîé äîêóìåíòàöèè; ðîëüþ ëþáîãî íîñèòåëÿ ÿâëÿåòñÿ ïðåäñòàâëåíèå ïîëüçîâàòåëþ íåîáõîäèìûõ ñâåäåíèé â òðåáóåìîì âèäå (ôîðìàòå) â çàâèñèìîñòè îò êîíêðåòíîé àóäèòîðèè, ïðîäóêòà è íàáîðà çàäàíèé ïîëüçîâàòåëÿ. Ïëàíèðîâàíèå äîêóìåíòàöèè (â ñîîòâåòñòâèè ñ íàñòîÿùèì ñòàíäàðòîì) ñâÿçàíî òîëüêî ñ óñòàíîâëåíèåì íàáîðà ñâåäåíèé, íåîáõîäèìûõ ïîëüçîâàòåëÿì, è ëèøü â êîíöå ïðîöåññà äîêóìåíòèðîâàíèÿ ðåøàåòñÿ âîïðîñ î âûáîðå íîñèòåëÿ, íà êîòîðîì ñëåäóåò ïðåäñòàâëÿòü ýòè ñâåäåíèÿ. Íàïðèìåð, äèàëîãîâóþ è áóìàæíóþ äîêóìåíòàöèþ ñëåäóåò ïëàíèðîâàòü îäíîâðåìåííî, òàê êàê îäíîìó ïîëüçîâàòåëþ äëÿ ïîëó÷åíèÿ íåîáõîäèìûõ ñâåäåíèé ìîæåò ïîòðåáîâàòüñÿ äîêóìåíòàöèÿ îáîèõ âèäîâ.

Ðèñóíîê D.4 - Îáùàÿ ñòðóêòóðà ïðîöåññà ïðîåêòèðîâàíèÿ äîêóìåíòèðîâàíèÿ

Áîëåå ïîäðîáíîå îïèñàíèå ïðîöåññà ïðîåêòèðîâàíèÿ äîêóìåíòàöèè ïðèâåäåíî â BS 7649-93 [2].

ÏÐÈËÎÆÅÍÈÅ Å

(ñïðàâî÷íîå)

Ðåêîìåíäàöèè ïî íàïèñàíèþ íà àíãëèéñêîì ÿçûêå äîêóìåíòàöèè, ïîäëåæàùåé ïîñëåäóþùåìó ïåðåâîäó

Å.1 Îáùèå ïîëîæåíèÿ

 íàñòîÿùåì ïðèëîæåíèè ïðèâåäåíû ðåêîìåíäàöèè, êîòîðûå ñëåäóåò ó÷èòûâàòü ïðè íàïèñàíèè íà àíãëèéñêîì ÿçûêå èñõîäíûõ ìàòåðèàëîâ, ïîäëåæàùèõ ïîñëåäóþùåìó ïåðåâîäó íà äðóãèå ÿçûêè. Áîëüøàÿ ÷àñòü äàííûõ ðåêîìåíäàöèé îòíîñèòñÿ êàê ê áóìàæíîé, òàê è äèàëîãîâîé äîêóìåíòàöèè.

Å.2 Òåðìèíîëîãèÿ

 ÷àñòè òåðìèíîëîãèè, èñïîëüçóåìîé â äîêóìåíòàõ, íåîáõîäèìî ðóêîâîäñòâîâàòüñÿ ñëåäóþùèìè ïðàâèëàìè:

a) ïðèìåíÿòü îáùèå è íåòåõíè÷åñêèå òåðìèíû â ñîîòâåòñòâèè ñ èõ îïðåäåëåíèÿìè, óñòàíîâëåííûìè â îáùèõ ñëîâàðÿõ;

b) ñîçäàâàòü ãëîññàðèè (ñëîâíèêè), ñîäåðæàùèå:

1) îïðåäåëåíèÿ âñåõ ñïåöèôè÷åñêèõ è íåèçâåñòíûõ òåðìèíîâ,

2) âèäû è îïðåäåëåíèÿ âñåõ îáîçíà÷åíèé è ñîêðàùåíèé,

3) òîëêîâàíèÿ íåïðèâû÷íîãî èñïîëüçîâàíèÿ ñëîâ, ïðèìåíåíèå èìåí ñóùåñòâèòåëüíûõ â êà÷åñòâå íàðå÷èé,

4) áèáëèîãðàôèþ ñïåöèàëèçèðîâàííûõ ñëîâàðåé è ñòàíäàðòîâ;

c) ñïåöèàëüíàÿ òåðìèíîëîãèÿ äîëæíà áûòü îñíîâàíà íà íàöèîíàëüíûõ èëè ìåæäóíàðîäíûõ òåðìèíîëîãè÷åñêèõ ñòàíäàðòàõ, îáùåïðèçíàííûõ ñëîâàðÿõ èëè ñîãëàñîâàííûõ ãëîññàðèÿõ;

d) êàæäîå ñîêðàùåíèå äîëæíî áûòü ðàñøèôðîâàíî ïðè ïåðâîì åãî ïîÿâëåíèè â òåêñòå îñíîâíîé ÷àñòè äîêóìåíòà;

e) êàæäûé òåðìèí äîëæåí îäèíàêîâî òðàêòîâàòüñÿ â äîêóìåíòå, äèàëîãîâîé èíôîðìàöèè è ñèñòåìíîé áèáëèîòåêå;

f) ñîñòàâíûå âûðàæåíèÿ (íàïðèìåð, «ââîä äàííûõ [data input]») äîëæíû èìåòü îäíî ñìûñëîâîå çíà÷åíèå âî âñåé äîêóìåíòàöèè;

g) ñîñòàâíûå âûðàæåíèÿ íå äîëæíû ñîäåðæàòü áîëåå òðåõ ñëîâ;

h) îäíî è òî æå ñëîâî íå äîëæíî èñïîëüçîâàòüñÿ äëÿ ðàçëè÷íûõ ÷àñòåé ðå÷è;

i) âñå ñïåöèôè÷åñêèå è ñïåöèàëüíûå òåðìèíû äîëæíû èñïîëüçîâàòüñÿ â ñîîòâåòñòâóþùåì êîíòåêñòå;

j) òåðìèíû, ââîäèìûå âíå ñîîòâåòñòâóþùåãî êîíòåêñòà, íàïðèìåð íàèìåíîâàíèÿ êëàâèø èëè êîìàíäû, äîëæíû áûòü îïðåäåëåíû â ãëîññàðèè;

k) ñëåäóåò èçáåãàòü èñïîëüçîâàíèÿ òåðìèíà «áèëëèîí (billion)».

Ïðèìå÷àíèå - Àìåðèêàíñêèé áèëëèîí (109) íå ñîâïàäàåò ñ àíãëèéñêèì áèëëèîíîì (1012);

l) ñëåäóåò èçáåãàòü èñïîëüçîâàíèÿ òåðìèíà «ïåðåâîä (translation)», íàïðèìåð ïðè ññûëêå íà ïåðåâîä â ôîðìàò ôàéëà, â ñìûñëîâîì çíà÷åíèè, îòëè÷íîì îò ïåðåâîäà ñ îäíîãî ÿçûêà íà äðóãîé. Âìåñòî ýòîãî ñëåäóåò ïðèìåíÿòü òåðìèí «ïðåîáðàçîâàíèå (convertion)».

Å.3 Ñòèëü ïåðåâîäà

Å.3.1 Îáîçíà÷åíèÿ

Ñëåäóåò èñïîëüçîâàòü òîëüêî îáùåïðèíÿòûå îáîçíà÷åíèÿ, êîòîðûå äîëæíû áûòü ðàñøèôðîâàíû â ñïèñêå îáîçíà÷åíèé. Íå äîëæíû ïðèìåíÿòüñÿ ñëåäóþùèå îáîçíà÷åíèÿ:

a) àìåðèêàíñêèé ñèìâîë «#» äëÿ ôóíòà;

b) ïðèïîäíÿòàÿ òî÷êà (∙) äëÿ îïåðàöèè óìíîæåíèÿ.

Å.3.2 Íåîäíîçíà÷íî òðàêòóåìûå ñëîâà

Àâòîðû äîêóìåíòîâ äîëæíû èçáåãàòü èñïîëüçîâàíèÿ ñëåäóþùèõ íåîäíîçíà÷íî òðàêòóåìûõ ñëîâ:

a) who (êòî), that (êîòîðûé), which (êàêîé);

b) only (òîëüêî), merely (ïðèáëèçèòåëüíî), just (åäâà), mainly (â îñíîâíîì), simply (ïðîñòî);

c) while (ïîêà);

d) so (òàêèì îáðàçîì);

e) as (êàê);

f) can (èìåòü âîçìîæíîñòü), may (ìî÷ü);

g) since (òàê êàê);

h) when (êîãäà), if (åñëè);

i) alternate (äîïîëíèòåëüíûé), alternative (àëüòåðíàòèâíûé).

Å.3.3 Ñèíòàêñèñ

Äîëæíû áûòü ó÷òåíû ñëåäóþùèå âîïðîñû ñèíòàêñèñà:

a) ïðåäëîæåíèÿ íå äîëæíû áûòü ñëèøêîì äëèííûìè;

b) ñëåäóåò èçáåãàòü ïîñòðîåíèÿ ïðåäëîæåíèé, îïèñûâàþùèõ ðÿä ïîëîæåíèé, ðàçäåëÿåìûõ ÷ðåçìåðíûì êîëè÷åñòâîì çàïÿòûõ;

c) ïóíêòû, ñîäåðæàùèå îïðåäåëåííûå îãðàíè÷åíèÿ, è ïóíêòû áåç îãðàíè÷åíèé äîëæíû áûòü ïðåäñòàâëåíû ðàçäåëüíî.

Å.3.4 Ïóíêòóàöèÿ

Òàì, ãäå ìîãóò áûòü èñïîëüçîâàíû ñêîáêè èëè òî÷êà ñ çàïÿòîé, íå ñëåäóåò ïðèìåíÿòü òèðå.

Å.4 Ôèçè÷åñêèå ôàêòîðû

Íåîáõîäèìî ó÷èòûâàòü ñëåäóþùèå ôèçè÷åñêèå ôàêòîðû:

a) ñîêðàùåíèÿ íåöåëåñîîáðàçíî èñïîëüçîâàòü òîëüêî äëÿ ýêîíîìèè ìåñòà;

b) ïðåäóñìîòðåòü íåîáõîäèìûå ìåñòà äëÿ ïðîñòàíîâêè ñîîòâåòñòâóþùèõ çíà÷åíèé, íàïðèìåð öåíû;

c) ñëåäóåò èñïîëüçîâàòü ñòàíäàðòíûå ãðàôè÷åñêèå èíñòðóìåíòàëüíûå ñðåäñòâà (ïàêåòû) è èçáåãàòü ïðèìåíåíèÿ âêëååê;

d) èçáåãàòü âíåñåíèÿ ïîÿñíÿþùåãî òåêñòà â ðèñóíêè;

e) ñëåäóåò èñïîëüçîâàòü ãðàôè÷åñêèå ñèìâîëû, èìåþùèå îáùåïðèíÿòîå ñìûñëîâîå çíà÷åíèå;

f) ïî âîçìîæíîñòè âìåñòî ñëîâåñíîãî ïîÿñíåíèÿ èñïîëüçîâàòü ãðàôè÷åñêèå èçîáðàæåíèÿ.

Å.5 Äèàëîãîâàÿ èíôîðìàöèÿ

Ïðèìåíèòåëüíî ê äèàëîãîâîé èíôîðìàöèè íåîáõîäèìî ó÷èòûâàòü ñëåäóþùèå ïîëîæåíèÿ:

a) ïðè íàëè÷èè îáðàòíîé ñâÿçè ñ ðàçðàáîò÷èêàìè ïðîãðàììíûõ ñðåäñòâ ñëåäóåò îáåñïå÷èòü âûäåëåíèå äèàëîãîâîé èíôîðìàöèè (òåêñòîâ è ñîîáùåíèé) èç ëîãèêè ïðîãðàììû;

b) êàæäûé áëîê òåêñòà èëè ñîîáùåíèå äîëæíû èìåòü èíäèâèäóàëüíîå èäåíòèôèêàöèîííîå îáîçíà÷åíèå ñ óêàçàíèåì ñîîòâåòñòâóþùåé êëàññèôèêàöèîííîé ãðóïïû äàííîãî òåêñòà èëè ñîîáùåíèÿ;

c) êîíêðåòíîå ïðîãðàììíîå ñðåäñòâî íå äîëæíî îðèåíòèðîâàòüñÿ íà äëèíó, ôîðìàò èëè ðàñïîëîæåíèå íåçàùèùåííûõ ýêðàííûõ ïîëåé ââîäà-âûâîäà (input and output fields);

d) äëÿ êàæäîãî ïîíÿòèÿ ñëåäóåò èñïîëüçîâàòü îòäåëüíîå ñîîáùåíèå. Ñîîáùåíèÿ íå äîëæíû áûòü íàäóìàííûìè;

e) ïåðåìåííûå â ñîîáùåíèè äîëæíû ñîäåðæàòü òîëüêî íåïåðåâîäèìóþ èíôîðìàöèþ, íàïðèìåð êëþ÷åâûå ñëîâà è êîäû âîçâðàòà;

f) èç ïðåäëîæåíèé íå ñëåäóåò èñêëþ÷àòü ïðåäëîãè â öåëÿõ ýêîíîìèè ìåñòà.

Å.6 Êóëüòóðíûå ôàêòîðû

Ïðèìåíèòåëüíî ê êóëüòóðíûì ôàêòîðàì íåîáõîäèìî ó÷èòûâàòü ñëåäóþùèå ïîëîæåíèÿ:

a) èëëþñòðàòèâíûå ìàòåðèàëû (íàïðèìåð, ëèöà, æèâîòíûå è çâóêè ðå÷è) äîëæíû áûòü íåçàâèñèìûìè îò íàöèîíàëüíûõ êóëüòóðíûõ îñîáåííîñòåé;

b) ñëåäóåò èçáåãàòü èñïîëüçîâàíèÿ ïðèìåðîâ, ñâÿçàííûõ ñî ñïåöèôè÷åñêèìè íàöèîíàëüíûìè òðàäèöèÿìè èëè îñîáåííîñòÿìè (íàïðèìåð, ïðàçäíèêàìè, áàíêîâñêèì äåëîì, çàðïëàòîé, ñïîðòîì è ò.ä.);

c) â òåêñòå è èëëþñòðàöèÿõ ñëåäóåò èçáåãàòü èñïîëüçîâàíèÿ èäèîìàòè÷åñêèõ âûðàæåíèé, ïðèñóùèõ íàöèîíàëüíîìó ÿçûêó äîêóìåíòàòîðà;

d) ñëåäóåò èçáåãàòü èñïîëüçîâàíèÿ þìîðèñòè÷åñêèõ âûðàæåíèé, îñîáåííî êàëàìáóðîâ.

e) ñëåäóåò îñòîðîæíî èñïîëüçîâàòü èðîíè÷åñêèå âûðàæåíèÿ;

f) íåîáõîäèìî èçáåãàòü èñïîëüçîâàíèÿ ñëåíãîâûõ, æàðãîííûõ è ïðîñòîíàðîäíûõ âûðàæåíèé;

g) íå äîëæíû èñïîëüçîâàòüñÿ óïîìèíàíèÿ ïåðâûõ ëèö ãîñóäàðñòâà;

h) íå ñëåäóåò âûðàæàòü äàòû òîëüêî â ÷èñëîâîì âèäå. Ìåñÿö âñåãäà äîëæåí áûòü íàïèñàí ïîëíîñòüþ (íàïðèìåð, 28 èþëÿ 1991);

i) îáû÷íî ñëåäóåò èñïîëüçîâàòü äâóìåðíûå ïðåäñòàâëåíèÿ, åñëè ìåæäóíàðîäíûå ñîãëàøåíèÿ íå òðåáóþò èíîãî (íàïðèìåð, äëÿ àâòîøèí, âîäîïðîâîäîâ, ãâîçäåé è ôîòîïëåíêè);

j) êîãäà ìåòðè÷åñêèå âåëè÷èíû ðàñïîëàãàþòñÿ âìåñòå ñ âåëè÷èíàìè â äðóãèõ ñèñòåìàõ èçìåðåíèÿ, èç êîíòåêñòà äîëæíî áûòü ïîíÿòíî, êàêàÿ èç âåëè÷èí îòíîñèòñÿ ê ñîîòâåòñòâóþùåé ñèñòåìå èçìåðåíèé.

ÏÐÈËÎÆÅÍÈÅ F

(ñïðàâî÷íîå)

Îöåíêà ïðîåêòà

F.1 Îáùèå ïîëîæåíèÿ

 íàñòîÿùåì ïðèëîæåíèè ïðåäñòàâëåí ðÿä ðåêîìåíäóåìûõ ìåòîäîâ îöåíêè ïðîåêòà.  ðÿäå ñëó÷àåâ ýòè ìåòîäû ïðîòèâîðå÷àò äðóã äðóãó, òàê êàê îöåíêà ïðîåêòà äîêóìåíòèðîâàíèÿ äîñòàòî÷íî ñóáúåêòèâíà.  ÷àñòíîñòè, äàííûå îöåíêè ìîãóò áûòü çàâûøåííûìè ïðè âíåñåíèè èçìåíåíèé â ïðîãðàììíîå ñðåäñòâî â ïðîöåññå åãî äîêóìåíòèðîâàíèÿ.

Äàííûå ìåòîäû ïîçâîëÿþò ñäåëàòü ïðàêòè÷åñêèå ïðèêèäêè, íà ôàêòè÷åñêèå ñðîêè ðåàëèçàöèè ïðîåêòà ñëåäóåò ïðîñòàâëÿòü èñõîäÿ èç ïðàêòè÷åñêîãî îïûòà ýêñïåðòîâ, ïðîâîäÿùèõ ñîîòâåòñòâóþùèå îöåíêè.

F.2 Ïîìèíóòíûé è ïî÷àñîâîé ìåòîäû

Äàííûå ìåòîäû ïðåäóñìàòðèâàþò îêîëî 3 ÷ äëÿ íàïèñàíèÿ ñòðàíèöû òåêñòà, ïðèãîäíîãî äëÿ ïóáëèêàöèè. Âðåìÿ, íåîáõîäèìîå äëÿ ñîçäàíèÿ ãðàôè÷åñêèõ ìàòåðèàëîâ, îïðåäåëÿåòñÿ èõ ñëîæíîñòüþ è êîëè÷åñòâîì ÷åðíîâèêîâ, íåîáõîäèìûõ äëÿ ñîçäàíèÿ ñîîòâåòñòâóþùåãî îðèãèíàëà.

Ïî îáùåé îöåíêå òðåáóåòñÿ îò 3 äî 5 ÷ äëÿ ñîçäàíèÿ è êîððåêòèðîâêè òèïîâîãî ãðàôè÷åñêîãî ìàòåðèàëà, èñïîëüçóåìîãî â ïðîãðàììíîé äîêóìåíòàöèè (èñêëþ÷àÿ ýêðàííûå ðàñïå÷àòêè).

 íà÷àëå ïðîåêòà òðóäíî îöåíèòü îáùèé ïîñòðàíè÷íûé îáúåì ñîçäàâàåìîé äîêóìåíòàöèè. Åñëè äëÿ çàâåðøåíèÿ ïðîåêòà òðåáóåòñÿ áîëåå 2 ìåñ, ïîäñ÷åò ñòðàíèö äîëæåí áûòü ïðîâåäåí ïî èñòå÷åíèè ïåðâîãî ìåñÿöà.

Äëÿ î÷åíü áîëüøèõ ïðîåêòîâ íîìåíêëàòóðà ïîñòàâêè äîëæíà áûòü ðàçäåëåíà íà ÷àñòè, ïîääàþùèåñÿ óïðàâëåíèþ. Ïðè ýòîì îöåíêà ñðîêîâ çàâåðøåíèÿ ïðîåêòà â öåëîì ìîæåò áûòü äàíà òîëüêî â êîëè÷åñòâå ìåñÿöåâ, à äåòàëüíî ìîæåò áûòü îöåíåíà ëèøü ïåðâàÿ ÷àñòü ðàáîòû. Ïðè èñïîëüçîâàíèè äàííîãî ìåòîäà äîêóìåíòàòîð è çàêàç÷èê äîëæíû ñâåðèòü ñâîè îöåíêè ñðîêîâ çàâåðøåíèÿ ïðîåêòà.

 òàáëèöå F.1 ïðèâåäåíû ñðîêè ðåàëèçàöèè «òèïîâîãî» (ãèïîòåòè÷åñêîãî) ïðîåêòà. Ïðè ýòîì ïðåäïîëàãàåòñÿ, ÷òî àâòîð ãîòîâèò ìàòåðèàëû íåïîñðåäñòâåííî íà ïåðñîíàëüíîì êîìïüþòåðå, è äëÿ èõ âûïóñêà èñïîëüçóþò ïîðòàòèâíûå èçäàòåëüñêèå ñèñòåìû.

Òàáëèöà F.1 - Îðèåíòèðîâî÷íûå ñðîêè

Ýòàï

Ñðîê

Îïðåäåëåíèå íîìåíêëàòóðû ïîñòàâêè

16 ÷ íà ïðîåêò

Èññëåäîâàíèå ñîäåðæàíèÿ äîêóìåíòàöèè

24 ÷ íà ïðîåêò

Íàïèñàíèå ïëàíà äîêóìåíòèðîâàíèÿ

48 ÷ íà ïðîåêò

Ïðîåêòèðîâàíèå ñòðóêòóðû äîêóìåíòà è ïðàâèë îôîðìëåíèÿ åãî ñòðàíèö

8 ÷ íà òîì

Íàïèñàíèå ïåðâîé ðåäàêöèè (äîêóìåíòàöèè)

1 ÷ íà ñòðàíèöó

Ðàçðàáîòêà ãðàôè÷åñêèõ ìàòåðèàëîâ

5 ÷ íà ìàòåðèàë

Îáúåäèíåíèå òåêñòîâûõ è ãðàôè÷åñêèõ ìàòåðèàëîâ

30 ìèí íà ñòðàíèöó

Ïðîâåðêà ïåðâîé ðåäàêöèè (ýêñïåðò)

30 ìèí íà ñòðàíèöó

Êîððåêòèðîâêà ïåðâîé ðåäàêöèè è ãðàôèêè

30 ìèí íà ñòðàíèöó

Âíåñåíèå çàìå÷àíèé ïîëüçîâàòåëÿ

30 ìèí íà ñòðàíèöó

Ãðàììàòè÷åñêîå ðåäàêòèðîâàíèå

15 ìèí íà ñòðàíèöó

Ïîäãîòîâêà âòîðîé ðåäàêöèè (äîêóìåíòàöèè)

15 ìèí íà ñòðàíèöó

Ïðîâåðêà âòîðîé ðåäàêöèè (ýêñïåðò)

15 ìèí íà ñòðàíèöó

Îêîí÷àòåëüíàÿ êîððåêòèðîâêà äîêóìåíòàöèè

10 ìèí íà ñòðàíèöó

Íîðìîêîíòðîëü äîêóìåíòàöèè

15 ìèí íà ñòðàíèöó

Èçãîòîâëåíèå ôîòîøàáëîíîâ

3 ñóò

Ïå÷àòü è ïåðåïëåòåíèå îðèãèíàëîâ

5 ñóò

Ïå÷àòü è áðîøþðîâêà êîïèé

10 ñóò

Ðàññûëêà

1 ñóò

F.3 Ìåòîä íèñõîäÿùåãî ïðîåêòèðîâàíèÿ

F.3.1 Îáùèå ïîëîæåíèÿ

Äàííûé ìåòîä îñíîâàí íà ïðåäïîëîæåíèè, ÷òî ÷èñëî ñòðàíèö â ïóáëèêàöèè(ÿõ) ìîæåò áûòü îöåíåíî äîñòàòî÷íî ïðîñòî ñ èñïîëüçîâàíèåì ñëåäóþùèõ äîïóùåíèé:

a) àâòîð ìîæåò çà ìåñÿö ïîäãîòîâèòü 22 ñòðàíèöû íîâîãî òåêñòà;

b) àâòîð ìîæåò çà ìåñÿö ïîäãîòîâèòü 44 ñòðàíèöû òåêñòà ñ èçìåíåíèÿìè.

Íàïðèìåð, îáúåì ïóáëèêàöèè îöåíåí â 150 ñòðàíèö. Ïîñêîëüêó ýòî íîâàÿ ïóáëèêàöèÿ, ïîëó÷àåì: 150/22 = 7 ÷åë./ìåñ.  ýòè 7 ìåñ âõîäÿò: ïëàíèðîâàíèå ïóáëèêàöèè, åå íàïèñàíèå, ðåäàêòèðîâàíèå è ïðîâåðêà äâóõ ðåäàêöèé, à òàêæå ïîäãîòîâêà ôîòîøàáëîíîâ.

F.3.2 Ïðîïîðöèè

Ïðîäîëæèòåëüíîñòü 7 ÷åë./ìåñ ðàñïðåäåëåíà â ñëåäóþùèõ ïðîïîðöèîíàëüíûõ îòíîøåíèÿõ:

a) 15 % - ïëàíèðîâàíèå (â äàííîì ïðèìåðå - ÷åòûðå íåäåëè);

b) 50 % - íàïèñàíèå ïåðâîé ðåäàêöèè (14 íåäåëü);

c) 25 % - íàïèñàíèå âòîðîé ðåäàêöèè (ñåìü íåäåëü);

d) 10 % - ïîäãîòîâêà ôîòîøàáëîíîâ (òðè íåäåëè).

F.3.3 Ïëàíèðîâàíèå

Ïåðèîä ïëàíèðîâàíèÿ îõâàòûâàåò:

a) èññëåäîâàíèÿ è ïîäãîòîâêó ïëàíà;

b) èçó÷åíèå è ïðîâåðêó ïëàíà;

c) êîððåêòèðîâêó ïëàíà ïî ðåçóëüòàòàì ïðîâåðêè.

F.3.4 Ïåðâàÿ ðåäàêöèÿ

Ïåðèîä ïåðâîé ðåäàêöèè îõâàòûâàåò:

a) ïîäãîòîâêó ñîäåðæàíèÿ (ïëàíà-ïðîñïåêòà) äîêóìåíòàöèè;

b) èçó÷åíèå è ïðîâåðêó ñîäåðæàíèÿ (ïëàíà-ïðîñïåêòà);

c) ïîäãîòîâêó ïðîáíîãî êóñêà òåêñòà äëÿ ðåäàêòîðà;

d) ðåäàêòèðîâàíèå ïðîáíîãî êóñêà òåêñòà è åãî ïåðåïèñûâàíèå ïî çàìå÷àíèÿì ðåäàêòîðà;

e) íàïèñàíèå âñåé ïåðâîé ðåäàêöèè äîêóìåíòàöèè;

f) ðåäàêòèðîâàíèå âñåé ïåðâîé ðåäàêöèè äîêóìåíòàöèè;

g) ïåðåðàáîòêó îòðåäàêòèðîâàííîé äîêóìåíòàöèè;

h) èçó÷åíèå è ïðîâåðêó ïåðåðàáîòàííîé äîêóìåíòàöèè.

Èëëþñòðàòèâíûå ìàòåðèàëû ãîòîâÿò îäíîâðåìåííî ñ òåêñòîì ïåðâîé ðåäàêöèè.

F.3.5 Âòîðàÿ ðåäàêöèÿ

Ïåðèîä âòîðîé ðåäàêöèè îõâàòûâàåò:

a) âíåñåíèå â äîêóìåíòàöèþ âñåõ èçìåíåíèé, ïðåäëîæåííûõ ïî ðåçóëüòàòàì ïðîâåðêè ïåðâîé ðåäàêöèè;

b) ïîâòîðíîå (âòîðîå) ðåäàêòèðîâàíèå âòîðîé ðåäàêöèè äîêóìåíòàöèè;

c) ïåðåðàáîòêó îòðåäàêòèðîâàííîé äîêóìåíòàöèè;

d) èçó÷åíèå è ïðîâåðêó ïåðåðàáîòàííîé äîêóìåíòàöèè.

F.3.6 Ïðèíÿòàÿ ðåäàêöèÿ

Ðåäàêöèåé äëÿ ôîòîíàáîðà ÿâëÿåòñÿ ïðèíÿòàÿ ðåäàêöèÿ äîêóìåíòèðîâàíèÿ. Åå ïîäãîòîâêà îõâàòûâàåò:

a) âíåñåíèå â äîêóìåíòàöèþ âñåõ èçìåíåíèé, ïðåäëîæåííûõ ïî ðåçóëüòàòàì ïðîâåðêè âòîðîé ðåäàêöèè;

b) ïðîâåðêó ïðàâèëüíîñòè âíåñåíèÿ äàííûõ èçìåíåíèé;

c) óäàëåíèå âñåõ ðåäàêöèîííûõ ðàçìåòîê;

d) èçãîòîâëåíèå ôîòîøàáëîíîâ;

e) îòïðàâêó ôîòîøàáëîíîâ â ïå÷àòü (â òèïîãðàôèþ).

Îáû÷íî ýêñïåðòàì (íîðìîêîíòðîëåðàì) òðåáóåòñÿ îò îäíîé äî äâóõ íåäåëü äëÿ èçó÷åíèÿ è ïîäãîòîâêè çàìå÷àíèé, à ñàìà ïðîâåðêà çàíèìàåò îò îäíîãî äî íåñêîëüêèõ äíåé.

Ìåòîä íèñõîäÿùåãî ïðîåêòèðîâàíèÿ ìîæåò áûòü èñïîëüçîâàí äëÿ ñóùåñòâóþùèõ ïóáëèêàöèé. Íàïðèìåð, êíèãà îáúåìîì 100 ñòðàíèö ìîæåò áûòü ïåðåðàáîòàíà òàê, ÷òî ïîëîâèíà åå èçìåíÿåòñÿ è äîáàâëÿåòñÿ 10 % íîâûõ ìàòåðèàëîâ. Èñïîëüçóÿ âûøåïðèíÿòûå äîïóùåíèÿ, ïîëó÷àåì: 50/44 = 1,13 ÷åë./ìåñ äëÿ ñóùåñòâóþùåãî ìàòåðèàëà ïëþñ 10/22 = 0,45 ÷åë./ìåñ äëÿ âíåñåíèÿ íîâîãî ìàòåðèàëà.

Êîãäà ñðîêè, íåîáõîäèìûå äëÿ ñîçäàíèÿ äîêóìåíòàöèè, ïðåâûøàþò äîïóñòèìûå, äëÿ âûïîëíåíèÿ çàäàíèÿ ñëåäóåò ïðèâëåêàòü íåñêîëüêî àâòîðîâ. Òàê æå ñëåäóåò ïîñòóïàòü ïðè ïîäãîòîâêå íåñêîëüêèõ äîêóìåíòîâ äëÿ îäíîãî ïðîãðàììíîãî ñðåäñòâà.

ÏÐÈËÎÆÅÍÈÅ G

(ñïðàâî÷íîå)

Îöåíêà ïëàíà äîêóìåíòèðîâàíèÿ

Èñïîëüçîâàíèå íàñòîÿùåãî ñòàíäàðòà âî âçàèìîîòíîøåíèÿõ ìåæäó çàêàç÷èêîì è äîêóìåíòàòîðîì ñïîñîáñòâóåò ñîçäàíèþ êà÷åñòâåííîé äîêóìåíòàöèè â ÷àñòíîñòè ïîòîìó, ÷òî ìåæäó íèìè ñîãëàñîâûâàåòñÿ ïëàí äîêóìåíòèðîâàíèÿ. Ýòèì äîñòèãàåòñÿ äâîéíîé ýôôåêò: âî-ïåðâûõ, äîêóìåíòàòîð ó÷èòûâàåò âñå àñïåêòû äîêóìåíòàöèè, îãîâîðåííûå â ïëàíå; âî-âòîðûõ, çàêàç÷èê è äîêóìåíòàòîð ñîãëàñóþò ìåòîä äîêóìåíòèðîâàíèÿ, îïðåäåëåííûé â ïëàíå, åùå äî íà÷àëà ðàáîòû.

Çàêàç÷èê äîëæåí óñòàíîâèòü íàëè÷èå â ïëàíå äîêóìåíòèðîâàíèÿ ñëåäóþùèõ ýëåìåíòîâ:

a) ñîîòâåòñòâóþùèõ îïðåäåëåíèé âñåõ àóäèòîðèé. Ôîðìóëèðîâêà âèäà «Ðóêîâîäñòâî ïðåäíàçíà÷åíî äëÿ àóäèòîðèè, îõâàòûâàþùåé ïîëüçîâàòåëåé ïðîãðàììíîãî ñðåäñòâà» íåïîëíà (ñì. ïðèëîæåíèå D).  îïðåäåëåíèå àóäèòîðèè äîëæíû áûòü âêëþ÷åíû âñå ëèöà, ìîãóùèå èñïîëüçîâàòü äàííîå ïðîãðàììíîå ñðåäñòâî (âêëþ÷àÿ ëèö, êîòîðûå ìîãóò òîëüêî ïðîñìàòðèâàòü îò÷åòû èëè ñîîáùåíèÿ îò äàííîãî ñðåäñòâà);

b) ñîäåðæàíèÿ (ïëàíîâ-ïðîñïåêòîâ) äîêóìåíòàöèè ñ îöåíêîé èõ ïîñòðàíè÷íîãî îáúåìà;

c) îïðåäåëåíèÿ ÷èñëà ïå÷àòíûõ êîïèé è ìåòîäîâ ïå÷àòè (òèðàæèðîâàíèÿ) è áðîøþðîâêè äîêóìåíòàöèè;

d) îäíîçíà÷íîãî îïðåäåëåíèÿ ñîáñòâåííèêà àâòîðñêèõ ïðàâ íà äîêóìåíòàöèþ;

e) óñòàíîâëåíèå ìåòîäîâ ïîäãîòîâêè äîêóìåíòàöèè. Áîëüøèíñòâî òåõíè÷åñêèõ äîêóìåíòîâ ìîæåò áûòü ñîçäàíî ïðè ïîìîùè êîìïüþòåðà;

f) äîñòàòî÷íûõ ñðîêîâ äëÿ ïðîâåðêè çàêàç÷èêîì ðåäàêöèé äîêóìåíòàöèè. Ëþáûå îòñðî÷êè ïðè âîçâðàòå äîêóìåíòàòîðó ïðîâåðåííûõ ðåäàêöèé ìîãóò ïðèâåñòè ê ñðûâó ñðîêîâ ïîñòàâêè äîêóìåíòàöèè;

g) îò îðãàíèçàöèè-çàêàç÷èêà ìîæåò ïîòðåáîâàòüñÿ îáåñïå÷åíèå äîêóìåíòàòîðà ñîîòâåòñòâóþùèìè ðåñóðñàìè (äîñòóïîì ê åå ïåðñîíàëó, îáîðóäîâàíèåì è ò.ä.), ïðè îòñóòñòâèè êîòîðûõ ðàáîòû ìîãóò áûòü ñîðâàíû.

 öåëîì ïëàí äîêóìåíòèðîâàíèÿ äîëæåí ó÷èòûâàòü âñå ñïåöèôè÷åñêèå îáñòîÿòåëüñòâà, îòíîñÿùèåñÿ ê îðãàíèçàöèè-çàêàç÷èêó è ïîëüçîâàòåëÿì. Êðàéíå ìàëîâåðîÿòíà âîçìîæíîñòü èñïîëüçîâàíèÿ ïëàíà äîêóìåíòèðîâàíèÿ, ðàçðàáîòàííîãî â ðàìêàõ îäíîãî ïðîåêòà, äëÿ äðóãîãî.

ÏÐÈËÎÆÅÍÈÅ Í

(ñïðàâî÷íîå)

Îáðàçåö ñïåöèôèêàöèè ñòèëÿ

Í.1 Îáùèå ïîëîæåíèÿ

Ïðåäñòàâëåííûé îáðàçåö ñïåöèôèêàöèè ñòèëÿ äîêóìåíòàöèè ñîîòâåòñòâóåò òðåáîâàíèÿì 8.2 è ïî óìîë÷àíèþ ìîæåò áûòü èñïîëüçîâàí â ïëàíå äîêóìåíòèðîâàíèÿ.

Ïðèìå÷àíèå - Ïåðåä îêîí÷àòåëüíûì ïðèíÿòèåì äàííîé ñïåöèôèêàöèè ïîëåçíî ñîçäàòü íà åå îñíîâå ìîäåëü äîêóìåíòà.

Í.2 Ýëåìåíòû ñòèëÿ

 òàáëèöå Í.1 ïðèâåäåíû ýëåìåíòû ñòèëÿ è èõ ðåêîìåíäóåìûå çíà÷åíèÿ ïî óìîë÷àíèþ.

Òàáëèöà Í.1 - Ýëåìåíòû ñòèëÿ è èõ çíà÷åíèÿ

Ýëåìåíò

Çíà÷åíèå

ßçûê

Àíãëèéñêèé

Îðôîãðàôè÷åñêèé ñëîâàðü

Ñëîâàðü Ìàêâàéðà

Ðóêîâîäñòâî ïî ãðàììàòèêå è èñïîëüçîâàíèþ ñòèëÿ

«Ðóêîâîäñòâî ïî ñòèëþ äëÿ àâòîðîâ, ðåäàêòîðîâ è èçäàòåëåé» Àâñòðàëèéñêîå ãîñóäàðñòâåííîå èçäàòåëüñòâî

Ôîðìàò áóìàãè

À4

Îðèåíòàöèÿ

Êíèæíàÿ (âåðòèêàëüíàÿ)

Âèä ïå÷àòè

Äâóñòîðîííÿÿ

Ðàçðåøàþùàÿ ñïîñîáíîñòü òèïîãðàôñêîé èëè ëàçåðíîé ïå÷àòè

Ìèíèìóì 300 òî÷åê/äþéì

Øèðèíà âíóòðåííåãî ïîëÿ

10 ìì/2,4 öèöåðî*

Øèðèíà âíåøíåãî ïîëÿ

10 ìì/2,4 öèöåðî*

Öâåò êðàñêè

×åðíûé

Öâåò, ìàññà è âèä áóìàãè

Áåëàÿ, 80 ã/ñì2, ìàòîâàÿ

Ðàçäåëèòåëè

Íåò

Ïåðåïëåò

Ïëàñòèêîâûé êîìáèíèðîâàííûé, ñ ïðîçðà÷íîé âåðõíåé è ÷åðíîé íèæíåé îáëîæêàìè, ïëîòíîñòüþ 200 - 260 ã/ñì2

Ìåòîä âîñïðîèçâåäåíèÿ è êà÷åñòâî

Âñå ìàòåðèàëû äîëæíû áûòü ïðèãîäíûìè ê ôîòîêîïèðîâàíèþ è íå èìåòü ïîìàðîê è îáåñöâå÷èâàíèé

Ñõåìà íóìåðàöèè ñòðàíèö

Ñòðàíèöû íóìåðóþò â ôîðìàòå 1, 2, 3 è ò.ä., íà÷èíàÿ ñ ïåðâîé ïîñëå îáëîæêè

Íóìåðàöèÿ òàáëèö è ðèñóíêîâ

Ðèñóíêè íóìåðóþò â ôîðìàòå «Ðèñóíîê 1», «Ðèñóíîê 2» è ò.ä., â ïîðÿäêå èõ ïîÿâëåíèÿ â òåêñòå äîêóìåíòà. Òàáëèöû íóìåðóþò â ôîðìàòå «Òàáëèöà 1», «Òàáëèöà 2» è ò.ä., â ïîðÿäêå èõ ïîÿâëåíèÿ â òåêñòå äîêóìåíòà

×èñëî êîëîíîê

Îäíà

Ñíîñêè èëè êîíöåâûå ïðèìå÷àíèÿ

Íå èñïîëüçóþò

Ïðàâèëà ïàãèíàöèè

Çàãîëîâêè íå äîëæíû ïîïàäàòü â êîíåö ñòðàíèöû. Òàáëèöû îáúåìîì ìåíåå ñòðàíèöû äîëæíû ðàçìåøàòüñÿ íà îäíîé ñòðàíèöå. Êàæäûé çàãîëîâîê ïåðâîãî óðîâíÿ äîëæåí ðàñïîëàãàòüñÿ ââåðõó ïðàâîé ñòðàíèöû

Ïðàâèëà ïëîòíîñòè äîêóìåíòà

Âçàèìîñâÿçàííûå ìàòåðèàëû ñëåäóåò ðàçìåùàòü íà îäíîé ñòðàíèöå èëè íà åå îáîðîòå. Ñëåäóåò ïî âîçìîæíîñòè èçáåãàòü èñïîëüçîâàíèÿ ïîä÷åðêèâàíèÿ, áîëüøèõ êóñêîâ, íàáðàííûõ æèðíûì øðèôòîì, è òåêñòîâ, öåëèêîì íàáðàííûõ çàãëàâíûìè áóêâàìè.

Ìàòåðèàëû äîëæíû çàíèìàòü îò 40 % äî 60 % îáùåãî îáúåìà ñòðàíèöû

Ââîäíûå è âñïîìîãàòåëüíûå ìàòåðèàëû:

- òèòóëüíûé ëèñò

Íà òèòóëüíîì ëèñòå äîëæíî áûòü óêàçàíî íàèìåíîâàíèå ïðîäóêöèè, åå âåðñèÿ, äàòà âûïóñêà äîêóìåíòà è íàçâàíèå äàííîãî òîìà

- èíôîðìàöèÿ î ãàðàíòèÿõ, àâòîðñêèõ ïðàâàõ è òîðãîâîé ìàðêå

Íå ïðèâîäèòñÿ

- ñîäåðæàíèå

 ñîäåðæàíèè äîëæíû áûòü ïðèâåäåíû çàãîëîâêè âñåõ ÷àñòåé, ãëàâ è ðàçäåëîâ ñ óêàçàíèåì íîìåðîâ ñòðàíèö

- ñïèñîê ðèñóíêîâ è òàáëèö

Íå ïðèâîäèòñÿ

- ïðèëîæåíèÿ

Íå ïðåäóñìîòðåíû

- ãëîññàðèé

 ãëîññàðèè äîëæåí áûòü îïðåäåëåí ëþáîé òåðìèí, íåèçâåñòíûé àóäèòîðèè ïîëüçîâàòåëåé äîêóìåíòà, â òåðìèíàõ, çíàêîìûõ äàííîé àóäèòîðèè

- ïåðå÷íè îáîçíà÷åíèé è ñîêðàùåíèé

Ñëåäóåò óêàçàòü âñå âñòðå÷àþùèåñÿ â òåêñòå îáîçíà÷åíèÿ è ñîêðàùåíèÿ. Åñëè äàííûå ýëåìåíòû íå ÿâëÿþòñÿ î÷åâèäíûìè ïî ñìûñëó, îíè äîëæíû áûòü ïîÿñíåíû ñîîòâåòñòâóþùèì òåêñòîì

- óêàçàòåëü

 ñîîòâåòñòâèè ñ Í.3

- ïîðÿäîê

Ðàñïîëàãàþòñÿ â ïîðÿäêå èõ ïåðå÷èñëåíèÿ â íàñòîÿùåé òàáëèöå, îñíîâíàÿ ÷àñòü äîêóìåíòà ðàñïîëàãàåòñÿ ìåæäó ñîäåðæàíèåì è ãëîññàðèåì

Ãàðíèòóðû øðèôòîâ è êåãëè òåêñòà îñíîâíîé ÷àñòè äîêóìåíòà

Times Roman, 12 ï

Îòñòóïû ïî ãîðèçîíòàëè è ïðîáåëû ïî âåðòèêàëè â òåêñòå îñíîâíîé ÷àñòè

Òåêñò îñíîâíîé ÷àñòè äîëæåí èìåòü îáùèé îòñòóï íà 2 ï è ëåâîñòîðîííèé îòñòóï íà 30 ìì/7 öèöåðî. Ìåæäó àáçàöàìè äîëæåí áûòü âåðòèêàëüíûé ïðîáåë â îäíó ñòðîêó

Âûðàâíèâàíèå òåêñòà îñíîâíîé ÷àñòè

Òåêñò îñíîâíîé ÷àñòè äîëæåí áûòü âûðîâíåí ïî ëåâîé ñòîðîíå ñ íåðîâíîñòÿìè ïî ïðàâîìó êðàþ

Êîëè÷åñòâî óðîâíåé è íàèìåíîâàíèÿ çàãîëîâêîâ

×åòûðå; çàãîëîâêè ÷àñòè, ãëàâû, ðàçäåëà è ïîäðàçäåëà

Ñòèëü òåêñòà çàãîëîâêîâ

Âñå çàãîëîâêè äîëæíû áûòü èçëîæåíû â ïîâåñòâîâàòåëüíîì ñòèëå ñ çàãëàâíîé áóêâû è áåç òî÷êè â êîíöå

Ãàðíèòóðû øðèôòîâ, êåãëè è îòñòóïû äëÿ êàæäîãî óðîâíÿ çàãîëîâêîâ

Âñå çàãîëîâêè îôîðìëÿþò øðèôòîì Times Roman ñëåäóþùèìè êåãëÿìè: çàãîëîâîê ÷àñòè - 36 ï, ãëàâû - 24 ï, ðàçäåëà - 18 ï, ïîäðàçäåëà - 14 ï. Çàãîëîâêè äîëæíû áûòü âûðîâíåíû ïî ëåâîìó êðàþ.

Ââåðõó êàæäîãî çàãîëîâêà äîëæåí áûòü ïðîáåë, ðàâíûé äâóì êåãëÿì äàííîãî çàãîëîâêà, çà èñêëþ÷åíèåì ðàñïîëîæåíèÿ çàãîëîâêà ââåðõó ñòðàíèöû. Âíèçó êàæäîãî çàãîëîâêà äîëæåí áûòü ïðîáåë, ðàâíûé êåãëþ äàííîãî çàãîëîâêà

Ãðàôè÷åñêèå ýëåìåíòû, èñïîëüçóåìûå â çàãîëîâêàõ

Íå èñïîëüçóþòñÿ

Êîëîíòèòóëû:

- âåðõíèå

- íèæíèå

Ñîäåðæàò íàçâàíèå ãëàâû è ðàçäåëà. Íàçâàíèå ãëàâû ðàñïîëàãàþò ñî ñòîðîíû ïåðåïëåòà

Ñîäåðæàò íîìåð ñòðàíèöû ñî ñòîðîíû, ïðîòèâîïîëîæíîé ïåðåïëåòó, ñ óêàçàíèåì íà ïðîòèâîïîëîæíîé ñòîðîíå íîìåðà âåðñèè, äàòû åå âûïóñêà è íàèìåíîâàíèÿ äîêóìåíòà

Ãàðíèòóðû øðèôòîâ, êåãëè è ðàñïîëîæåíèå êîëîíòèòóëîâ:

 

- âåðõíèé

Times Roman, êåãëü 12 ï, êîëîíòèòóëû ðàñïîëîæåíû ââåðõó êàæäîé ñòðàíèöû çà èñêëþ÷åíèåì òèòóëüíîãî ëèñòà

- íèæíèé

Times Roman, êåãëü 12 ï, íîìåð ñòðàíèöû êåãëü 12 ï, êîëîíòèòóëû ðàñïîëîæåíû âíèçó êàæäîé ñòðàíèöû çà èñêëþ÷åíèåì òèòóëüíîãî ëèñòà

Ãðàôè÷åñêèå ýëåìåíòû êîëîíòèòóëîâ:

 

- âåðõíèé

Äîëæåí áûòü ïîä÷åðêíóò ëèíèåé òîëùèíîé â 1 ï ñ âåðòèêàëüíûì ïðîáåëîì â 1 ï

- íèæíèé

Äîëæåí áûòü íàä÷åðêíóò ëèíèåé òîëùèíîé â 1 ï ñ âåðòèêàëüíûì èíòåðâàëîì â 1 ï

Íàäïèñü

Íà÷èíàåòñÿ ñ íîìåðà ðèñóíêà ñ äâîåòî÷èåì è òåêñòîì, íàïðèìåð «Ðèñóíîê 1: ...»

Ãàðíèòóðû øðèôòà, êåãëü è ðàñïîëîæåíèå íàäïèñåé

Times Roman italics, êåãëü 10 ï. Íàäïèñè äîëæíû áûòü ðàñïîëîæåíû ïîä ðèñóíêîì

Òàáëèöû

Øèðèíà òàáëèö äîëæíà ñîîòâåòñòâîâàòü ôîðìàòó òåêñòà îñíîâíîé ÷àñòè äîêóìåíòà, à äëÿ èõ îáðàìëåíèÿ èñïîëüçóþò ëèíèè òîëùèíîé â 1 ï

Ãàðíèòóðû øðèôòîâ è ìèíèìàëüíûå êåãëè äëÿ òàáëèö

Times Roman, ìèíèìàëüíûé êåãëü â 8 ï

Îò÷åòû (ñîîáùåíèÿ)

Äîëæíû ñîäåðæàòü ïðàâäîïîäîáíûå (íî íå ôàêòè÷åñêèå) äàííûå

Ãàðíèòóðû øðèôòîâ è ìèíèìàëüíûå êåãëè äëÿ îò÷åòîâ

Courier, ìèíèìàëüíûé êåãëü â 8 ï

Êîìïîíîâêà îò÷åòîâ

Äîëæíû áûòü ïðåäñòàâëåíû â ãîðèçîíòàëüíîé (àëüáîìíîé) êîìïîíîâêå áåç èñïîëüçîâàíèÿ ñòðàíèö-ðàñêëàäîê

Ðàñïå÷àòêè ýêðàíîâ:

 

- ñîäåðæàíèå

 êàæäîì ïîëå ðàñïå÷àòîê ýêðàíîâ äîëæíû áûòü ïðåäñòàâëåíû ïðàâäîïîäîáíûå (íî íå ôàêòè÷åñêèå) äàííûå

- îôîðìëåíèå

Íå äîëæíî áûòü ãîðèçîíòàëüíûõ èëè âåðòèêàëüíûõ èñêàæåíèé. Èõ øèðèíà äîëæíà ñîîòâåòñòâîâàòü ôîðìàòó íàáîðà

- ÷àñòè÷íûå (ò.å. ïðåäñòàâëÿþùèå ÷àñòü ýêðàíà)

Äîëæíû áûòü â ìàñøòàáå ïîëíîýêðàííûõ ðàñïå÷àòîê

Ìèíèìàëüíàÿ òîëùèíà ëèíèé, ãàðíèòóðû øðèôòîâ è êåãëè äëÿ ðèñóíêîâ

0,5 ï, øðèôò Times Roman, ìèíèìàëüíûé êåãëü â 8 ï

Ðèñóíêè

Ðèñóíêè è òåêñò âíóòðè íèõ äîëæíû ðàñïîëàãàòüñÿ ñîîòâåòñòâåííî òåêñòó îñíîâíîé ÷àñòè äîêóìåíòà

Ñòèëü òåêñòà óâåäîìëåíèé è ïðåäîñòåðåæåíèé

Ñòèëü ïîâåñòâîâàòåëüíûé, íà÷èíàåòñÿ ñî ñëîâà «Âíèìàíèå:» èëè «Îñòîðîæíî:»

Ãàðíèòóðû øðèôòîâ, êåãëè è îòñòóïû äëÿ óâåäîìëåíèé è ïðåäîñòåðåæåíèé

Times Roman, êåãëü 24 ï, ðàñïîëîæåíèå - ïî öåíòðó ñòðàíèöû, ïðîáåëû ñâåðõó è ñíèçó, èíòåðâàëû ñâåðõó è ñíèçó - ðàâíûå äâóì ñòðîêàì

Ñïðàâî÷íûé òåêñò

Äîëæíû áûòü îáåñïå÷åíû âîçìîæíîñòè ñîçäàíèÿ êîíòåêñòíûõ è ðàñøèðåííûõ ñïðàâîê, ñïðàâîê î êëàâèøàõ, ñïðàâîê î ñïðàâêàõ è òåðìèíîëîãè÷åñêèõ ñïðàâîê

Äèàëîãîâàÿ äîêóìåíòàöèÿ

Äîëæíà ñîäåðæàòü ðóêîâîäñòâà äëÿ ïîëüçîâàòåëÿ, êîìàíäíûå ñïðàâêè, ðåêîìåíäàöèè ïî ñîîáùåíèÿì è àäìèíèñòðàòèâíóþ èíôîðìàöèþ

Ñîïóòñòâóþùèå ìàòåðèàëû

Èíôîðìàöèÿ ïî îäíîé òåìàòèêå ïî âîçìîæíîñòè äîëæíà ðàñïîëàãàòüñÿ íà îäíîì ýêðàíå

Ïîäñâåòêà è èñïîëüçîâàíèå öâåòà

Öâåòîâîå îôîðìëåíèå â äèàëîãîâîé äîêóìåíòàöèè è ñïðàâî÷íûõ òåêñòàõ íå èñïîëüçóþò. Ïîäñâåòêó (áîëåå ÿðêóþ öâåòîâóþ òîíàëüíîñòü) èñïîëüçóþò òîëüêî äëÿ çàãîëîâêîâ

Äèàëîãîâàÿ äîêóìåíòàöèÿ è ñïðàâî÷íûé òåêñò

Ââåðõó îòîáðàæàåìîãî òåêñòà îñòàâëÿþò ïóñòóþ ñòðîêó (òî åñòü ìåæäó çàãîëîâêîì èëè âåðõîì ýêðàíà è ïåðâîé ñòðîêîé òåêñòà). Ôîðìàò òåêñòà - îäíîêîëîííûé

Çàãîëîâêè äèàëîãîâîé äîêóìåíòàöèè è ñïðàâî÷íîãî òåêñòà

Çàãîëîâêè ïîäñâå÷èâàþò, èñïîëüçóÿ áîëåå ÿðêóþ öâåòîâóþ òîíàëüíîñòü. Ïðèìåíÿþò òîëüêî äâà óðîâíÿ çàãîëîâêîâ. Çàãîëîâêè èçëàãàþò â ïîâåñòâîâàòåëüíîì ñòèëå (ñì. 8.2.3.7.2). Ñâåðõó è ñíèçó êàæäîãî çàãîëîâêà îñòàâëÿþò ïðîáåë, ðàâíûé îäíîé ñòðîêå

Òåêñò îñíîâíîé ÷àñòè ýëåêòðîííîé äîêóìåíòàöèè

Äîëæåí áûòü âûðîâíåí ïî ëåâîé ñòîðîíå, äîïóñêàþòñÿ íåðîâíîñòè ïî ïðàâîìó êðàþ. Ñëåâà îò êàæäîé ñòðîêè òåêñòà îñòàâëÿþò ïðîáåë, ðàâíûé 20 ñèìâîëàì

Ïðàâèëà íàâèãàöèè

Óðîâíè ðàñïîëîæåíèÿ âçàèìîñâÿçàííîé èíôîðìàöèè äîëæíû áûòü îðãàíèçîâàíû è êîíòðîëèðîâàòüñÿ òàê, ÷òîáû ïîëüçîâàòåëè ìîãëè ëåãêî âîçâðàùàòüñÿ â èñõîäíóþ òî÷êó (ïóíêò), ñîäåðæàíèå èëè óêàçàòåëü áåç áëóæäàíèÿ â òåêñòå äîêóìåíòà

Êëàâèàòóðà

Äîëæíû áûòü èñïîëüçîâàíû ñëåäóþùèå êëàâèøè: F1 - äëÿ âûçîâà ñïðàâî÷íîé ñèñòåìû: Alt-Fl èëè Esc - äëÿ âûõîäà èç ñïðàâî÷íîé ñèñòåìû. Íèêàêèå äàííûå, ââåäåííûå ïîëüçîâàòåëåì ðàíåå, íå äîëæíû áûòü ïîòåðÿíû ïðè âîçâðàòå èç ñïðàâî÷íîé ñèñòåìû ê îñíîâíîìó ýêðàíó

* Öèöåðî - øðèôò, êåãëü êîòîðîãî ðàâåí 12 ï (~ 4,51 ìì).

Í.3 Ñïåöèôèêàöèÿ óêàçàòåëÿ

Í.3.1 Îáùèå ïîëîæåíèÿ

Êàæäûé äîêóìåíò, ñîäåðæàùèé áîëåå 32 ñòðàíèö, äîëæåí èìåòü óêàçàòåëü.

Ïðèìå÷àíèå - Óêàçàòåëü äîëæåí îõâàòûâàòü âñå êîìïîíåíòû äîêóìåíòà, âêëþ÷àÿ ââîäíûå ìàòåðèàëû, ïðèëîæåíèÿ, äîïîëíåíèÿ è ðèñóíêè.

Í.3.2 Êà÷åñòâî

Óêàçàòåëü äîëæåí áûòü äîñòàòî÷íî ïîäðîáíûì, ÷òîáû óäîâëåòâîðèòü ïîòðåáíîñòÿì ñîîòâåòñòâóþùèõ àóäèòîðèé.

Ïðèìå÷àíèå - Óêàçàòåëü äîëæåí çàíèìàòü îò 5 % (äëÿ ó÷åáíûõ ðóêîâîäñòâ) äî 10 % (äëÿ ñïðàâî÷íûõ ðóêîâîäñòâ) îáùåãî îáúåìà äàííîãî äîêóìåíòà. Ñëåäóåò ðàññìîòðåòü âîçìîæíîñòü èñïîëüçîâàíèÿ ïðîôåññèîíàëüíûõ êëàññèôèêàòîðîâ.

Í.3.3 Ñîñòàâ (ñîäåðæàíèå) è îðãàíèçàöèÿ óêàçàòåëÿ

Âåñü êîìïëåêò äîêóìåíòàöèè äîëæåí èìåòü åäèíûé óêàçàòåëü, åñëè èíîå íå îãîâîðåíî â ïëàíå äîêóìåíòèðîâàíèÿ.

Ïðèìå÷àíèÿ

1.  êà÷åñòâå çàãîëîâêîâ (ýëåìåíòîâ) óêàçàòåëÿ (ñëîâ èëè ôðàç, âíîñèìûõ â óêàçàòåëü) ñëåäóåò èñïîëüçîâàòü îáúåêòû, âûáðàííûå èç êîíêðåòíîãî äîêóìåíòà (íàïðèìåð, «ïðîãðàììíîå ñðåäñòâî»).

2. Äëÿ ïðåäñòàâëåíèÿ îäèíàêîâîãî ïîíÿòèÿ äîëæåí èñïîëüçîâàòüñÿ îäèí è òîò æå òåðìèí.

3. Â óêàçàòåëå ìîãóò áûòü èñïîëüçîâàíû ïîäçàãîëîâêè, îïèñûâàþùèå íåêîòîðûå àñïåêòû îñíîâíîãî çàãîëîâêà.

4. Çàãîëîâêè óêàçàòåëÿ äîëæíû ïðåäñòàâëÿòü îñíîâíûå ïîíÿòèÿ èç êîíêðåòíîãî äîêóìåíòà. Äëÿ íèõ ñëåäóåò èñïîëüçîâàòü èìåíà ñóùåñòâèòåëüíûå, ïðè íåîáõîäèìîñòè äîïîëíÿÿ èõ ïðèëàãàòåëüíûìè, äðóãèìè ñóùåñòâèòåëüíûìè èëè ãëàãîëàìè.  êà÷åñòâå çàãîëîâêîâ ìîãóò áûòü âçÿòû ìàøèííûå êîìàíäû, èñïîëüçîâàííûå â äîêóìåíòàöèè è ïðåäñòàâëåííûå â âèäå ãëàãîëà.

5. Òåðìèíû, ñîñòîÿùèå èç íåñêîëüêèõ ñëîâ, ñëåäóåò ïðèìåíÿòü êàê çàãîëîâêè áåç ðàçáèâêè èõ íà ïîäçàãîëîâêè.

6. Ñëåäóåò èçáåãàòü èñïîëüçîâàíèÿ ïðåäëîãîâ, åñëè èõ îòñóòñòâèå íå ïðèâîäèò ê íåîäíîçíà÷íîìó ïîíèìàíèþ òåðìèíà.

7. Ïîíÿòèÿ, îòðàæàþùèå ðàçëè÷íûå àñïåêòû îäíîãî îáúåêòà, äîëæíû áûòü ïåðå÷èñëåíû êàê ïîäçàãîëîâêè îñíîâíîãî çàãîëîâêà óêàçàòåëÿ.

8. Ñîêðàùåíèÿ è îáîçíà÷åíèÿ äîëæíû áûòü ðàñïîëîæåíû â àëôàâèòíîì ïîðÿäêå (íàïðèìåð, îáîçíà÷åíèå «BASIC» äëÿ «Beginners All-purpose Symbolic Instruction Code» ìåæäó «Base» è «Bettery»).

9. Çàãîëîâêè óêàçàòåëÿ äîëæíû ðàñïîëàãàòüñÿ â àëôàâèòíîì ïîðÿäêå, ïðîáåë äîëæåí òðàêòîâàòüñÿ êàê ñèìâîë, ïðåäøåñòâóþùèé ïîñëåäóþùåìó (íàïðèìåð, òåðìèí «Alt key» ðàçìåùàåòñÿ ïåðåä «Alternative»).

Í.3.4 Ñïðàâî÷íûå ññûëêè

Äëÿ êàæäîãî ýëåìåíòà (çàãîëîâêà, ïîäçàãîëîâêà) óêàçàòåëÿ äîëæíû áûòü äàíû ëîêàëüíûå ññûëêè ïðè îòñóòñòâèè ïåðåêðåñòíûõ ññûëîê.

 ñïðàâî÷íûõ ññûëêàõ äîëæåí áûòü óêàçàí ëèáî íîìåð ñòðàíèöû äîêóìåíòà (íàïðèìåð, 1, 2), ëèáî íîìåðà ðàçäåëà, ïîäðàçäåëà è ò.ä. (íàïðèìåð, «2.22», «3.34»). Ïðè óêàçàíèè ðèñóíêîâ ñïðàâî÷íûå ññûëêè ìîãóò áûòü äàíû íà èõ íîìåðà.

Ïðèìå÷àíèÿ

1. Îáû÷íî ïîëüçîâàòåëÿì óäîáíåå ïîëüçîâàòüñÿ ññûëêàìè íà ñòðàíèöû, ÷åì íà ðàçäåëû äîêóìåíòà.

2. Äëÿ ýëåìåíòîâ óêàçàòåëÿ íå ñëåäóåò èñïîëüçîâàòü áîëüøèå ïåðå÷íè ëîêàëüíûõ ññûëîê. Ìàêñèìàëüíî óäîáíûìè äëÿ ðàáîòû ÿâëÿþòñÿ ïÿòü ññûëîê (íàïðèìåð, 1, 33, 43, 99, 102). Âî èçáåæàíèå äëèííûõ ïåðå÷íåé ëîêàëüíûõ ññûëîê ñëåäóåò èñïîëüçîâàòü ïîäçàãîëîâêè.

3. Ññûëêè, ïîäëåæàùèå îáñóæäåíèþ, ìîãóò áûòü âûäåëåíû øðèôòîì (ãàðíèòóðîé, êåãëåì).

4. Åñëè ïåðå÷åíü ïîäçàãîëîâêîâ îõâàòûâàåò íåñêîëüêî êîëîíîê (ñòîëáöîâ), ââåðõó êàæäîé êîëîíêè äîëæíî áûòü óêàçàíî íàèìåíîâàíèå îñíîâíîãî çàãîëîâêà ñî ñëîâîì «ïðîäîëæåíèå».

5. Åñëè èñïîëüçóþò îñîáóþ ïîñëåäîâàòåëüíîñòü íóìåðàöèè ñòðàíèö, îíà äîëæíà áûòü óêàçàíà â óêàçàòåëå. Íàïðèìåð, åñëè íóìåðàöèÿ íà÷èíàåòñÿ ñ íîìåðà êàæäîé ãëàâû, äàííûé íîìåð äîëæåí áûòü óêàçàí â ëîêàëüíîé ññûëêå, òî åñòü «2-22, 3-34».

6. Åñëè ýëåìåíò óêàçàòåëÿ èñïîëüçóþò â íåñêîëüêèõ ÷àñòÿõ äîêóìåíòà, íóìåðóåìûõ ïîñëåäîâàòåëüíî, â ëîêàëüíîé ññûëêå äîëæíû áûòü óêàçàíû òîëüêî ïåðâûå è ïîñëåäíèå íîìåðà, ðàçäåëåííûå òèðå (íàïðèìåð, 3-11). Êîãäà òèðå èñïîëüçóþò â íóìåðàöèè ñòðàíèö, äëÿ ðàçäåëåíèÿ ñòðàíèö òèðå íå èñïîëüçóåòñÿ (íàïðèìåð, 3-6 äî 3-8).

Í.3.5 Ïåðåêðåñòíûå ññûëêè

 ïåðåêðåñòíûõ ññûëêàõ íà ñîêðàùåíèÿ, ñèíîíèìû èëè àëüòåðíàòèâíûå âèäû òåðìèíà, âûáðàííûå èç ýëåìåíòîâ óêàçàòåëÿ, ñëåäóåò èñïîëüçîâàòü ñîêðàùåíèå «Ñì.» (íàïðèìåð, ïðîåêò - ñì. îôîðìëåíèå).

Ïðèìå÷àíèå - Äîïîëíèòåëüíî ïåðåêðåñòíàÿ ññûëêà ñ ñîêðàùåíèåì «Ñì.» ìîæåò áûòü äàíà íà äðóãèå ýëåìåíòû äîêóìåíòà. Çà ïåðåêðåñòíîé ññûëêîé íå ñëåäóåò èñïîëüçîâàòü ëîêàëüíóþ ññûëêó.

Ïåðåêðåñòíàÿ ññûëêà ñî ñëîâàìè «Ñì. òàêæå» ìîæåò áûòü äàíà èç áîëåå îáøèðíîãî òåðìèíà íà ìåíåå èñ÷åðïûâàþùèå òåðìèíû, åñëè íå èñïîëüçóåòñÿ ïðÿìàÿ ëîêàëüíàÿ ññûëêà.

Ïðèìå÷àíèå - Ïåðåêðåñòíûå ññûëêè ñî ñëîâàìè «Ñì. òàêæå» ñëåäóåò èñïîëüçîâàòü äëÿ âçàèìîóâÿçêè òåðìèíîâ â èíòåðåñàõ ïîëüçîâàòåëÿ. Ïåðåêðåñòíàÿ ññûëêà ñî ñëîâàìè «Ñì. òàêæå» ïîä îñíîâíûì ýëåìåíòîì óêàçàòåëÿ äîëæíà îáúåäèíÿòü ðÿä ñâÿçàííûõ ýëåìåíòîâ óêàçàòåëÿ, èìåþùèõ ñïðàâî÷íûå ññûëêè. Íàïðèìåð Ðèñóíêè 4

ñì. òàêæå ãðàôè÷åñêèå ýëåìåíòû; ðàñïå÷àòêè ýêðàíîâ

èíäåêñèðîâàíèå 12

ñïèñîê 15

íóìåðàöèÿ 2

Ñëîâà «Ñì.» è «Ñì. òàêæå» îáû÷íî âûäåëÿþò êóðñèâîì.

Áèáëèîãðàôèÿ

 íèæåïåðå÷èñëåííûõ ïóáëèêàöèÿõ ñîäåðæèòñÿ áîëåå ïîäðîáíàÿ èíôîðìàöèÿ ïî íåêîòîðûì òåìàì, ñâÿçàííûì ñ íàñòîÿùèì ñòàíäàðòîì.

Ñîîòâåòñòâóþùèå ìåæäóíàðîäíûå è íàöèîíàëüíûå ñòàíäàðòû

1] ÈÑÎ/ÌÝÊ. 6592-2000* Èíôîðìàöèîííàÿ òåõíîëîãèÿ. Ðóêîâîäñòâî ïî äîêóìåíòèðîâàíèþ ïðèêëàäíûõ àâòîìàòèçèðîâàííûõ ñèñòåì

* Îðèãèíàë ìåæäóíàðîäíîãî ñòàíäàðòà - âî ÂÍÈÈÊÈ Ãîññòàíäàðòà Ðîññèè.

[2] BS 7649-93 Ðóêîâîäñòâî ïî ïðîåêòèðîâàíèþ è âûïóñêó äîêóìåíòàöèè ïîëüçîâàòåëåé ïðèêëàäíûõ ïðîãðàììíûõ ñðåäñòâ

Îáùèå ïîëîæåíèÿ

[3] Barnum Ñ. Ì. and Capliner S. Techniques for Technical Communicators, MacMillan, 1993

[4] Brockmann R. J. Writing Better Computer User Documentation, Wiley, 1990

[5] Brusaw Ñ. Ò., Aired G. J. and Oliu W. E. Handbook of Technical Writing, St. Martins Press, 1993

[6] Burnett R. E. Technical Communications, Wadsworth Publishing, 1994

[7] Hackos J. T. Managing Your Documentation Projects, Wiley, 1994

[8] Holtz H. The Complete Guide to Writing Readable User Manuals. Dow Jones-Irwin, 1988

[9] Horton W. K. Illustrating Computer Documentation. Wiley, 1991

[10] Simpson H. and Casey S. M. Developing Effective User Documentation: A Human Factors Approach. McGraw-Hill, 1988

[11] Weiss E. H. How to Write Usable User Documentation, Oryx Press < 1991

[12] Zinsser W. On Writing Well, Harper and Row < 1994

Äèàëîãîâàÿ äîêóìåíòàöèÿ è ãèïåðòåêñò

[13] Began S., Farkas D. and Wellinske J. Developing On-Line Help for Windows, International Thomson Press, 1995

[14] Brown Ñ. Ì. Human-Computer Interface Design. Norwood, 1988

[15] Helander (Ed). Handbook of Human-Computer Interaction. North Holland

[16] Horton W. K. Designing and Writing On-line Documentation, Help Text to Hypertext. Wiley, 1990

[17] Horton W. K. Designing and Writing On-line Documentation: Hypermedia for Self-Supporting Products, Wiley, 1994

[18] Laurel and Mountford, The Art of Human-Computer Interface Design. Addison-Wesley, 1990

[19] Van Der Veer and Mulder, Human-Computer Interaction. Springer-Verlag, 1988

Òåñòèðîâàíèå íà ïðàêòè÷íîñòü

[20] Dumas J. S. and Redish J. C. A Practical Guide to Usability Testing, Ablex Publishing, 1993

[21] Nielson J. Usability Engineering, AP Professional, 1993

Òåìàòè÷åñêèé óêàçàòåëü

àâòîðñêèå ïðàâà

    â ïëàíå äîêóìåíòèðîâàíèÿ                                                8.1.3.1g

    â îáðàçöå ïëàíà                                                                   Ñ.7

    îáÿçàííîñòè çàêàç÷èêà                                                        8.1

    ïðè îöåíêå ïëàíà äîêóìåíòèðîâàíèÿ                               ïðèëîæåíèå G

    ôîðìóëèðîâêà                                                                      8.2.3.5b

àêòèâíûé ðàçäåëèòåëü, îïðåäåëåíèå                                    4.54

àëôàâèòíûé ïîðÿäîê â óêàçàòåëå                                           Í.3.3

àëüáîìíàÿ (ãîðèçîíòàëüíàÿ) îðèåíòàöèÿ                             8.2.3.1.2, 8.2.3.11.4

àíàëèç òðåáîâàíèé                                                                  8.1.3

Àóäèòîðèÿ

    äîñòóï                                                                                  8.1.2d

    èçó÷åíèå                                                                              4.4, Â.1

    îáðàçåö ïëàíà                                                                      Ñ.4

    îïèñàíèå                                                                            8.1.3.1,8.1.3.2, ïðèëîæåíèå G

    îïðåäåëåíèå                                                                        4.3

áèáëèîãðàôèÿ                                                                          áèáëèîãðàôèÿ

    îïèñàíèå äëÿ ïåðåâîäà                                                      ïðèëîæåíèå Å

áóìàãà                                                                                       8.2.3.1.8

    ðàçìåð (ôîðìàò)                                                                   8.2.3.1.1

áóìàæíàÿ äîêóìåíòàöèÿ                                                         8.2.3

    îïðåäåëåíèå                                                                        4.34

ââîäíûé ìàòåðèàë

    îïðåäåëåíèå                                                                        4.21

    ñïåöèôèêàöèÿ                                                                     8.2.3.5

âåðõíèé êîëîíòèòóë                                                               4.22

âçàèìîäåéñòâèå ìåæäó çàêàç÷èêîì è äîêóìåíòàòîðîì       8.1.4.1

âîïðîñû çàêîííîñòè                                                               8.1.4.1

Âðåìÿ

    íåîáõîäèìîå                                                                        8.1.3.1

    îöåíêà                                                                                  ïðèëîæåíèå F

âñïîìîãàòåëüíûé ìàòåðèàë

    îïðåäåëåíèå                                                                        4.6

    ñïåöèôèêàöèÿ                                                                     8.2.3.5

âûðàâíèâàíèå òåêñòà

    â áóìàæíîé äîêóìåíòàöèè                                                8.2.3.6.4

    â äèàëîãîâîé äîêóìåíòàöèè                                              8.2.4.3.6

ãðàììàòèêà                                                                               8.2.2.3

Ãðàíêè

    îïðåäåëåíèå                                                                        4.40

    êîëè÷åñòâî êîïèé                                                               B.1b

    ïðîâåðêà                                                                              8.1.4.5

ãðàôè÷åñêèå ýëåìåíòû

    â äèàëîãîâîé äîêóìåíòàöèè                                              8.2.4.3.7

    âåðõíèå è íèæíèå êîëîíòèòóëû                                       8.2.3.8

    çàãîëîâêè                                                                             8.2.3.7

    íåîáõîäèìîå âðåìÿ äëÿ ðàçðàáîòêè                                  F.2

    îïèñàíèå äëÿ ïåðåâîäà                                                      Å.4

    óâåäîìëåíèÿ è ïðåäîñòåðåæåíèÿ                                      8.2.3.14

äàòà ïåðåñìîòðà                                                                      4.8

äàòû (ïðè ïåðåâîäå)                                                               Å.6h

äâóñòîðîííÿÿ ïå÷àòü                                                               8.2.3.1.3

    âåðõíèå è íèæíèå êîëîíòèòóëû                                       8.2.3.8

äèàëîãîâàÿ äîêóìåíòàöèÿ                                                      8.2.4.2

    â ïëàíå äîêóìåíòèðîâàíèÿ                                                8.1.3.1

    îïèñàíèå äëÿ ïåðåâîäà                                                      Å.5

    îïðåäåëåíèå                                                                        4.31

äëèíà ñòðîêè                                                                           8.2.3.6.3

Äîãîâîð

    èñïîëüçîâàíèå íàñòîÿùåãî ñòàíäàðòà                              ïðèëîæåíèå Â

    îáðàçåö ðàçäåëà äîãîâîðà, ñîîòâåòñòâóþùèé ñòàíäàðòó  Â.3

    ñîáñòâåííèê àâòîðñêèõ ïðàâ                                             8.1.3.1g

äîêóìåíò ñ çàìåíåííûìè ñòðàíèöàìè

    òàáëèöà äåéñòâóþùèõ ñòðàíèö                                         8.1.7.2ñ

äîêóìåíòàòîð                                                                           4.14

äîêóìåíòàöèÿ                                                                          4.11

äîñòóï ê àíàëèòèêàì                                                               8.1.2ñ

äîñòóï ê îôîðìëåíèþ ýêðàíîâ                                              8.1.2à

äîñòóï ê ïðîãðàììèñòàì                                                        8.1.2ñ

äîñòóï ê òåõíè÷åñêèì òðåáîâàíèÿì (óñëîâèÿì)                   8.1.2

äîñòóï ê ôîðìàòàì çàïèñåé                                                    8.1.2à

æàðãîííûå âûðàæåíèÿ                                                           Å.6f

çàâåðøåíèå ðàçðàáîòêè ïëàíà äîêóìåíòèðîâàíèÿ               8.1.3.2

Çàãîëîâêè

    â áóìàæíîé äîêóìåíòàöèè                                                8.2.3.7

    â äèàëîãîâîé äîêóìåíòàöèè                                              8.2.4.3.5

    â óêàçàòåëå                                                                           Í.3.3, ïðèìå÷àíèå 1

    îïðåäåëåíèå                                                                        4.23

Çàêàç÷èê

    îïðåäåëåíèå                                                                        4.2

    òðåáîâàíèÿ                                                                          8.1.3.1

çàùèòà (äîêóìåíòàöèè)                                                           8.1.4.1

çàùèòà, ïðåäóñìîòðåííàÿ äîãîâîðîì                                    8.1.2, Â.1

èçìåíåííûé äîêóìåíò (èçìåíåíèå äîêóìåíòà)                    4.28

èíòåðâàëû ïî âåðòèêàëè                                                        8.2.3.6.3

èíòåðôåéñ ïîëüçîâàòåëÿ                                                         4.51

èíôîðìàöèÿ äëÿ àäìèíèñòðàòîðà â äèàëîãîâûõ

ñïðàâî÷íûõ ñèñòåìàõ                                                             8.2.4

èíôîðìàöèÿ î òîðãîâîé ìàðêå                                               8.2.3.5b

èðîíè÷åñêèå âûðàæåíèÿ                                                        Å.6å

èñïîëüçîâàíèå âåðõíèõ êîëîíòèòóëîâ                                 8.2.3.8

èñïîëüçîâàíèå êëàâèàòóðû â äèàëîãîâîé

äîêóìåíòàöèè è ñïðàâêàõ                                                       8.2.4.3.8

èñïîëüçîâàíèå êîíöåâûõ ïðèìå÷àíèé                                 8.2.3.3

èñïîëüçîâàíèå íèæíèõ êîëîíòèòóëîâ                                  8.2.3.8

èñïîëüçîâàíèå ñíîñîê                                                            8.2.3.3

èñïîëüçîâàíèå ñòðàíèö-ðàñêëàäîê                                       8.2.3.11.4

èñïîëüçîâàíèå ÿçûêà                                                              8.2.2.1

êàëåíäàðíûé ïëàí (ãðàôèê)                                                   8.1.3.1s

    â îáðàçöå ïëàíà                                                                   Ñ.14

êíèæíàÿ (âåðòèêàëüíàÿ) îðèåíòàöèÿ                                    8.2.3.1.2

êîëîíêè                                                                                    8.2.3.6.2

êîìàíäíûå ñïðàâêè â äèàëîãîâîé ñïðàâî÷íîé ñèñòåìå     8.2.4.2

êîìïàêòíîñòü áóìàæíîé äîêóìåíòàöèè                               8.2.3.1.1å

êîíòåêñòíàÿ ñïðàâêà (äèàëîãîâàÿ)                                         8.2.4.1à

êîíòðîëü

    â îáðàçöå ïëàíà                                                                   Ñ.9

    ïëàíà äîêóìåíòèðîâàíèÿ                                                   8.1.3.3

    ïëàíèðîâàíèÿ                                                                     8.1.3.1

êîíòðîëü èçìåíåíèé                                                               8.1.7

    äîãîâîðà                                                                               ïðèëîæåíèå Â

    â ïëàíå äîêóìåíòèðîâàíèÿ                                                8.1.3.3

    íå ñâÿçàííûõ ñ îáëàñòüþ äåéñòâèÿ äîãîâîðà                   8.1.4.1, ïðèìå÷àíèå 2

    îöåíêà âðåìåííûõ çàòðàò                                                   F.3.6

    ïëàíà                                                                                    8.1.3.1q

êîíòðîëüíûå òî÷êè (ýòàïû)                                                   8.1.3.1s

êîíôèäåíöèàëüíîñòü, ïðåäóñìîòðåííàÿ äîãîâîðîì            8.1.2

êîíöåâûå ïðèìå÷àíèÿ                                                            4.17

êîïèðîâàíèå ïëàíà äîêóìåíòèðîâàíèÿ                                8.1.3.3

êðàòêèå ñïðàâî÷íûå êàðòû                                                     8.1.3.1

êðàÿ è íóìåðàöèÿ ñòðàíèö                                                     8.2.3.1, 8.2.3.2

êóëüòóðíûå îñîáåííîñòè (ïðè ïåðåâîäå)                             Å.6

ìàòåìàòè÷åñêèå ñèìâîëû                                                       Å.3.1

ìåòîä íèñõîäÿùåãî ïðîåêòèðîâàíèÿ ïðè îöåíêå                F.3

Íàâèãàöèÿ

    â äèàëîãîâîé äîêóìåíòàöèè è ñïðàâî÷íûõ òåêñòàõ        8.2.4.3.7

    îïðåäåëåíèå                                                                        4.30

íàäïèñè                                                                                    8.2.3.9

íèæíèé êîëîíòèòóë                                                                4.19

íîìåíêëàòóðà ïîñòàâêè

    â îáðàçöå ïëàíà                                                                   Ñ.6

    îïðåäåëåíèå                                                                        4.9

íîòàöèÿ ìåòðè÷åñêèõ âåëè÷èí äëÿ ïåðåâîäà                       E.6j

îáëàñòü ïðèìåíåíèÿ

    â îáðàçöå ïëàíà                                                                   Ñ.2

    äîêóìåíòàöèè                                                                      8.1.3.1à

    íàñòîÿùåãî ñòàíäàðòà                                                         1

îáîçíà÷åíèÿ

    â óêàçàòåëå                                                                           Í.3

    îïèñàíèå äëÿ ïåðåâîäà                                                      Å.2

    ïåðå÷åíü                                                                              8.2.3.5

îáðàçåö

    äîãîâîðà                                                                               ïðèëîæåíèå Â

    îôîðìëåíèÿ                                                                         ïðèëîæåíèå Í

    ïëàíà äîêóìåíòèðîâàíèÿ                                                   ïðèëîæåíèå Ñ

îáÿçàííîñòè ïðîâåðÿþùåé ñòîðîíû (ýêñïåðòà)                   8.1.4.1

îãðàíè÷åíèÿ äîêóìåíòàöèè                                                   8.1.4.1

îäíîñòîðîííÿÿ ïå÷àòü                                                            8.2.3.1.3

îïðåäåëåíèÿ                                                                            4

îðèãèíàë-ìàêåòû                                                                    8.2

    îïðåäåëåíèå                                                                        4.29

îðèåíòàöèÿ

    ðèñóíêîâ                                                                              8.2.3.13.2

    ñòðàíèö                                                                                8.2.3.1.2

îðôîãðàôèÿ

    â ðåäàêöèè (ïðîåêòå) äîêóìåíòàöèè                                 8.1.4.3

    ïðàâèëà                                                                                8.2.12

îòñòóïû ïî ãîðèçîíòàëè                                                         8.2.3.6.3

îòñòóïû, èíòåðâàëû, ïðîáåëû

    â äèàëîãîâîé äîêóìåíòàöèè                                              8.2.4.3.4

    â òåêñòå îñíîâíîé ÷àñòè                                                    8.2.3.6

    äëÿ ïåðåâîäà                                                                        Å.4

îò÷åòû                                                                                      8.2.3.11

îôîðìëåíèå

    áóìàæíîé äîêóìåíòàöèè                                                   8.2.3.1

    âûäàâàåìûõ ìàòåðèàëîâ                                                    8.1.2

    äèàëîãîâîé äîêóìåíòàöèè                                                 8.2.4.3.4

    îáðàçåö                                                                                 ïðèëîæåíèå Í

    îáðàçåö ïëàíà                                                                      ïðèëîæåíèå Ñ

    ïî íàñòîÿùåìó ñòàíäàðòó                                                   Â.2

    ïðèíÿòûõ ðåøåíèé                                                             8.1.3.1

    ðàñïå÷àòîê ýêðàíîâ                                                             8.2.3.12.2

    ðåäàêöèé (ïðîåêòîâ) äîêóìåíòàöèè                                  8.1.4.3, 8.1.4.4

    òàáëèö                                                                                  8.2.3.10.1

    òåêñòà îñíîâíîé ÷àñòè äîêóìåíòà                                     8.2.3.6

îöåíêà ïëàíà äîêóìåíòèðîâàíèÿ                                          ïðèëîæåíèå G

îöåíêà (ïðîåêòà)                                                                      ïðèëîæåíèå F

ïàãèíàöèÿ                                                                                8.2.3.4

ïàññèâíûé ðàçäåëèòåëü                                                          4.55

ïåðåâîä

    â îáðàçöå ïëàíà                                                                   Ñ.8

    â ïëàíå äîêóìåíòèðîâàíèÿ                                                8.1.3.1h

    ïðàâèëà                                                                                ïðèëîæåíèå Å

ïåðåêðåñòíûå ññûëêè (â óêàçàòåëå)                                       Í.3.5

ïåðåïëåò

    ãðàôèê ïåðåïëåòåíèÿ                                                          8.1.3.1s5

    ìåòîä                                                                                    8.2.3.1.11

ïåðèîä ïëàíèðîâàíèÿ                                                            F.3.3

ïåðñîíàë ðàçðàáîò÷èêîâ äîêóìåíòàöèè                               4.12

ïå÷àòü

    êàëåíäàðíîå ïëàíèðîâàíèå                                               8.1.3.1s

    ìåòîä è êà÷åñòâî                                                                 8.2.3.1.10

    ðàçðåøàþùàÿ ñïîñîáíîñòü                                                 8.2.3.1.4

ïèêòîãðàììû

    â âåðõíèõ è íèæíèõ êîëîíòèòóëàõ                                   8.2.3.8.3

    â çàãîëîâêàõ                                                                         8.2.3.7.4

ïëàí âûáîðà ãðóïïû ïðîåêòàíòîâ                                         4.47

ïëàí äîêóìåíòèðîâàíèÿ                                                         8.1.3

    êîíòðîëü                                                                              8.1.3.3

    îáðàçåö                                                                                 ïðèëîæåíèå Ñ

    îïðåäåëåíèå                                                                        4.13

    îöåíêà                                                                                  ïðèëîæåíèå G

    ïðîâåðêà                                                                              8.1.4.2

    ñïåöèàëüíûå ôóíêöèîíàëüíûå êëàâèøè                          8.2.4.3.8, ïðèìå÷àíèå 2

    óðîâåíü òåñòèðîâàíèÿ íà ïðàêòè÷íîñòü                           8.1.5.1

ïîäçàãîëîâêè (â óêàçàòåëå)                                                     Í.3.3, ïðèìå÷àíèå 3

ïîäñâåòêà â äèàëîãîâîé äîêóìåíòàöèè                                8.2.4.3.3

ïîëíîòà (äîêóìåíòàöèè)                                                        8.1.4.1

ïîëüçîâàòåëè

    îïðåäåëåíèå                                                                        4.52

    îïðåäåëåíèå àóäèòîðèè                                                     8.1.3.2

    ó÷àñòèå â òåñòèðîâàíèè íà ïðàêòè÷íîñòü                        8.1.5.4

ïîëÿ

    âíåøíèå                                                                               8.2.3.1.6

    âíóòðåííèå                                                                          8.2.3.1.5

ïîíÿòèéíàÿ ñïðàâêà (äèàëîãîâàÿ ñïðàâêà)                           8.2.4.1g

ïðàâèëà äëÿ ñòðîê                                                                   8.2.3.6.3

ïðàâèëà ïëîòíîñòè äîêóìåíòà                                               8.2.3.4

ïðàâèëüíîñòü                                                                           8.1.4.1

ïðàêòè÷åñêàÿ ëàáîðàòîðèÿ                                                     4.49

ïðàêòè÷åñêîå ïðèìåíåíèå íàñòîÿùåãî ñòàíäàðòà               ïðèëîæåíèå Â

ïðåäëîãà â óêàçàòåëå                                                               Í.3.3, ïðèìå÷àíèå 6

ïðåäîñòåðåæåíèÿ                                                                    8.2.3.14

ïðåäñòàâëåíèå èñõîäíûõ ìàòåðèàëîâ                                   8.1.2, 8.1

ïðèëîæåíèÿ

    ïðîåêò                                                                                  8.1.4.3

    ìåñòîïîëîæåíèå                                                                 8.2.3.5å

ïðèìåíåíèå êëàâèàòóðû äëÿ äèàëîãîâîé äîêóìåíòàöèè    8.2.4.1ñ

ïðèìåíåíèå ñòàíäàðòà                                                           1

ïðèìåðû

    îïèñàíèé äëÿ ïåðåâîäà                                                      ïðèëîæåíèå Å

ïðèíÿòàÿ ðåäàêöèÿ                                                                  F.3.6

ïðîâåðêà                                                                                   8.1.4

    íåîáõîäèìîå âðåìÿ                                                             ïðèëîæåíèå G

    îðèåíòèðîâî÷íîå âðåìÿ                                                     F.3.6

    ïîñëå ñîçäàíèÿ (äîêóìåíòàöèè)                                        8.1.3.1r

ïðîâåðêè äîêóìåíòàöèè ïîñëå åå ñîçäàíèÿ                         8.1.3.1.2r

ïðîâåðêè ïëàíà äîêóìåíòèðîâàíèÿ                                      8.1.4

ïðîâåðêà ðåäàêöèè (äîêóìåíòàöèè)

    âòîðîé                                                                                  8.1.4.4, F.3.5

    êàëåíäàðíûé ïëàí                                                              8.1.3.1s

    íåîáõîäèìîå âðåìÿ                                                             F.3.6, ïðèëîæåíèå G

    ïåðâîé                                                                                  8.1.4.3, F.3.4

    ÷èñëî ðåäàêöèè                                                                   B.1b

ïðîãðàììíûå ñðåäñòâà

    äîñòóï                                                                                  8.1.2

    èçìåíåíèÿ                                                                            8.1.7

    èñïîëüçîâàíèå ïðè òåñòèðîâàíèè íà

    ïðàêòè÷íîñòü                                                                       8.1.5.3

    îïèñàíèå äëÿ ïåðåâîäà                                                      Å.5

ïðîäóêöèÿ                                                                                4.38

ïðîåêòàíòû

    â îáðàçöå ïëàíà                                                                   Ñ.11

    âûáîð è ñòðóêòóðà                                                               4.47, 8.1.3.11

ïðîèçâîäñòâî

    â îáðàçöå ïëàíà                                                                   Ñ.10

    îïðåäåëåíèå                                                                        4.39

    ïðè îöåíêå ïëàíà äîêóìåíòèðîâàíèÿ                               ïðèëîæåíèå G

    ïðè ïîäãîòîâêå ïëàíà äîêóìåíòèðîâàíèÿ                       8.1.3.1.k

ïðîñòîíàðîäíûå âûðàæåíèÿ                                                 E.6f

ïðîòîòèï                                                                                  4.41

ïðîöåäóðû è êîíòðîëü ïåðåäà÷è                                           8.1.3.1j

ïðîöåäóðû ðåçåðâèðîâàíèÿ                                                   8.1.3.1j

ïðîöåäóðû, óêàçàííûå â ïëàíå                                              8.1.3.1j

ïóíêòóàöèÿ

    â ðåäàêöèè (ïðîåêòå) äîêóìåíòàöèè                                 8.1.4.3

    ïðè îïèñàíèè äëÿ ïåðåâîäà                                              Å.3.4

ðàáî÷åå ìåñòî äëÿ ðàáîòû ñ äîêóìåíòàöèåé                        8.2.3.1.1å

ðàáî÷åå íàèìåíîâàíèå                                                           8.1.3.1à

ðàçäåëèòåëü                                                                              8.2.3.4

    àêòèâíûé                                                                             4.54

    ïàññèâíûé                                                                           4.55

ðàçäåëèòåëè                                                                             8.2.3.1.9

ðàçìåòêà øðèôòîâ                                                                   8.1.4.1, ïðèìå÷àíèå 7

ðàçðåøàþùàÿ ñïîñîáíîñòü (ïå÷àòè)                                      8.2.3.1.4

ðàçðåøàþùàÿ ñïîñîáíîñòü ëàçåðíîé ïå÷àòè                        8.2.3.1.4

ðàçðåøàþùàÿ ñïîñîáíîñòü òèïîãðàôñêîé

ëàçåðíîé ïå÷àòè                                                                      8.2.3.1.4

ðàñïå÷àòêè ýêðàíà                                                                   8.2.3.12

    ãåíåðàöèÿ (ñîçäàíèå)                                                          8.1.4.1, ïðèìå÷àíèå 4

    îïðåäåëåíèå                                                                        4.43

    ðàçìåð (ôîðìàò) áóìàãè                                                      8.2.3.1.1

ðàñïðîñòðàíåíèå

    êàëåíäàðíîãî ïëàíèðîâàíèÿ                                             8.1.3.1

    ïëàíà äîêóìåíòèðîâàíèÿ                                                   8.1.3.3

ðàñøèðåííàÿ ñïðàâêà (äèàëîãîâàÿ)                                       8.2.4.1b

ðåäàêòèðîâàíèå ïðîåêòà äîêóìåíòàöèè                               8.1.4.3, ïðèìå÷àíèå 1

ðåêîìåíäàöèè ïî ñîîáùåíèþ â äèàëîãîâîé ñèñòåìå         8.2.4.2ñ

ðåñóðñû (â îáðàçöå ïëàíà)                                                      Ñ.12

ðåøåíèå âîïðîñîâ                                                                   8.1.2ñ

ðèñóíêè                                                                                    8.2.3.13

    â óêàçàòåëå                                                                           Í.3.1

    íóìåðàöèÿ                                                                            8.2.3.2.2

    îïèñàíèå äëÿ ïåðåâîäà                                                      Å.4

    ñïèñîê                                                                                  8.2.3.5d

ðóêîâîäñòâà ïîëüçîâàòåëÿ â äèàëîãîâîé äîêóìåíòàöèè     8.2.4.2à

ñâÿçàííàÿ èíôîðìàöèÿ â äèàëîãîâîé äîêóìåíòàöèè          8.2.4.3.7, ïðèìå÷àíèå 1

ñèìâîëû âàëþò                                                                       Å.3.1

ñèíòàêñèñ (äëÿ ïåðåâîäà)                                                       Å.3.3

ñèñòåìà                                                                                     4.44

ñèñòåìû ïîèñêà                                                                       8.1.3.1

ñëîâàðü (îðôîãðàôè÷åñêèé)                                                    8.2.2.2

ñëîâàðü

    â ðåäàêöèè äîêóìåíòàöèè                                                  8.1.4.3

    îïèñàíèå äëÿ ïåðåâîäà                                                      Å.2

    ðàñïîëîæåíèå â äîêóìåíòàöèè                                         8.2.3.5f

    òåðìèíîâ, èñïîëüçîâàííûõ â íàñòîÿùåì ñòàíäàðòå       4

ñíîñêà                                                                                       4.20

ñîäåðæàíèå

    â îáðàçöå ïëàíà                                                                   Ñ.5

    â ïëàíå äîêóìåíòèðîâàíèÿ                                                8.1.3.1å

    â ðåäàêöèè (ïðîåêòå) äîêóìåíòàöèè                                 8.1.4.3

    îïðåäåëåíèå                                                                        4.45

    îôîðìëåíèå                                                                         8.2.3.5

    ïðè îöåíêå ïëàíà äîêóìåíòèðîâàíèÿ                               ïðèëîæåíèå G

ñîêðàùåíèÿ

    â óêàçàòåëå                                                                           Í.3

    ïåðå÷åíü                                                                              8.2.3.5

    îïèñàíèå äëÿ ïåðåâîäà                                                      Å.2

ñîïðîâîæäåíèå äîêóìåíòàöèè                                              8.1.7

    ïëàí                                                                                      8.1.3.1q

ñîñòàâíûå âûðàæåíèÿ                                                            E.2g

ñïåöèàëüíûå ôóíêöèîíàëüíûå êëàâèøè                              8.2.4.3.8

ñïðàâî÷íûé ïåðå÷åíü                                                             áèáëèîãðàôèÿ

ñïðàâêà î ñîîáùåíèè (äèàëîãîâàÿ ñïðàâêà)                         8.2.4.1å

ñïðàâî÷íûå ññûëêè                                                                Í.3.4

    îïðåäåëåíèå                                                                        4.27

ñïðàâî÷íûé òåêñò                                                                   4.25

ñòàíäàðòû                                                                                8.2.1

    äîñòóï ê                                                                                8.1.2

    ïî óïðàâëåíèþ êà÷åñòâîì                                                 5

ñòèëü îïèñàíèÿ                                                                       8.2.2

    â îáðàçöå ïëàíà                                                                   Ñ.3

    ðóêîâîäñòâî                                                                         8.1.2

ñòîèìîñòü äîêóìåíòèðîâàíèÿ                                                8.1.3.1

ñòðàíèöû

    íîìåð                                                                                   8.1.3.1

    íóìåðàöèÿ                                                                            8.13.2

    îôîðìëåíèå                                                                         8.2.3

    îöåíêà êîëè÷åñòâà                                                              ïðèëîæåíèå F

ñòðàíèöà-ðàçâåðòêà                                                                 8.2.3.11.4

    îïðåäåëåíèå                                                                        4.48

ñòðàíèöà-ðàñêëàäêà                                                                4.18

ñóáïîäðÿä                                                                                 8.1.6

    â ïëàíå äîêóìåíòèðîâàíèÿ                                                8.1.3.1, ïðèìå÷àíèå 2

ñõåìû íóìåðàöèè                                                                    8.2.3.2

    â óêàçàòåëå                                                                           Í.3.4

òàáëèöû                                                                                   8.2.3.10

    íóìåðàöèÿ                                                                            8.2.3.2.2

    ñïèñîê                                                                                  8.2.3.5d

òàáëèöà äåéñòâóþùèõ ñòðàíèö                                             8.1.7.2ñ

    îïðåäåëåíèå                                                                        4.46

òåêñò

    äèàëîãîâîé äîêóìåíòàöèè                                                 8.2.4.3.4

    çàãîëîâêè                                                                             8.2.3.7

    íåîáõîäèìîå âðåìÿ äëÿ ðàçðàáîòêè                                  ïðèëîæåíèå F

    îôîðìëåíèå                                                                         8.2.3.6

    óâåäîìëåíèÿ è ïðåäîñòåðåæåíèÿ                                      8.2.3.14

    öâåòà                                                                                    8.2.3.1.7

òåêñò îñíîâíîé ÷àñòè

    áóìàæíîé äîêóìåíòàöèè                                                   8.2.3.6

    äèàëîãîâîé äîêóìåíòàöèè                                                 8.2.4.3.6

òåðìèíîëîãè÷åñêàÿ ñïðàâêà (äèàëîãîâàÿ ñïðàâêà)              8.2.4.1f

òåðìèíîëîãèÿ

    îïèñàíèå äëÿ ïåðåâîäà                                                      Å.2

    îïðåäåëåíèÿ                                                                        4

òåñòèðîâàíèå íà ïðàêòè÷íîñòü                                              8.1.5

    âçàèìîñâÿçü ñ ïîëüçîâàòåëÿìè                                          8.1.2

    â îáðàçöå ïëàíà                                                                   Ñ.13

    êàëåíäàðíûé ïëàí                                                              8.1.3.1s 3

    îïðåäåëåíèå                                                                        4.50

òèïîâûå ïîëüçîâàòåëè                                                           8.1.5.4

    äîñòóï ê                                                                                8.1.2

òèïû ñïðàâî÷íûõ òåêñòîâ (èíôîðìàöèè)                             8.2.4.1

òèòóëüíûé ëèñò                                                                       8.2.3.5à

óâåäîìëåíèÿ                                                                            8.2.3.14

óêàçàòåëü                                                                                  Í.3

    â ïåðâîé ðåäàêöèè (äîêóìåíòàöèè)                                  8.1.4.3

óïðàâëåíèå êà÷åñòâîì                                                            5

    ïðè ïëàíèðîâàíèè                                                             8.1.3.1

    ñâÿçàííîå ñ âçàèìîäåéñòâèåì ñóáúåêòîâ                         8.1.4.1

ôîðìàòû áóìàãè À4 è À5                                                        4.1, 8.2.3

ôîðìàò áóìàãè Â5                                                                    4.5, 8.2.3

ôîðìóëèðîâêà ãàðàíòèé                                                         8.2.3.5b

ôîðìóëèðîâêà êîìïåíñàöèé                                                  8.2.3.5b

ôîòîêîïèðîâàíèå                                                                    8.2.3.1.1d

ôîòîøàáëîíû

    ãðàôèê èçãîòîâëåíèÿ                                                          8.1.3.1s4

    îïðåäåëåíèå                                                                        4.7

    îöåíêà                                                                                  F.3.6

ôóíêöèîíàëüíûå êëàâèøè (äèàëîãîâàÿ äîêóìåíòàöèÿ)      8.2.4.3.8

öâåò

    áóìàãè                                                                                  8.2.3.1.8

    â äèàëîãîâîé äîêóìåíòàöèè                                              8.2.4.3.3

    êðàñîê                                                                                   8.2.3.1.7

øðèôò (ãàðíèòóðà, êåãëü è ðàñïîëîæåíèå)

    â âåðõíèõ è íèæíèõ êîëîíòèòóëàõ                                   8.2.3.8

    â äèàëîãîâîé äîêóìåíòàöèè                                              8.2.4.3.4

    â çàãîëîâêàõ                                                                         8.2.3.7

    â íàäïèñÿõ                                                                           8.2.3.9

    â îñíîâíîé ÷àñòè äîêóìåíòà                                             8.2.3.6

    â îò÷åòàõ                                                                              8.2.3.11

    â òàáëèöàõ                                                                           8.2.3.10

    â óâåäîìëåíèÿõ è ïðåäîñòåðåæåíèÿõ                               8.2.3.14

    êîìïîíîâêà                                                                          8.2.3.6 - 8.2.3.8

ýëåêòðîííàÿ êîïèÿ                                                                  4.15

ýëåìåíò äîêóìåíòàöèè                                                           4.26

þìîðèñòè÷åñêèå âûðàæåíèÿ                                                 E.6d

Êëþ÷åâûå ñëîâà: îáðàáîòêà äàííûõ, âû÷èñëèòåëüíûå ìàøèíû, ïðîãðàììíûå ñðåäñòâà âû÷èñëèòåëüíûõ ìàøèí, äîêóìåíòèðîâàíèå, äîêóìåíòàöèÿ ïîëüçîâàòåëÿ



óðîêè ïî àëãîòðåéäèíãó íà Python ñ íóëÿ



ßíäåêñ öèòèðîâàíèÿ

   Copyright © 2008-2024 ,  www.infosait.ru

backtrader - óðîêè àëãîòðåéäèíãà íà python