60000

WWW.STANDARTOV.RU

, , . .
- .



/ 15910-2002



1. - ()

2. 25 2002 . 249-

3. / 15910-99 .

4.

:

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

: , , , ,


Яндекс цитирования

   Copyright © 2008-2024,  www.standartov.ru