Разрабатываем документацию на все виды автоматизированных систем (ГИС, АИС, АСУТП и пр.). Осуществляем полное ведение проекта и содействие при сдаче документов конечному заказчику.
Стоимость от 70000 рублей
Стоимость от 100000 рублей
Стоимость от 70000 рублей
Стоимость от 70000 рублей
Стоимость от 50000 рублей
Стоимость от 40000 рублей
СИЛЬНАЯ КОМАНДА ЭКСПЕРТОВ ПОД ВСЕ ВАШИ ЗАДАЧИ
ОПЫТ РАБОТЫ С ТЕХНИЧЕСКОЙ ДОКУМЕНТАЦИЕЙ С 2008 ГОДА
ПОЛНОЕ ПОГРУЖЕНИЕ В ВАШ ПРОЕКТ НА ВСЕХ ЭТАПАХ
Задача проекта: Заказчик одержал победу в тендере на создание масштабируемой автоматизированной информационной системы (АИС) для нужд крупного предприятия добывающей отрасли. До старта работ с компанией ВДОКЕ у исполнителя отсутствовал требуемый пакет проектной документации. По условиям контракта, сдача системы в промышленную эксплуатацию невозможна без полного комплекта документов, строго регламентированного стандартами серии ГОСТ 34.
Сложности и нюансы проекта: Специфика добывающей отрасли требует глубокого погружения в сложные бизнес-процессы предприятия. Главная сложность заключалась в необходимости увязать высокоуровневые требования исходного технического задания с реальной архитектурой создаваемой АИС. Требовалось с нуля разработать массив документов, обеспечив сквозную прослеживаемость проектных решений на стадиях «Технический проект» и «Рабочая документация», избежав при этом типичных логических разрывов между описанием информационного, программного и технического обеспечений.
Стало: Разработан исчерпывающий пакет проектно-эксплуатационной документации по ГОСТ 34 (включая ГОСТ 34.201-89). Все тома успешно прошли строгий нормоконтроль со стороны добывающего предприятия без единого существенного замечания. Идеально оформленная документация позволила Заказчику без задержек сдать этапы работ, закрыть тендерные обязательства и получить оплату.
Задача проекта: Заказчик столкнулся с проблемой потери экспертизы на фоне кадровой ротации: в продуктовой команде частично сменились разработчики, QA-инженеры и проектные менеджеры. До старта работ с компанией ВДОКЕ проектная и эксплуатационная документация на развивающийся продукт полностью отсутствовала. Требовалось оперативно формализовать знания о системе и описать ее архитектуру с использованием международного стандарта Arc42 для ускорения адаптации новых сотрудников.
Сложности и нюансы проекта: Главный вызов заключался в полном отсутствии исходных артефактов — знания об архитектуре существовали исключительно в исходном коде и «в головах» оставшихся специалистов (историческое наследие). Аналитикам ВДОКЕ потребовалось провести серию глубинных интервью с инженерами и выполнить реверс-инжиниринг текущего ИТ-решения. Информацию нужно было не просто собрать, но и грамотно распределить по 12 срезам шаблона Arc42 (от контекста системы и бизнес-целей до стратегии развертывания и архитектурных решений), чтобы сделать документацию одинаково понятной как разработчикам, так и бизнес-заказчикам.
Стало: Сформировано наглядное и структурированное описание архитектуры программного продукта по стандарту Arc42. Пакет документации обеспечил полную прозрачность устройства системы, сократил время онбординга новых специалистов (разработчиков и QA) в несколько раз и создал надежную базу знаний (Single Source of Truth) для безопасного планирования новых релизов и масштабирования архитектуры.
Стало: Документация приведена в полное соответствие с Постановлением Правительства РФ №1236. Продукт успешно включен в реестр, что позволило клиенту участвовать в программах импортозамещения.
Задача проекта: Заказчик разработал собственный программный продукт и инициировал процедуру получения сертификата соответствия ФСТЭК России. До обращения в компанию ВДОКЕ описание продукта базировалось исключительно на разрозненных внутренних комментариях разработчиков. Для прохождения сертификационных испытаний потребовался строгий пакет программной документации, оформленный по стандартам Единой системы программной документации (ГОСТ 19).
Сложности и нюансы проекта: Сертификация во ФСТЭК предъявляет бескомпромиссные требования к детализации описания архитектуры ПО, алгоритмов и среды функционирования. Основной нюанс заключался в необходимости «реверс-инжиниринга» документации: экспертам ВДОКЕ пришлось переводить сленг разработчиков в строгий академический формат ЕСПД. Требовалось филигранно составить спецификации, описание программы и руководства (системного программиста и оператора), не потеряв техническую суть, но вписав её в жесткие ГОСТовские рамки.
Стало: Сформирован безупречный комплект программной документации по ГОСТ 19, полностью удовлетворяющий регламентам испытательной лаборатории и экспертов ФСТЭК. Пакет документов прошел аудит с первого раза, что позволило Заказчику успешно получить сертификат соответствия на свой продукт и выйти на рынок государственных и корпоративных закупок с повышенными требованиями к ИБ.
Задача проекта: Заказчик реализует масштабный государственный контракт по развитию и модернизации крупной Государственной информационной системы (ГИС). До начала сотрудничества с ВДОКЕ проект находился под угрозой срыва из-за критически низкого качества исторической документации, разработанной на этапе создания ГИС: наблюдалась хаотичная структура, некорректное использование терминологии и множественные противоречия в описании подсистем.
Сложности и нюансы проекта: Рефакторинг низкокачественной документации зачастую сложнее написания с нуля. Специалистам пришлось провести глубокий аудит наследия предыдущих подрядчиков, выявить и устранить все концептуальные нестыковки в описании комплекса средств автоматизации системы (КСАС). Ключевым вызовом стала унификация терминологической базы по всем томам и приведение структуры в жесткое соответствие с актуальными требованиями регуляторов (включая методические рекомендации Минцифры и профильные ГОСТы) без остановки текущего процесса разработки Заказчика.
Стало: Полностью переработанный, структурно выверенный и логически непротиворечивый пакет документации на ГИС. Устранены все терминологические и архитектурные пробелы. Обновленная документация успешно прошла государственную экспертизу и приемку со стороны Госзаказчика, обеспечив легитимное развитие системы и заложив надежный фундамент для ее последующей аттестации.
Задача проекта: Заказчик выиграл целевой государственный грант на разработку инновационного программно-аппаратного комплекса (ПАК) в сфере защиты информации. В рамках реализации грантового соглашения до обращения во ВДОКЕ у компании возникла острая необходимость в создании строгой отчетной документации на программную часть комплекса в точном соответствии со стандартами ЕСПД (ГОСТ 19 серии).
Сложности и нюансы проекта: Работа с грантовым финансированием всегда сопряжена с жесточайшим контролем со стороны фондов и проверяющих органов. Основной нюанс заключался в том, что инновационный характер ПАК (сочетание специфического «железа» и софта для информационной безопасности) требовал ювелирного подхода к описанию алгоритмов и интерфейсов. Экспертам ВДОКЕ предстояло интегрировать современные подходы к разработке ИБ-решений в консервативную структуру ГОСТ 19, попутно выверив всю терминологию, касающуюся защиты информации, чтобы исключить малейшие поводы для замечаний при аудите.
Стало: Разработан безупречный комплект программной документации по ГОСТ 19 (включая спецификации, описания программы, руководства системного программиста и оператора). Документация прошла строгий аудит со стороны грантодателя без единого возврата на доработку. Заказчик успешно отчитался за этап проекта, подтвердил целевое использование средств и получил готовую базу для последующего внесения ПАК в профильные реестры Минцифры и Минпромторга.
Задача проекта: Заказчик предпринял две безуспешные попытки самостоятельной подачи заявки на включение собственного продукта (комплексной платформы мониторинга) в Единый реестр российских программ для ЭВМ и БД. До обращения в компанию ВДОКЕ процесс был полностью заблокирован из-за отказов экспертного совета Минцифры. Требовалось оперативно выявить критические ошибки в поданных материалах и привести документацию в идеальное соответствие с актуальными методическими рекомендациями регулятора.
Сложности и нюансы проекта: Процедура регистрации отечественного ПО требует предельно прозрачного описания архитектуры, технологического стека и отсутствия зависимости от зарубежных проприетарных компонентов. Основная сложность заключалась в том, что исходная документация Заказчика содержала «белые пятна» в описании процессов сборки и инструкциях по развертыванию. Экспертам ВДОКЕ пришлось провести глубокий аудит причин отказа, выполнить рефакторинг «Руководства администратора» и «Руководства пользователя», а также с нуля переписать «Описание процессов поддержания жизненного цикла ПО», грамотно обосновав используемые Open Source решения и подтвердив локализацию разработки.
Стало: Сформирован выверенный пакет эксплуатационной документации, закрывший все замечания регулятора. Заявка с обновленными документами без проблем прошла проверку экспертного совета. Платформа мониторинга официально включена в Реестр отечественного ПО, что позволило Заказчику получить законные налоговые преференции (нулевой НДС, снижение страховых взносов) и открыть доступ к участию в государственных закупках по программам импортозамещения.
Раньше пытались писать документы силами своих разработчиков, но это всегда затягивалось и страдало качество. Решили отдать задачу на аутсорс во ВДОКЕ и не прогадали. Коллеги подготовили для нас полный пакет, включая такую сложную вещь, как составленная в полном соответствии с ГОСТ эксплуатационная документация. Понравилось, что не было лишней бюрократии: скинули исходные данные, провели пару созвонов и получили готовый результат. Текст технически грамотный, структура четкая, оформление — комар носа не подточит. Сняли с нас огромную головную боль перед релизом, за что им большое спасибо
Хочу сказать огромное спасибо специалистам ВДОКЕ за то, что буквально спасли нас перед сдачей этапа! Ситуация была критическая: сроки горели, а руководство по эксплуатации ГОСТ было готово лишь наполовину и с кучей ошибок. Ребята подключились оперативно, быстро вникли в суть нашего продукта и привели всё в идеальный порядок. Очень приятно работать с людьми, которые не просто “оказывают услуги”, а реально болеют за результат и помогают закрыть проект. Документацию приняли без единого вопроса. Теперь за любыми инструкциями и описаниями — только к вам!
Как человек, работающий с гособоронзаказом, я очень требователен к оформлению бумаг. Часто подрядчики плавают в стандартах, но ВДОКЕ приятно удивили уровнем компетенции. Нам нужна была гост ескд спецификация и ряд сопроводительных документов. Специалисты компании продемонстрировали отличное знание нормативной базы. Всё выверено до запятой, рамки, шрифты, ссылки — всё строго по стандартам. Это тот редкий случай, когда нормоконтроль проходит гладко и без нервов. Уровень работы — высокий, сотрудничеством полностью удовлетворены.
Сотрудничаем с компанией ВДОКЕ уже не по первому проекту. В нашей сфере (ИТ-интеграция) качественная инструкция ГОСТ — это половина успеха при сдаче системы заказчику. Нравится, что коллеги работают автономно: они сами анализируют исходники, задают правильные вопросы и выдают готовый продукт, который не стыдно показать самым строгим аудиторам. За время совместной работы они подготовили для нас десятки документов разной сложности, и ни разу не подвели по срокам. Надежный бизнес-партнер в СПб, с которым комфортно работать вдолгую.
Обратились во ВДОКЕ по рекомендации партнеров, когда потребовалась разработка пакета документов “под ключ”. Задача была нетривиальной: система сложная, времени мало. В итоге документация ГОСТ 34 была разработана на высшем уровне. Особенно порадовало, что текст написан понятным языком, а не просто скопирован из шаблонов. Заказчик подписал акты приемки сразу же, отметив высокое качество описательной части. Считаю, что стоимость услуг полностью оправдана сэкономленным временем и нервами. Однозначно будем обращаться еще.
Хочу отметить выстроенный процесс работы в компании ВДОКЕ. Для нас разрабатывалась гост эксплуатационная документация на программно-аппаратный комплекс. Понравилась прозрачность: на каждом этапе мы понимали, что происходит, и видели промежуточные результаты. Менеджеры всегда на связи, технические писатели схватывают суть на лету. В итоге мы получили комплект, который полностью соответствует требованиям ТЗ и действующим стандартам. Если вы ищете профессионалов в разработке техдокументации, то этот выбор вас точно не разочарует.
Согласно ГОСТ Р 2.601-2019, разработка эксплуатационных документов — это обязанность разработчика изделия. Именно проектировщик обладает полными данными о конструкции и рисках. Однако на практике это часто делегируется профильным техписателям, чтобы текст был понятен пользователю, а не только инженерам. Важно: ответственность за полноту и достоверность данных всё равно несет организация-разработчик.
Да, это допустимая и часто удобная практика. ГОСТ 2.601-2019 позволяет объединять эксплуатационные документы. Для технически несложных изделий часто создается единый документ — Паспорт, объединенный с руководством по эксплуатации (ПС). В этом случае в него включают и технические характеристики (из паспорта), и правила использования, и сведения об утилизации.
Паспорт безопасности (SDS) обязателен для химической продукции: веществ, смесей, материалов, которые могут представлять опасность для здоровья или экологии. Это регламентируется ГОСТ 30333-2007 и ТР ТС. Если вы производите бытовую химию, лаки, краски или промышленные реагенты, без ПБ вы не сможете легально транспортировать товар или пройти таможню.
Комплект документов на автоматизированные системы определяется ГОСТ 34.201-2020. Перечень формируется на этапе разработки Технического задания (ТЗ). Обычно он включает: общесистемные документы (ведомость проекта), документацию по общему, техническому, информационному и программному обеспечению. Точный состав зависит от сложности системы и требований заказчика, зафиксированных в договоре.
Программа и методика испытаний (ПМИ) необходима компаниям, которые проводят приемо-сдаточные, предварительные или государственные испытания продукции. Согласно ГОСТ 19.301-79 (для ПО) или ГОСТ 2.106-2019 (для изделий), ПМИ — это документ, который официально подтверждает, что продукт соответствует ТЗ. Без ПМИ невозможно легально зафиксировать факт успешной проверки качества изделия.
Просто перевести недостаточно. Согласно Закону «О защите прав потребителей» (ст. 8 и 10), информация должна быть на русском языке. С точки зрения техрегулирования (например, ТР ТС 010/2011), инструкция должна соответствовать стандартам РФ/ЕАЭС по структуре и содержанию. Перевод часто требует адаптации терминов и добавления обязательных разделов о сертификации и утилизации.
Это комплекс документов (руководства пользователя, администратора, быстрый старт), объясняющих работу с ПО. Согласно ГОСТ 19.101-77, она входит в состав программной документации. Обязательна ли она? Для коммерческого успеха — да. Для включения в Реестр отечественного ПО — критически обязательна. Без внятных инструкций ваш продукт не пройдет формальную проверку Минцифры.
Выбор зависит от региона и условий контракта. Если проект для Европы — ориентируемся на стандарты ISO/IEC и директивы CE. Для США — IEEE или ASME. В авиации или медицине действуют свои специфические нормы (например, S1000D). Если проект затрагивает РФ, документация должна быть как минимум двуязычной и соответствовать ГОСТам, если это бюджетный или критически важный сектор.
Зависит от типа продукта. Для бытовой техники бумажная краткая инструкция обязательна по закону. Для промышленного оборудования по ГОСТ 2.610-2006 допускаются электронные документы. Современный тренд — интерактивная документация (HTML/онлайн), так как её легче обновлять. Однако PDF остается «золотым стандартом» для юридически значимых версий и печати по требованию.
Если объем изменений превышает 30-40%, выгоднее писать «с нуля». Доработка старого документа часто ведет к логическим ошибкам и «эффекту лоскутного одеяла». Новая инструкция позволит внедрить современную структуру и актуальный стиль изложения. Если же изменения точечные (обновились только скриншоты или характеристики), достаточно актуализировать текущую версию.
Стандарты многое регламентируют, но не все. И ввиду этого, в документах часто появляется множество элементарных ошибок, которые делают документ некачественным. А чтобы сделать качественно оформление документации по стандартам, надо про них знать и проверять документы при разработке. В этой статье приведены самые распространенные ошибки в документах.1. ОБЩИЕ ПОЛОЖЕНИЯ Чтобы документ получился качественным, важно продумать и…
Техническое задание на создание (развитие) автоматизированной системыТехническое задание на создание (развитие) автоматизированной системы разрабатывается по ГОСТ 34.602 Виды, комплектность и обозначение документов при создании автоматизированных систем. До 31.12.2021 действовал ГОСТ 34.602-89, а с 01.01.2022 вступил в силу новый ГОСТ 34.602-2020. Оба стандарта регламентируют общую структуру документа, состав разделов и основные требования к содержанию этих разделов.…
Разработчики документации регулярно сталкиваются с такими вопросами: Какой тип списка выбрать? Сколько уровней вложенности может быть у списков в документации? Как маркировать или нумеровать уровни многоуровневых списков? 1. Ключевые моменты В качестве основных целей составления технического документа можно выделить: Список – это не совсем верный термин. Правильный термин: перечисление. Перечисление – это структурный элемент документа.…
В статье рассматриваются следующие основные вопросы: Каких целей достигает хорошо написанный документ? Что позволяет считать документ хорошим? Как составить хороший документ? Каких целей достигает хорошо написанный документ? В качестве основных целей составления технического документа можно выделить: Обучение конечных пользователей и сотрудников продукту компании. Формирование справочных материалов и баз знаний по продукту компании. Снижение нагрузки на…
В мире IT используются следующие термины: регистрация; идентификация; аутентификация; авторизация; вход в систему. Некоторые разработчики документации путают эти термины. Поэтому документация получается не очень высокого качества. Давайте выясним, чем отличаются эти термины. Регистрация Сначала выполняется регистрация – создание учетной записи пользователя. Пользователь открывает форму регистрации и заполняет данные о себе (в том числе логин и…
Часто случается, что представить информацию в документе эффективнее схемой, чем текстом. Схема хорошо подходит, когда нужно передать основную идею устройства, предмета или процесса без соблюдения масштаба. Информативность же схемы зависит от множества факторов. Главное Схема должна быть понятна без чтения сопроводительного текста. Схема или диаграмма должна отображать только одно и очень конкретное явление. Например: Не…