Документацию на программное обеспечение (ПО) разрабатывают, опираясь на те или иные стандарты. В нашей стране чаще всего используют ГОСТ или ГОСТ Р. Стандарты регламентируют не только оформление и содержание документов, но и процессы разработки, сопровождения, изготовления и эксплуатации ПО.
Как правило, документацию на ПО и на автоматизированные системы разрабатывают в соответствии с единой системой программной документации (ЕСПД) и комплексом стандартов на автоматизированные системы (КСАС). Помимо них есть ГОСТ Р, ГОСТ Р ИСО и ГОСТ Р ИСО/МЭК — они являются адаптацией международных стандартов и действуют только на территории РФ. К ним прибегают, когда нужно охватить те процессы создания ПО, которые не конкретизированы в стандартах ГОСТ и ГОСТ Р в составе ЕСПД и КСАС. Взятые за основу международные стандарты были приняты международной организацией по стандартизации (ИСО) и международной электротехнической комиссией (МЭК). Этот вид стандартов предлагает свои модели организации процессов разработки ПО.
Рассмотрим некоторые из стандартов, которые могут помочь в разработке ПО и составлении документации.
ГОСТ Р ИСО/МЭК 90003—2014. Разработка программных продуктов. Руководящие указания по применению ИСО 9001:2008 при разработке программных продуктов.
Что регламентирует:
- применение стандарта ИСО 9001:2008 при разработке, заказе, поставке, эксплуатации и сопровождении программных продуктов;
- требования к разработке, документированию, внедрению и поддержке системы менеджмента качества и документации к этой системе.
Чем помогает в разработке документации на ПО:
- вводит требования к руководству по системе менеджмента качества документации;
- вводит итерации на этапах утверждения и распространения документации, которые способствуют повышению ее качества.
ГОСТ Р ИСО/МЭК 12207—2010. Информационная технология. Системная и программная инженерия. Процессы жизненного цикла программных средств.
Что регламентирует:
- общую структуру процессов жизненного цикла программных средств;
- понятия, применяемые в проектировании программных средств и построение моделей их жизненного цикла.
Чем помогает в разработке документации на ПО:
- определяет цели процессов жизненного цикла программных средств, на которые можно опираться при разработке программных документов;
- содержит детальное описание целей и задач каждого процесса жизненного цикла и учитывает процессы, связанные с менеджментом инфраструктуры и людских ресурсов.
ГОСТ Р ИСО/МЭК ТО 9294—93. Информационная технология. Руководство по управлению документированием программного обеспечения.
Что регламентирует:
функции программной документации, определение стандартов и руководств по документированию.
Чем помогает в разработке документации на ПО:
содержит основные элементы управления документированием, которые обеспечивают дисциплину и качество подготавливаемой документации. Определение стандартов и руководств по документированию из пункта 7 послужит ориентиром при построении процессов документирования ПО с нуля или усовершенствовании уже существующих процессов.
ГОСТ Р ИСО/МЭК 25001—2017. Информационные технологии. Системная и программная инженерия. Требования и оценка качества систем и программного обеспечения (SQuaRE). Планирование и управление.
Что регламентирует:
- требования к планированию и управлению оценкой качества ПО;
- ответственность сторон на этапах оценки качества ПО.
Чем помогает в разработке документации на ПО:
- содержит требования и рекомендованные действия на уровне организации процесса оценки качества систем и на уровне управления проектом;
- содержит рекомендации по анализу результатов оценки качества ПО — их можно включить в техническое задание. Это поможет выстроить процессы оценки качества и определить ответственность сторон.
ГОСТ Р ИСО/МЭК 25010—2015. Информационные технологии. Системная и программная инженерия. Требования и оценка качества систем и программного обеспечения (SQuaRE). Модели качества систем и программных продуктов.
Что регламентирует:
- характеристики и подхарактеристики моделей качества продукта и моделей качества при использовании;
- ответственность сторон на этапах оценки качества ПО.
Чем помогает в разработке документации на ПО:
- вводит модели качества продукта и модели качества при использовании, а также связанные с ними термины;
- предлагает примеры требований пользователей для качества продукта и качества при использовании — на них можно опираться при составлении технического задания и документов о проведении испытаний;
- предлагает подробные примеры использования модели качества для измерений и отображения функциональной надежности в приложениях.
ГОСТ Р ИСО/МЭК 20741—2019. Системная и программная инженерия. Руководство для оценки и выбора инструментальных средств программной инженерии.
Что регламентирует:
- процессы оценки и выбора инструментальных средств;
- указания по определению требований к инструментальным средствам;
- указания по определению общих характеристик качества.
Чем помогает в разработке документации на ПО:
- предлагает алгоритм выбора инструментальных средств, который можно применить для анализа рынка программных решений и составления требований к продукту;
- предлагает алгоритм выбора инструментальных средств для процессов документирования ПО;
- приводит список характеристик функциональности инструментальных средств, на который можно опираться при составлении требований к программному продукту и технического задания.
ГОСТ Р 51904—2002. Программное обеспечение встроенных систем. Общие требования к разработке и документированию.
Что регламентирует:
- стратегии архитектурного проектирования системы;
- общие требования для анализа системных требований, в том числе:
- информация о потребностях пользователя;
- эксплуатационная концепция;
- требования к системе;
- анализ требований к системе при верификации ПО.
Чем помогает в разработке документации на ПО:
- вводит определения основных терминов, связанных с разработкой, тестированием и передачей ПО (например, «отказоустойчивость» и «процедура тестирования»). Основные термины можно использовать в документации на ПО, если нужно конкретизировать определение, которого нет в ЕСПД и КСАС;
- определяет и задает классификацию отказных ситуаций;
- расписывает этапы планирования среды жизненного цикла ПО, что послужит опорой при разработке программных документов.
ГОСТ Р ИСО/МЭК 15910—2002. Информационная технология. Процесс создания документации пользователя программного средства.
Что регламентирует:
- минимально необходимый процесс создания документации пользователя для программного средства;
- определения документации и структурных элементов документов.
Чем помогает в разработке документации на ПО:
- предлагает комплексный план разработки документации без отрыва от процесса создания ПО — можно применять совместно с уже упомянутым ГОСТ Р ИСО/МЭК 12207—2010;
- описывает отдельные процессы документирования и ответственность сторон — их можно использовать при планировании процессов разработки документации и при составлении программных документов.
ГОСТ Р ИСО 9241—161—2016. Эргономика взаимодействия человек-система. Часть 161. Элементы графического пользовательского интерфейса.
Что регламентирует:
- описание, условия и способы использования основных графических элементов интерфейса;
- требования к использованию устройств ввода при взаимодействии с интерфейсом.
Чем помогает в разработке документации на ПО:
содержит определения терминов («область отображения», «диалог», «состояние» и другие), которые обозначают конкретные элементы графического пользовательского интерфейса. Применение этого стандарта исключает разночтение определений при описании элементов графического пользовательского интерфейса.
Мы привели лишь девять примеров ГОСТ Р, ГОСТ Р ИСО и ГОСТ Р ИСО/МЭК, которые помогают в тех или иных аспектах разработки ПО и документации для него.
Их применение не обязательно, однако они могут решить спорные вопросы и подсказать нужный алгоритм разработки ПО и документации для него.
Получить консультацию по документам
Оставьте заявку на обратный звонок или свяжитесь с нами:
Нажимая кнопку «Отправить», вы соглашаетесь с нашей Политикой конфиденциальности