Принят и введен в действие
Постановлением Госстандарта РФ
от 25 июня 2002 г. N 249-ст
ГОСУДАРСТВЕННЫЙ СТАНДАРТ РОССИЙСКОЙ ФЕДЕРАЦИИ
ИНФОРМАЦИОННАЯ ТЕХНОЛОГИЯ
ПРОЦЕСС СОЗДАНИЯ ДОКУМЕНТАЦИИ
ПОЛЬЗОВАТЕЛЯ ПРОГРАММНОГО СРЕДСТВА
Information technology. Software user documentation process
ГОСТ Р ИСО/МЭК 15910-2002
Группа П85
ОКС 35.080;
ОКСТУ 5001
Дата введения
1 июля 2003 года
Предисловие
1. Разработан и внесен Всероссийским научно-исследовательским институтом стандартизации (ВНИИстандарт) Госстандарта России.
2. Принят и введен в действие Постановлением Госстандарта России от 25 июня 2002 г. N 249-ст.
3. Настоящий стандарт содержит полный аутентичный текст международного стандарта ИСО/МЭК 15910-99 "Информационная технология. Процесс создания документации пользователя программного средства".
4. Введен впервые.
Введение
Существующие стандарты можно отнести к двум основным типам:
а) стандарты на продукцию, определяющие ее характеристики и требования к ней;
б) стандарты на процессы, определяющие конкретные методы создания продукции.
Возрастающий масштаб применения программных средств и их сложность вызывает необходимость наличия полной, точной и понятной документации на эти средства, доступной пользователям. Настоящий стандарт определяет способ достижения данной цели, устанавливая работы (что должно быть сделано и исполнителя), связанные с качеством документации пользователя программных средств.
Документация часто рассматривает нечто, разрабатываемое после создания конкретного программного средства. Однако с точки зрения качества разработки программной документации она должна рассматриваться как неотъемлемая часть процесса создания данного программного средства. При надлежащем подходе к данной проблеме требуется достаточно сложная работа по планированию документирования. Целью настоящего стандарта является стимулирование разработчиков программных средств к надлежащему использованию процесса документирования. Стандарт также представляет пользователям метод определения надлежащего применения процесса документирования при создании конкретного программного средства.
Основной работой по настоящему стандарту является создание комплексного плана разработки документации, реализация которого обеспечивает лучшее документирование программного средства. Для соответствия настоящему стандарту данный план должен включать в себя требования (спецификацию) к стилю оформления документов. Настоящий стандарт не определяет состав данных требований (то есть компоновку конкретного документа или используемый шрифт), но устанавливает их диапазон. Стандарт также определяет виды информации, представляемой заказчиком разработчику документации (документатору) для проверяющих и распространяющих документацию.
Более подробная информация по данному вопросу приведена в библиографии.
Примечания. 1. Основной стандарт дополнен справочными приложениями, библиографией и тематическим указателем.
2. Исходный стандарт ИСО/МЭК 15910 разработан на основе австралийского стандарта AS 4258:1994.
3. Перечень дополнительных публикаций, связанных с тематикой настоящего стандарта, приведен в библиографии (см. [1] - [21]).
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) - штрих, имеющий такую же ширину, как и строчная буква "п".
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) - текст, облегчающий и убыстряющий пользователю, при эксплуатации программного средства, поиск содержащихся в
Для просмотра документа целиком скачайте его >>>
