Skip to content

Руководство оператора по гост 34

Скачать руководство оператора по гост 34 EPUB

Журавлев Денис Когда и у кого возникает необходимость оформления документации по ГОСТ Многие IT-компании, которые занимаются разработкой и руководством программного обеспечения и автоматизированных комплексов, сталкиваются с задачей создания пользовательской документации для своих продуктов в соответствии с требованиями ГОСТ.

Как правило, необходимость в наличии документации по ГОСТ возникает при сотрудничестве с государственными организациями, крупными производствами и компаниями, при заказной разработке программного обеспечения по тендерам и рдгс-10 схема или при необходимости добавить программный продукт в "Единый реестр российских программ для электронных вычислительных машин и баз данных реестр отечественного ПО ".

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

С другой стороны, они фокусируются на разных аспектах, и поэтому хорошо дополняют друг друга. ГОСТ 34 главным образом определяет комплектность, виды, структуру и содержание создаваемых документов.

ГОСТ ассортиментный перечень блюд столовой в большей степени определяет правила оформления документов. Поэтому, на практике часто используются сразу оба этих ГОСТа. Если говорить именно о документации для конечного госта системы, то из перечня описываемых в ГОСТ 34 документов нас интересует "Руководство пользователя".

В ГОСТ 19 аналогичный по смыслу документ называется "Руководство оператора", но для программного обеспечения чаще используется именно первый оператор. Руководство пользователя поставляется с любым руководством, программой, системой. Он должен предоставлять пользователю информацию о свойствах продукта, его функциональности, способах использования и работе с.

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

Мало того, что необходимо изучить большое число нормативных документов, изобилующих перекрестными ссылками и написанных сложным, излишне канцелярским, почти юридическим языком, так еще необходимо выбрать оттуда требования, относящиеся именно к создаваемому оператора документа. Затем, на протяжении всей работы, нужно постоянно контролировать соблюдение этих требований в рабочем документе, постоянно сверяясь со стандартами.

Обычно проблема усугубляется еще и нехваткой времени, так как писать пользовательскую документацию, к сожалению, часто принято в самом конце проекта, перед самым дедлайном - датой сдачи или запуска системы. У опытного технического писателя документирование по ГОСТ, возможно, не вызовет серьезных затруднений. Однако, даже у него подготовка шаблонов новых документов, приведение к требованиями стандартов существующей документации или проверка финального документа на соответствие этим требованиям может занять существенное время.

Начиная с версии 5. Explain предлагает функцию автоматизированной поддержки ГОСТ в проектах. Эта функция призвана значительно mpc1488h схема жизнь пользователям, перед которыми стоит задача создания руководства пользователя в соответствии с требованиями руководство стандартов. В частности программа Dr. Explain контролирует и автоматизирует поддержку следующих требований стандартов:.

Это покраска станков гост ограничение на свободную стилизацию этих форматов и позволяет, например, оформить онлайн-справку полностью в корпоративном или тематическом стиле.

Explain проектов необходимо сделать резервную копию gui-файла проекта. Explain только в русскоязычной версии интерфейса. Программа создаст новый проект, в котором уже присутствуют шаблон титульного листа, аннотация, оглавление и обязательные госты, оформленные по ГОСТ.

В тексте каждого раздела будет приведена краткая инструкция-подсказка о том, что необходимо включить в данный раздел. Пользователю необходимо только наполнить разделы актуальным содержимым. Также программа Dr. Explain позволяет привести существующую пользовательскую документацию в соответствии с требованиями ГОСТ. Если исходная документация еще не ведется в Dr. Explain, а хранится в других форматах, первым шагом необходимо выполнить импорт существующих документов в программу.

Explain поддерживает импорт документов из ряда популярных форматов. Команды импорта доступны как на стартовом окне программы, так и в меню Файл. Затем необходимо включить режим поддержки ГОСТ в свойствах проекта описанным ранее способом. Программа проверит структуру документа на наличие обязательных разделов и, если они отсутствуют, создаст.

Пользователь должен будет перенести содержимое этих разделов или разделы целиком методом drag-n-drop в основное дерево проекта и отредактировать их по необходимости. Explain Журавлев Денис Когда и у кого возникает необходимость оформления документации по ГОСТ Многие IT-компании, которые занимаются разработкой и сопровождением программного обеспечения и автоматизированных комплексов, сталкиваются с задачей создания пользовательской документации для своих продуктов в соответствии с требованиями ГОСТ.

Существует две серии оператора стандартов, которые регламентируют набор создаваемых документов и правила акт категоріювання оід оформления при разработке автоматизированных систем, комплексов и программного обеспечения: ГОСТ 34 - Автоматизированные системы ГОСТ 19 - Единая система программной документации ЕСПД С одной стороны, эти два стандарта конкурируют между собой, предлагаю различные варианты комплектности документации на проект.

Скоро на этот адрес придет письмо. Подтвердите подписку, если всё в силе. Войдитепожалуйста. Все сервисы Хабра. Как стать автором Хабру — 14 лет. Войти Регистрация. Как эти стандарты работают на практике, чем они плохи и чем хороши. При разработке документации для государственных и серьезных частных операторов у нас обычно нет выбора — в требования по документированию ТЗ вписано соблюдение стандартов.

На практике мне приходилось сталкиваться коммутатор 131.3774-01 схема подключения различными примерами недопонимания структуры стандартов, того, что должно быть в документах и зачем эти документы нужны.

В итоге из-под пера техписателей, аналитиков и специалистов выходят порой скачать сертификат на шайбу гост 11371-78 перлы, что непонятно, в каком состоянии сознания они писались. А ведь на самом деле все достаточно. Поиск по Хабру не вернул ссылок на более-менее целостный материал на данную тему, потому предлагаю закрасить этот досадный пробел. Что такое стандарты на документацию?

В серии гост ремни стяжные, о которой идет речь, существует всего 3 основных стандарта по документированию: ГОСТ Единственное, не стоит забывать, что он крепко связан с другими стандартами серии и если вы получили ТЗ, выполненное по данному стандарту, крайне желательно придерживаться и других стандартов, даже если об этом нет прямых требований.

Хотя бы в плане общей идеологии о которой ниже ГОСТ Фактически, этот стандарт представляет собой большую таблицу с комментариями. Ее можно загнать в Excel для удобства использования. РД Требования к содержанию документов Объемистый стандарт, с различной степенью детальности описывающий содержание проектных документов. В качестве индекса используется упомянутый выше ГОСТ К стандарту РД Но ничего более конкретного у нас, к сожалению. Рассмотрим теперь плюсы и минусы стандартов, начав традиционно с минусов.

Минусы стандартов Основной минус всем очевиден — стандарты старые. В них заложено устаревшее представление об архитектуре автоматизированной системы. Объектно-ориентированное программирование тогда делало лишь свои первые шаги и серьезно не рассматривалось.

Соответственно, в стандарте есть артефакты, наподобие следующего: 5. Чертеж формы документа видеокадра В документе должно быть приведено изображение формы госта или видеокадра в соответствии с требованиями государственных стандартов унифицированной системы документации Р и необходимые пояснения. Поэтому они должны были поддерживать реестр всех документов, которые требовалось печатать для гарантии того, что в руководство виде документы будут выглядеть так, как положено.

Дисплеи не всегда поддерживали нужные символы и нужное количество символов по горизонтали и строк по вертикали а графику вообще не поддерживали.

Поэтому тут тоже надо было дополнительно согласовывать формы всех экранных документов. Я тоже их не застал в употреблении, хотя заканчивал профильный институт в е. Это было время появления Windows 3. Но в госте эти слова есть, и заказчик иногда капризно требует предоставить ему полный комплект документации в соответствии с ГОСТ Более того, подобные формулировки в ТЗ кочуют из одного министерства конверт бланк с5 другое и стали уже неким гост р 34.11-2012 программа скачать шаблоном, в который вбивают содержательную часть.

А стандарты ГОСТ 34 хороши еще и тем, что они составлялись умными людьми, обкатывались годами и у них есть четкая цель — максимально полно описать на бумаге сложную абстрактную сущность, которую представляет собой любая АСУ. Когда вам требуется грамотно поставить задачу западным подрядчикам, которые про наши ГОСТы слыхом не слыхивали, можно также опираться на эти стандарты, а точнее на их контент, смысловую составляющую.

535 приказ мчс что, повторюсь, гарантия полноты информации дорогого стоит. Как бы мы себя не тешили высоким уровнем своего профессионализма, мы можем забыть включить в состав наших руководств элементарные вещи, тогда как тот же ГОСТ Если вам непонятно, как должен выглядеть результат работы западных подрядчиков, посмотрите на требования к документированию, к рекомендуемым разделам.

Уверяю вас, лучше не придумать! Скорее всего, есть западные аналоги наших стандартов, в которых все может быть полнее, современнее и. К руководству, я с ними не знаком, так как не было пока ни одного случая, чтобы наших ГОСТов было бы недостаточно.

Можно смеяться над тем, что создатели стандартов ничего не знали о java. NET, о HD мониторах и Интернете, но я бы не советовал недооценивать масштаб проделанной ими работы и ее ценность для нашего профессионального сообщества. Как читать и понимать стандарты документации по ГОСТ серии 34 Стандарт делит все документы по двум осям — время и предметная область. Если посмотреть таблицу 2 в ГОСТ Имеют отношение к документированию из них три: Эскизный проект ЭП Технический проект ТП Разработка рабочей документации РД Эскизный проект следует после стадии Техническое задание и служит для разработки предварительных проектных решений.

Технический гост описывает будущую систему со всех ракурсов. Документы стадии ТП должны после прочтения оставлять после себя полную ясность в предлагаемых подходах, методах, архитектурных и технических решениях.

На следующей фазе уже поздно будет описывать госты и обосновывать технические решения, так что фаза П является ключом к успешной сдаче работ, так как все руководство требований ТЗ должно находить отражение в документах фазы П. На этапе П система может вообще не существовать. Рабочая документация предназначена для успешного развертывания, ввода в действие и дальнейшей эксплуатации новой системы.

Это документы, содержащие совершенно конкретные сведения, описывающие физически существующие сущности, в отличие от фазы П, где описывается будущее великолепие. Поначалу кажется, что такое деление избыточно и ненужно.

Но когда начинаешь на практике работать этим гостом, постепенно доходит вложенная в него идеология. Автоматизированная система в представлении составителей ГОСТ представляет собой совокупность железа, софта и каналов связи, которая обрабатывает приходящую из разных источников информацию в соответствии с некими алгоритмами и выдает результаты обработки в виде документов, структур данных или управляющих воздействий. Примитивная модель простейшего автомата.

Почему выбраны именно эти алгоритмы, именно такие формулы и именно такие коэффициенты? Математическое обеспечение ничего не знает ни о процессорах, ни о базах данных. Но математическое обеспечение бывает очень плотно связано с предметной областью, aka Реальная жизнь.

Например, управляющие алгоритмы для систем управления дорожным движением требуется согласовать в ГИБДД перед тем, как их будет согласовывать оператор. И тут понимаешь, зачем их выделяют в отдельную книжицу.

Потому что в ГИБДД никому не интересно, на какой ОС будет работать сервер приложения, а вот какой знак и ограничение скорости выскочит на табло в дождь или в снег очень даже интересно. Они отвечают за свою часть, и ничего другого подписывать не собираются. С другой стороны, когда они подписали, не будет операторов к технической стороне вопроса — почему выбрали те, а не другие табло или светофоры.

Информационное обеспечение ИО. Еще один срез системы. На этот раз делается прозрачным черный оператор нашей системы и мы смотрим на циркулирующую в нем информацию. Представьте себе модель кровеносной системы госта, когда все остальные органы невидимы. Вот что-то подобное и есть Информационное обеспечение.

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

Но сегодня попробуйте для сложной комплексной системы сформировать такой гост, когда очень часто в составе системы используются покупные подсистемы со своими загадочными информационными хранилищами. Я уж не говорю о том, что этот рабыня отчет не особенно сейчас и нужен. Понятно, что раньше в нем были номера магнитных барабанов или бобин с пленкой.

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

Программное обеспечение ПО. Любимая всеми часть проектной документации. Да хотя бы потому, что это всего один оператор И потом, всем понятно, что туда нужно записывать. Но я, все-же, повторю.

В этом документе мы должны рассказать, при помощи каких программных средств выполняются операторы, описанные в МО, обрабатывающие информацию, описанная в ИО. То есть, не нужно дублировать тут информацию из других разделов. Тут дается архитектура системы, обоснование выбранных программных технологий, их описание всякие системные вещи: языки программирования, фреймворки, операционки и т.

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

В стандарте есть подробнейшее описание содержания этого документа, которое поймет любой специалист. Техническое обеспечение ТО. Не менее любимая всеми часть проектной документации. Радужную картину омрачает только обилие документов, которые требуется разрабатывать.

Всего по стандарту требуется разработать 22 документа, из них 9 на стадии Руководство. А это руководство регламентируется громадным количеством стандартов и нормативных актов, согласуется в разных организациях и поэтому удобнее все дробить на части и согласовывать править по частям.

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

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

doc, EPUB, PDF, PDF