УДК 004

ПРИМЕНЕНИЕ СТАНДАРТОВ В ПРОЦЕССЕ «СОЗДАНИЕ ТЕХНИЧЕСКОЙ ДОКУМЕНТАЦИИ ПРОГРАММНОГО ПРОДУКТА»

Новикова Татьяна Борисовна1, Вахрушев Владислав Игоревич1, Темникова А.1
1Магнитогорский государственный технический университет им. Г.И. Носова

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

Ключевые слова: стандартизация программного обеспечения, техническая документация программных продуктов


THE USE OF STANDARDS IN THE PROCESS OF «CREATING A SOFTWARE PRODUCT TECHNICAL DOCUMENTATION»

Novikova Tat'yana Borisovna1, Vakhrushev Vladislav Igorevich1, Temnikova A.1
1Nosov Magnitogorsk State Technical University

Abstract
This article describes the relevance of standardization software, as well as the features of the application of standards for the creation of technical documentation software.

Библиографическая ссылка на статью:
Новикова Т.Б., Вахрушев В.И., Темникова А. Применение стандартов в процессе «Создание технической документации программного продукта» // Современная техника и технологии. 2016. № 11. Ч. 2 [Электронный ресурс]. URL: http://technology.snauka.ru/2016/11/11402 (дата обращения: 04.10.2017).

Стандартизация ПО на сегодняшний день занимает достаточно значимую роль в жизненном цикле любого предприятия. Соответственно, знание ГОСТов и правильное их применение позволяет использовать бизнес-процессы на предприятии в полную силу, т.к.. стандартизация направлена на достижение упорядочения в определенной области посредством установления положений для всеобщего и многократного применения в отношении реально существующих и потенциальных задач [1, 2, 3]. Эта деятельность проявляется в разработке, опубликовании применении стандартов. Т.о. современный бизнес невозможен без знаний и навыков стандартизации в сфере ИКТ.

Рассмотрим применение стандартов на примере описания процесса «создание технической документации программного продукта» с указанием всех ГОСТов, применяемых в данной предметной области (рис.1).

Вводная часть

Предприятие с условным названием «ПРОГРАММиК» занимается созданием и сопровождением программных продуктов для коммерческого использования. К основным бизнес-процессам (БП) предприятия относятся [4, 5, 6]:

  • Анализ и согласование требований заказчика
  • Формирование и согласование технического задания (ТЗ) на выполнение разработки
  • Заключение договора на выполнение разработки
  • Выполнение разработки (проектирование и программирование)
  • Оценка качества выполнения разработки (тестирование)
  • Создание сопроводительной документации (документирование)
  • Внедрение разработки
  • Сопровождение разработки (исправления, доработка, консультирование по работе и т.д.)

Детально рассмотрим БП «Создание сопроводительной документации (документирование)». Процесс заключается в создании техническим писателем документа (документов), описывающих разработку для возможности работы с ней определенных категорий клиентов-потребителей:

  • системных администраторов (документы «Руководство администратора», «Руководство системного администратора», «Руководство по установке»)
  • программистов (документы «Руководство программиста», «Структура базы данных», «Application Programming Interface», «Функциональная спецификация»)
  • пользователей (документ «Руководство пользователя»)

Этапы создания документации:

  1. Постановка задачи.
  2. Получение входных данных.
  3. Документирование.
  4. Рецензирование документации.
  5. Проверка документации.

1. На этапе постановки задачи разработчик/менеджер проекта составляет запрос на проведение работ в системе ведения проектов JIRA (регулируется внутренним регламентом компании) на выполнение документирования техническим писателем. В заявке содержится минимальная информация по проделываемой работе: срок, приоритет, тип запроса (новый компонент, задача, подзадача, исправление) и краткое описание.

2. На этапе получения входных данных технический писатель запрашивает (самостоятельно находит) входные данные, необходимые для решения запроса. Иногда необходимые данные указывают непосредственно в запросе, тогда данный этап пропускается. В качестве входных данных могут выступать [7, 8, 9]:

  • текст программы (регулируется стандартом ГОСТ 19.401-78 «Единая система программной документации. Текст программы. Требования к содержанию и оформлению»)
  • техническое задание (регулируется стандартом ГОСТ 19.201-78 “Единая система программной документации. Техническое задание. Требования к содержанию и оформлению”)
  • техническая или функциональная спецификация (регулируется стандартом ГОСТ 19.202-78 «Единая система программной документации. Спецификация. Требования к содержанию и оформлению»)

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

3. На этапе описания разработки (документирования)  выполняется переработка входной информации и создается описание на техническом языке, доступном для понимания конечного пользователя. Технический писатель при создании описания руководствуется следующими нормативными документами:

  • ГОСТ Р ИСО/МЭК 15910-2002 «Информационная технология. Процесс создания документации пользователя программного средства» (для документа «Руководство пользователя»)
  • ГОСТ 19.202-78 «Единая система программной документации. Спецификация. Требования к содержанию и оформлению» (для документа «Функциональная спецификация»)
  • ГОСТ 19.504-79 «ГОСТ 19.202-78 «Единая система программной документации. Руководство программиста. Требования к содержанию и оформлению» (для документа «Руководство программиста»)
  • ГОСТ 19.603-78 «Единая система программной документации. Общие правила внесения изменений» (для внесения изменений в существующую документацию)
  • ГОСТ Р ИСО 9127-94 «Системы обработки информации. Документация пользователя и информация на упаковке для потребительских программных пакетов» (для документа «Руководство по установке»)
  • ГОСТ 18421-93 «Аналоговая и аналогово-цифровая вычислительная техника. Термины и определения» (для обеспечения единообразия используемой в документации терминологии)

Также для описания разработки используются внутренние стандарты, разработанные компанией (регламент описания документов «Структура базы данных», «Application Programming Interface» и т.д.).

4. На этапе рецензирования документации выполняется проверка текста документации и внесение соответствующих корректировок. Разделяют внутреннее (со стороны коллеги – технического писателя) и внешнее (со стороны разработчика) рецензирование. Процесс рецензирования регулируется внутренними регламентами отдела технической документации и взаимодействия между отделами.

5. На этапе проверки качества и соответствия технической документации руководителем отдела документации (старшим техническим писателем) выполняется проверка выполненной работы. Основным документом, регламентирующим деятельность руководителя отдела технической документации, является стандарт ГОСТ Р ИСО/МЭК ТО 9294-93 «Информационная технология. Руководство по управлению документированием программного обеспечения».


Библиографический список
  1. Назарова О.Б. Реализация принципа преемственности в построении учебных курсов специальности прикладная информатика (в экономике) на основе case-технологий // Фундаментальные исследования. 2007. № 6. С. 46.
  2. Назарова О.Б. Преемственность в обеспечении компьютерной подготовки учащихся начальной и средней школы : диссертация на соискание ученой степени кандидата педагогических наук / Магнитогорск, 1999
  3. Назарова О.Б., Давлеткиреева Л.З. Интеграция автоматизированных информационных систем в сфере продаж холдинговой компании :
    В сборнике: Актуальные вопросы научной и научно-педагогической деятельности молодых учёных Сборник научных трудов всероссийской заочной научно-практической конференции. Под общей редакцией Е.С. Ефремовой. 2015. С. 86-96.
  4. Масленникова О.Е. Типовой проект внедрения корпоративной информационной системы на крупное промышленное предприятие //  Актуальные проблемы современной науки, техники и образования. 2015. Т. 2. № 1. С. 149-152.
  5. Масленникова О.Е. Анализ современного состояния исследований по проблеме разработки региональной модели индивидуальной траектории профессионального развития бакалавров и магистров // Современные информационные технологии и ИТ-образование. 2014. № 10. С. 639-650.
  6. Савва Л.И., Масленникова О.Е., Пономарёв Т.А. Познание человеком человека. -  Магнитогорск, 2002.
  7. Давлеткиреева Л.З., Чусавитина Г.Н. Анализ и установление уровня зрелости информационной инфраструктуры организации для управления непрерывностью бизнеса : В сборнике: Современные информационные технологии и ИТ-образование Сборник избранных трудов VII Международной научно-практической конференции. Под редакцией профессора В.А. Сухомлина. 2012. С. 529-544.
  8. Чусавитина Г.Н., Масленникова О.Е., Давлеткиреева Л.З. Подготовка будущих ит-специалистов в области обеспечения интероперабельности электронной науки и образования : В сборнике: Разработка инновационных механизмов повышения конкурентоспособности выпускников ИТ-специальностей вуза в условиях моно промышленного города Магнитогорск, 2012. С. 132-140.
  9. Давлеткиреева Л.З. Информационно-предметная среда как средство профессиональной подготовки будущих специалистов в университете :
    диссертация на соискание ученой степени кандидата педагогических наук / Магнитогорск, 2006


Все статьи автора «Вахрушев Владислав Игоревич»


© Если вы обнаружили нарушение авторских или смежных прав, пожалуйста, незамедлительно сообщите нам об этом по электронной почте или через форму обратной связи.

Связь с автором (комментарии/рецензии к статье)

Оставить комментарий

Вы должны авторизоваться, чтобы оставить комментарий.

Если Вы еще не зарегистрированы на сайте, то Вам необходимо зарегистрироваться: