ГОССТАНДАРТ РОССИИ - Информационная технология ПРОЦЕСС СОЗДАНИЯ ДОКУМЕНТАЦИИ ПОЛЬЗОВАТЕЛЯ ПРОГРАММНОГО СРЕДСТВА

Примечания

1 Обычно пользователям удобнее пользоваться ссылками на страницы, чем на разделы документа.

2 Для элементов указателя не следует использовать большие перечни локальных ссылок. Максимально удобными для работы являются пять ссылок (например, 1, 33, 43, 99, 102). Во избежание длинных перечней локальных ссылок следует использовать подзаголовки.

3 Ссылки, подлежащие обсуждению, могут быть выделены шрифтом (гарнитурой, кеглем).

4 Если перечень подзаголовков охватывает несколько колонок (столбцов), вверху каждой колонки должно быть указано наименование основного заголовка со словом «продолжение».

5 Если используют особую последовательность нумерации страниц, она должна быть указана в указателе. Например, если нумерация начинается с номера каждой главы, данный номер должен быть указан в локальной ссылке, то есть «2-22, 3-34».

6 Если элемент указателя используют в нескольких частях документа, нумеруемых последовательно, в локальной ссылке должны быть указаны только первые и последние номера, разделенные тире (например, 3 — 11). Когда тире используют в нумерации страниц, для разделения страниц тире не используется (например, 3–6 до 3–8).

В перекрестных ссылках на сокращения, синонимы или альтернативные виды термина, выбранные из элементов указателя, следует использовать сокращение «См.» (например, проект — см. оформление).

Примечание- Дополнительно перекрестная ссылка с сокращением «См.» может быть дана на другие элементы документа. За перекрестной ссылкой не следует использовать локальную ссылку.

Перекрестная ссылка со словами «См. также» может быть дана из более обширного термина на менее исчерпывающие термины, если не используется прямая локальная ссылка.

Примечание — Перекрестные ссылки со словами «См. также» следует использовать для взаимоувязки терминов в интересах пользователя. Перекрестная ссылка со словами «См. также» под основным элементом указателя должна объединять ряд связанных элементов указателя, имеющих справочные ссылки. Например Рисунки 4

см. также графические элементы; распечатки экранов

индексирование 12

список 15

нумерация 2 Слова «См.» и «См. также» обычно выделяют курсивом.

В нижеперечисленных публикациях содержится более подробная информация по некоторым темам, связанным с настоящим стандартом.

[1] ИСО/МЭК 6592–2000[3] Информационная технология. Руководство по документированию прикладных автоматизированных систем

[2] BS 7649-93 Руководство по проектированию и выпуску документации пользователей прикладных программных средств

[3] Barnum C. M. and Capliner S. Techniques for Technical Communicators, MacMillan, 1993

[4] Brockmann R. J. Writing Better Computer User Documentation, Wiley, 1990

[5] Brusaw C. T., Alred G. J. and Oliu W. E. Handbook of Technical Writing, St. Martin's 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. МсGraw-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] Bogan S., Farkas D. and Wellinske J. Developing On-Line Help for Windows, International Thomson Press, 1995

[14] Brown C. M. 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,

[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. С 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

    количество копий… В.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

даты (при переводе)… E.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а

жаргонные выражения… E.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