Лекция 7. ГОСТ 19 в современной разработке

• Лекция посвящена ГОСТам в технической документации.  

• Изначально планировалось обсудить ГОСТ 19 и ГОСТ 34, но материала оказалось много.  

• Костя Валеев, руководитель отдела аналитиков и технических писателей в Ростелекоме, будет докладчиком.  

• Костя рассказывает о своем опыте работы с ГОСТами.  

• Сначала ГОСТы казались странными и неудобными, но со временем он понял их смысл.  

• Сегодняшняя лекция будет посвящена ГОСТ 19.  

• ГОСТ 19 устарел, но его идеи были современными для своего времени.  

• Лекция будет фокусироваться на ГОСТ 19, обсуждая его стандарты и нюансы.  

• Если будет интерес, можно будет сделать отдельную лекцию по ГОСТ 34.  

• В трансляции участвуют 71 человек, из которых 15 отметили, что знакомы с ГОСТ 19.  

• Костя планирует обзорно обсудить ГОСТ 19, несмотря на его устаревание.  

• ГОСТ 19 касается программного обеспечения, а ГОСТ 34 — автоматизированных систем.  

• Автоматизированные системы включают софт, железо, персонал и информацию.  

• Важно понимать разницу между этими стандартами для правильного использования.  

• ГОСТ 19 охватывает множество стандартов, что делает его обширным.  

• В ГОСТ 19 много стандартов, которые охватывают различные предметные области.  

• Важно уточнять, какой конкретно стандарт использовать при подготовке документации.  

• ГОСТ 19 состоит из серии стандартов, каждый из которых охватывает определенные документы.  

• В ГОСТ 19 больше стандартов, чем в ГОСТ 34, но они менее глубокие.  

• При подготовке документации нужно выбирать конкретные стандарты для использования.  

• Стандарты ГОСТ 19 разбиты на тематические блоки.  

• В группе стандартов есть общие положения, глоссарий, основополагающие стандарты и другие.  

• Группировка стандартов вызывает вопросы и требует более привычного подхода.  

• Стандарты доступны в интернете, но сайт давно не обновляется.  

• Классификация стандартов включает группы, такие как СПД, которая касается программной документации.  

• Стандарт 19781 заменил предыдущий стандарт 19004, но не включил все термины.  

• Новый стандарт содержит термины, которые устарели и плохо переведены.  

• Термины часто не раскрывают себя и противоречат друг другу.  

• Стандарт не рекомендуется использовать, так как он вызывает больше вопросов, чем ответов.  

• Стандарты касаются написания и оформления документов любого типа.  

• Они определяют, как документы должны выглядеть, на какие разделы делиться и как их хранить.  

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

• Стандарт описывает виды программной документации, включая компоненты и комплексы.  

• Обязательные документы: спецификация и текст программы.  

• Остальные документы определяются в техническом задании.  

• Стандарт устарел и не рекомендуется к использованию.  

• Полезно указывать версию документа и софта в названии.  

• Рекомендуется избегать использования цифровых шифров в названиях документов.  

• Титульные листы лучше делать по своему усмотрению, а не по ГОСТу.  

• Рамки на документах не обязательны, если это не указано в контракте.  

• Документы должны иметь содержание, аннотацию и лист изменений.  

• Документ должен быть оформлен по ГОСТу, но это не всегда удобно.  

• Современные нормы типографики делают форматирование неудобным для чтения.  

• Лучше выработать свои внутренние правила оформления документов.  

• ГОСТ не определяет шрифты, можно использовать современные, такие как Петсанс.  

• Современные шрифты более удобны для чтения и эстетичны.  

• Документ устарел и не актуален для современных архивов.  

• Правила учета и хранения документов также устарели.  

• Изменения в документах должны быть согласованными и отслеживаемыми.  

• Об изменениях нужно оповещать всех участников.  

• Хранитель оригинала документа должен вносить изменения, остальные могут предлагать изменения.  

• Документ устарел, но идея регистрации изменений остается актуальной.  

• Современные системы контроля версий могут автоматически фиксировать изменения.  

• ГОСТ 19.207-2017 описывает процесс разработки, а не документы.  

• Можно адаптировать процесс под свои нужды, следуя ГОСТу.  

• Современные стандарты должны давать рекомендации и лучшие практики.  

• Стандарты 1934 года не дают информации о том, как зарабатывать на софте.  

• Подходы к разработке и методики сильно различаются.  

• Стандарты можно адаптировать под свои нужды.  

• Можно разбить процесс разработки на стадии и этапы.  

• Интерактивность возможна даже по устаревшим стандартам.  

• Исследование предваряет разработку софта.  

• ТЗ должно быть компетентно написано исполнителем.  

• ТЗ включает проектировочные решения и выбор технологий.  

• ТЭО формируется на этапе эскизного проекта.  

• Заказчик выбирает лучший эскизный проект на основе ТЭО.  

• Разработка программы включает написание рабочего проекта.  

• Техническое задание является сложным документом.  

• Стандарт 1934 года менее продуман, чем спецификация.  

• Нет стандарта на требования, но есть стандарт на софт-инженеринг.  

• Спецификация описывает состав программы и её хранение.  

• Программа может быть компонентом или частью комплекса.  

• Программное обеспечение включает программу и документацию к ней.  

• Программное изделие включает программу, документацию и носитель данных.  

• Спецификация помогает пронумеровать и описать составляющие изделия.  

• Тест-план полезен для выгрузки тест-кейсов и методов испытаний.  

• Исходные коды могут быть полезны для заказчиков, но не всегда необходимы.  

• Стандарт требует аннотации к каждому файлу с кодом, что может быть не поддержано разработчиками.  

• Пояснительная записка отражает техническое задание и пишется перед разработкой.  

• Описание программы пишется после разработки и фиксирует детали реализации.  

• Современные стандарты, такие как A-TRIP E830, предлагают более понятные и простые рекомендации.  

• Документ описывает, как документировать язык программирования.  

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

• Формулярка описывает изменения и характеристики работы программного продукта.  

• Описание применения помогает программистам интегрировать программу.  

• Руководство программистов-операторов дублируется и устарело, лучше использовать современные стандарты и рекомендации.  

• Обзор стандартов ГОСТ 34 и ГОСТ 19.  

• ГОСТ 34 охватывает всю предметную область разработки.  

• ГОСТ 19 ориентирован на современные стандарты.  

• Индустрия переходит от документарного подхода к созданию отдельных артефактов.  

• Если работаете по ГОСТу, важно прописывать структуру документов в ТЗ.  

• ГОСТ позволяет изменять структуру документов.  

• Используйте современную терминологию и осмысленные разделы в документах по ГОСТу.  

• ГОСТ не ограничивает использование нотаций и схем.  

• Не обязательно следовать устаревшим стандартам.  

• Возможность углубления в ГОСТ 34 или ГОСТ 19.  

• Вопросы можно задавать в телеграм-чате.  

• Обсуждение зарубежных стандартов будет в чате.  

• Призыв делиться впечатлениями и задавать вопросы в чате.  

• Возможность обсуждения ГОСТ 34 и сравнения с ГОСТ 19.  

• Формирование следующей лекции на основе отзывов.  

• Благодарность за внимание и участие.  

• Приглашение на следующую лекцию через неделю.  

• Прощание и пожелания всего доброго.