Информационная технология. Процесс создания документации пользователя программного средства - [10]

Шрифт
Интервал

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) — информация о текущем поле, в котором находится курсор или высвечена программа, включая ее необходимое или целевое (предметное) содержание, ее назначение и потенциальное влияние на работу программного средства;


Еще от автора ГОСТ
Пакеты программ. Требования к качеству и тестирование

Настоящий стандарт содержит полный аутентичный текст международного стандарта ИСО/МЭК 12119-94 «Информационная технология. Пакеты программ. Требования к качеству и тестирование»ГОСУДАРСТВЕННЫЙ СТАНДАРТ РОССИЙСКОЙ ФЕДЕРАЦИИГОСТ Р ИСО/МЭК 12119-2000Information technology. Software packages. Quality requirements and testing.


Система технической документации на АСУ. Общие требования к выполнению текстовых документов

В книге рассказывается история главного героя, который сталкивается с различными проблемами и препятствиями на протяжении всего своего путешествия. По пути он встречает множество второстепенных персонажей, которые играют важные роли в истории. Благодаря опыту главного героя книга исследует такие темы, как любовь, потеря, надежда и стойкость. По мере того, как главный герой преодолевает свои трудности, он усваивает ценные уроки жизни и растет как личность.


Процессы жизненного цикла программных средств

В книге рассказывается история главного героя, который сталкивается с различными проблемами и препятствиями на протяжении всего своего путешествия. По пути он встречает множество второстепенных персонажей, которые играют важные роли в истории. Благодаря опыту главного героя книга исследует такие темы, как любовь, потеря, надежда и стойкость. По мере того, как главный герой преодолевает свои трудности, он усваивает ценные уроки жизни и растет как личность.


Общие требования к компетентности испытательных и калибровочных лабораторий

Настоящий стандарт представляет собой полный аутентичный текст международного стандарта ИСО/МЭК 17025-99 «Общие требования к компетентности испытательных и калибровочных лабораторий»Настоящий стандарт является результатом большого опыта внедрения Руководства ИСО/МЭК 25 и ЕН 45001, взамен которых он теперь действует. В нем содержатся все требования, которым испытательные и калибровочные лаборатории должны соответствовать, если они намерены показать, что у них действует система качества, что они технически компетентны и способны получать технически обоснованные результаты.Органам по аккредитации, признающим компетентность испытательных и калибровочных лабораторий, следует основывать свою деятельность на настоящем стандарте.


Комплекс стандартов на автоматизированные системы. Автоматизированные системы. Стадии создания

В книге рассказывается история главного героя, который сталкивается с различными проблемами и препятствиями на протяжении всего своего путешествия. По пути он встречает множество второстепенных персонажей, которые играют важные роли в истории. Благодаря опыту главного героя книга исследует такие темы, как любовь, потеря, надежда и стойкость. По мере того, как главный герой преодолевает свои трудности, он усваивает ценные уроки жизни и растет как личность.


Программное обеспечение встроенных систем. Общие требования к разработке и документированию

Embedded system software. General requirements for development and documentationСтандарт подготовлен в развитие ГОСТ Р ИСО/МЭК 12207-99 «Информационная технология. Процессы жизненного цикла программных средств» с целью учета специфики разработки и документирования программного обеспечения встроенных систем реального времени.


Рекомендуем почитать
Глубоководные аппараты (вехи глубоководной тематики)

Вниманию читателей предлагается книга, посвященная созданию первого поколения отечественных обитаемых подводных аппаратов, предназначенных для работы на глубинах более 1000 м История подводного флота, несмотря на вал публикации последнего времени, остается мало известной не только широкой общественности, но и людям, всю жизнь проработавшим в отрасли Между тем. сложность задач, стоящих перед участниками работ по «глубоководной тематике» – так это называлось в Министерстве судостроительной промышленности – можно сравнить только с теми, что пришлось решать создателям космических кораблей Но если фамилии Королева и Гагарина известны всему миру, го о главном конструкторе глубоководной техники Юрии Константиновиче Сапожкове или первом капитане-глубоководнике Михаиле Николаевиче Диомидове читатель впервые узнает из этой книги.


Материалы для ювелирных изделий

Рассмотрены основные металлические материалы, которые применяются в ювелирной технике, их структура и свойства. Подробно изложены литейные свойства сплавов и приведены особенности плавки драгоценных металлов и сплавов. Описаны драгоценные, полудрагоценные и поделочные камни, используемые в ювелирном деле. Приведены примеры уникальных ювелирных изделий, изготовленных мастерами XVI—XVII веков и изделия современных российских мастеров.Книга будет полезна преподавателям, бакалаврам, магистрам и аспирантам, а так же учащимся колледжей и читателям, которые желают выбрать материал для изготовления ювелирных изделий в небольших частных мастерских.Рекомендовано Министерством образования и науки Российской Федерации в качестве учебника для бакалавров, магистров по специальности 26140002 «Технология художественной обработки материалов» и аспирантов специальности 170006 «Техническая эстетика и дизайн».


Грузовые автомобили. Охрана труда

Автомобиль – это источник повышенной опасности, поэтому управлять им могут только люди, прошедшие специальное обучение, имеющие медицинскую справку, стажировку.Книга посвящена вопросу охраны труда. В ней подробно изложены общие положения, которыми должны руководствоваться наниматели, внеплановые и текущие инструктажи для водителей, а также другие немаловажные моменты, обеспечивающие безопасность водителя.Отдельно рассмотрены дорожно-транспортные происшествия и их причины, исходные данные для проведения автотранспортной экспертизы, модели поведения в случаях попадания в ДТП, приближения к месту аварии, а также общий порядок оказания помощи и порядок оформления несчастных случаев.Кроме того, в книге можно найти информацию по правилам перевозки негабаритных и опасных грузов, а также системе информации об опасности (СИО).



Столярные и плотничные работы

Умение работать с благородным материалом – деревом – всегда высоко ценилось в России. Но приобретение умений и навыков мастера плотничных и столярных работ невозможно без правильного подхода к выбору материалов, инструментов, организации рабочего места, изучения технологических тонкостей, составляющих процесс обработки древесины. Эта книга покажет возможности использования этих навыков как в процессе строительства деревянного дома, так и при изготовлении мебели своими руками, поможет достичь определенных высот в этом увлекательном и полезном процессе.


Технический регламент о требованиях пожарной безопасности. Федеральный закон № 123-ФЗ от 22 июля 2008 г.

Настоящий Федеральный закон принимается в целях защиты жизни, здоровья, имущества граждан и юридических лиц, государственного и муниципального имущества от пожаров, определяет основные положения технического регулирования в области пожарной безопасности и устанавливает общие требования пожарной безопасности к объектам защиты (продукции), в том числе к зданиям, сооружениям и строениям, промышленным объектам, пожарно-технической продукции и продукции общего назначения. Федеральные законы о технических регламентах, содержащие требования пожарной безопасности к конкретной продукции, не действуют в части, устанавливающей более низкие, чем установленные настоящим Федеральным законом, требования пожарной безопасности.Положения настоящего Федерального закона об обеспечении пожарной безопасности объектов защиты обязательны для исполнения: при проектировании, строительстве, капитальном ремонте, реконструкции, техническом перевооружении, изменении функционального назначения, техническом обслуживании, эксплуатации и утилизации объектов защиты; разработке, принятии, применении и исполнении федеральных законов о технических регламентах, содержащих требования пожарной безопасности, а также нормативных документов по пожарной безопасности; разработке технической документации на объекты защиты.Со дня вступления в силу настоящего Федерального закона до дня вступления в силу соответствующих технических регламентов требования к объектам защиты (продукции), процессам производства, эксплуатации, хранения, транспортирования, реализации и утилизации (вывода из эксплуатации), установленные нормативными правовыми актами Российской Федерации и нормативными документами федеральных органов исполнительной власти, подлежат обязательному исполнению в части, не противоречащей требованиям настоящего Федерального закона.


Информационная технология. Оценка программной продукции характеристики качества и руководства по их применению

Стандарт подготовлен на основе применения аутентичного текста международного стандарта ИСО/МЭК 9126-91 «Информационная технология. Оценка программной продукции. Характеристики качества и руководства по их применению»Information technology. Software product evaluation. Quality characteristics and guidelines for their use.


Информационная технология. Программные конструктивы и условные обозначения для их представления

Настоящий стандарт содержит полный аутентичный текст международного стандарта ИСО/МЭК 8631-89 «Информационная технология. Программные конструктивы и условные обозначения для их представления».