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

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

Таблица 1 — Угол обзора и число точек

Угол обзора, угловые минутыВысота, ммПриблизительное число точек
102,912
154,418
205,824
257,330
308,836
3510,242
4011,648
4513,154
5014,660 17

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.18.1.3 План документирования
6.1.2.18.2 Содержание спецификации стиля
6.1.2.28.1.2 Представление исходных материалов
6.1.2.38.1.4 Проверка (анализ)
6.1.3.18.2 Содержание спецификации стиля. 8.1.3 План документирования
6.1.3.28.1.3.3 Проверка плана документирования
6.1.4.18.1.7 Контроль изменений и сопровождение документации

ПРИЛОЖЕНИЕ В (справочное)

Использование настоящего стандарта в договоре

B.1 Общие положения

В настоящем стандарте имеются разделы, требования которых необходимо пояснить применительно к конкретному договору или другим ссылочным документам (например, международным). В свою очередь, план документирования также нуждается в пояснении. В договоре должны быть даны ответы на следующие вопросы:

a) откуда поступает информация о изучении аудитории? (Ответ рекомендуемый);

b) необходимо ли готовить более двух проектов комплекта документации и одного комплекта гранок?

(При необходимости, в настоящем стандарте по умолчанию предусмотрены два проекта комплектов документации и один комплект гранок);

c) кто представляет исходные материалы? (Обычно это очевидно, но для проектов со сложными взаимосвязями между вовлеченными сторонами нуждается в уточнении);

d) какие уровни конфиденциальности или секретности необходимо использовать для материалов, предоставляемых заказчиком документатору?

e) имеется ли стандарт на оформление бумажной документации? (Это не обязательно; по умолчанию может быть использована спецификация стиля документации, установленная в настоящем стандарте; затем в плане документирования может быть оговорено количество проектов документации и т. д.).

B.2 Образец раздела договора

В соответствии с настоящим стандартом образец раздела договора может быть представлен в следующем виде.

Пример

Раздел 123 Документация

Вся документация пользователя должна соответствовать ГОСТ Р ИСО/МЭК 15910.


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

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

В.З Практическое применение настоящего стандарта


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

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