Когда мы разрабатываем или модернизируем вашу систему, одной из ключевых задач становится её описание, то есть разработка документации. Документация делает систему понятнее, удобнее, прозрачнее. Так её проще передавать другим командам или онбордить в неё новых людей. Мы подготовим для вас всю требуемую документацию с учетом ваших бизнес-задач — по вашим шаблонам или по шаблонам ГОСТ, единичный документ или полный комплект.
Мы не готовим документацию на систему, которую не разрабатывали или не модернизировали.
Как мы составляем список нужных документов
Перед началом проекта мы обсуждаем с вами какие задачи должна решать документация и каким требованиям она должна отвечать. Мы согласовываем параметры будущего комплекта документации, например, какие документы включить, как их оформить, каким нормам, шаблонам и формулировкам следовать (ГОСТ или вашим), какие функции, модули или подсистемы отразить.
Какие документы мы готовим
- 01Техническое задание
Техническое задание (ТЗ) — базовый документ в комплекте. В нем помимо требований к системе, мы подробно описываем перечень документов и порядок их предоставления вам. В ТЗ мы в частности указываем графики работ, необходимые документы для закрытия каждой проектной задачи и всего проекта, требования к качеству оказания услуг.
- 02Описание, методика и протоколы испытаний
Мы готовим документы, подтверждающие, что разработанная или модернизированная нами система успешно прошла все испытания, предусмотренные в ТЗ. В перечень могут войти такие документы «Методика испытаний», «Протокол предварительных испытаний», «Протокол приемо-сдаточных испытаний».
- 03Проектная документация
Мы пишем проектную документацию — техпроект. В такой техпроект могут входить «Техническое описание», «Описание автоматизируемых функций», «Описание ПО», «Описание комплекса технических средств».
- 04Эксплуатационная документация
Мы разрабатываем или актуализируем эксплуатационную документацию — документы, описывающие работу с разработанной или доработанной системой. В составе эксплуатационной документации могут быть «Руководство для пользователей», «Руководство для администраторов», «Руководство для разработчиков», «Описание API», «Технологическая инструкция».
- 05Регламент оказания услуг
Мы составляем «Регламент оказания услуг», а также входящие в него документы. Эти документы содержат детальный отчет об оказанной услуге и составляются с учетом ГОСТ 2.105 «ЕСКД. Общие требования к текстовым документам».
- 06Документация по информационной безопасности
Мы готовим документы, описывающие результаты проведенного нами сканирования уязвимостей или аудита безопасности вашей системы. В перечень таких документов могут входить, например, «Отчет по результатам сканирования», «Отчет по результатам аудита», «План устранения уязвимостей».
- 07Обоснования мероприятий
Мы готовим документы, где обосновываем техническую или экономическую целесообразность закупки, разработки или модернизации у нас системы. К таким документам относятся в том числе и «Финансово-экономическое обоснование мероприятий», «Технико-экономическое обоснование мероприятий».
Техническая документация для цифровых систем
Готовим технические задания, пользовательские руководства и эксплуатационную документацию для корпоративных IT-систем.
Точная стоимость зависит от задачи — рассчитайте или оставьте заявку
По какой нормативной базе готовим документацию
- 01ГОСТ 34.x (Виды, комплектность и обозначения документов при создании автоматизированных систем)
- 02ГОСТ 19.х (Единая система программной документации, ЕСКД)
- 03ГОСТ 2.х (Единая система конструкторской документации, ЕСПД), в т. ч. ГОСТ 2.105 (Общие требования к текстовым документам)
- 04ГОСТ Р ИСО/МЭК ТО 18044-2007, ГОСТ Р 59547-2021, ГОСТ Р 59356-2021 (для «Журнала по результатам оказания услуг»)
- 05Также готовим документацию по любому из предложенных вами шаблонов и с учетом ваших требований для разрабатываемых или модернизируемых нами систем
Отвечаем на вопросы
- Какие услуги по документированию предоставляет «Энсайн»?Разрабатываем технические задания, пользовательские руководства и документацию на создаваемые нами системы. Для сторонних систем можем оценивать и актуализировать существующую достаточно полную документацию; восстановление документации с нуля для неизвестной системы без исходных материалов не предлагаем.
- Кто входит в штат технических писателей «Энсайн»?К подготовке документации привлекаем аналитиков и профильных специалистов проекта. Состав команды зависит от объема работ.
- С какими отраслями вы работаете?Работаем с корпоративными и государственными заказчиками, включая сложные веб-сервисы и информационные системы. Возможность проекта определяется его техническими требованиями.
- Подходят ли ваши документы для аттестации систем в ФСТЭК?При необходимости оформляем документы по ГОСТ 19 и ГОСТ 34. Аттестационные работы, требующие специальной лицензии, выполняются с профильными партнерами; сами документы не гарантируют успешную аттестацию.
- Как передаются права на созданные документы?Передача прав на созданные документы определяется договором.
- В каких средах вы оформляете документацию?Формат подготовки и передачи документации выбираем под требования заказчика.
- Почему качественная документация снижает риски для бизнеса?Актуальная документация упрощает сопровождение, снижает зависимость от отдельных специалистов и помогает планировать развитие системы.
- Возможна ли оплата по факту сдачи этапов?Этапность приемки и оплаты определяется договором.
- Что делать, если заказчик не разбирается в ГОСТах?Помогаем выбрать необходимый комплект документов исходя из целей проекта и требований заказчика.
- Проводятся ли доработки по замечаниям заказчика?Порядок доработок и согласования замечаний определяется договором.
- С какими сложными форматами схем вы работаете?Подготавливаем схемы архитектуры, интеграций и процессов в согласованном формате.
- Работаете ли вы со срочными проектами?Срочные работы рассматриваем с учетом доступности команды и объема документации; универсальные сроки не обещаем.
- Как заказать расчет стоимости разработки документации?Напишите на info@nsign.ru и опишите систему, исходные материалы и требуемый результат. После уточнения объема согласуем сроки и стоимость.
Расскажите о своем проекте
Мы находим подход даже к самым нестандартным задачам. Расскажите нам о своем проекте — мы готовы обсудить любые детали и предложить решения.