Отечественная платформа уменьшает сроки разработки программных документов07.02.2023 15:00

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

Сделано по ГОСТу

Любой проект для крупного заказчика требует разработки комплекта документации. И зачастую ее формат определяется не только ТЗ, но также отраслевыми стандартами, регуляторными правилами и все чаще — ГОСТом, что связано с увеличением доли государственного заказчика на рынке заказной разработки ИТ-решений. Наша оценка реальных кейсов показала, что в среднем на создание технических документов при заказной разработке уходит от двух до шести месяцев и еще не менее недели на их согласование (если обойдется одной итерацией). Ускорить процесс можно с помощью инструментов работы со структурированными документами (Component CMS), которые, в отличие от классических инструментов, позволяют управлять контентом на гранулярном уровне разделов, подразделов, предложений или даже отдельных слов. Как подобный продукт помогает оптимизировать процесс, разбираем в деталях.

Уменьшение сроков подготовки документов, а значит — итогового времени до релиза продукта. Этого можно добиться за счет автоматизации создания и редактирования программных документов.

Как автоматизировать редактирование документов

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

Поскольку «Сфера.Документы» — один из продуктов платформы производства ПО «Сфера», он может быть легко интегрирован с другими, в частности — со «Сфера.Функциональное тестирование» и «Сфера.Релизы». Это обеспечивает автоматизацию формирования тестовых документов и связь документов с циклом производства продукта. Такое взаимопроникновение формирует консистентный пользовательский опыт в рамках всего бизнес-процесса работы с документом.

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

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

Ошибки в этом случае чреваты серьезными последствиями. Избежать их помогает уже упомянутая выше шаблонизация, так как образцы документов изначально содержат все предусмотренные законом требования к оформлению и контенту и подсказки по заполнению тех или иных разделов. Кроме того, в «Сфере.Документы» повышение качества разрабатываемой документации происходит за счет автоматизации механик формального контроля документов.

Доступность инструмента. Очень небольшое число компаний используют для работы с документами сложные самописные решения. Реализовать такой проект могут себе позволить только лидеры ИТ-рынка, способные нанять множество разработчиков. Остальные традиционно собирают документацию по проекту из фрагментов, написанных в файлах Word. Или ведут описание внутренних процессов в Confluence или MadCap, а потом платят за «упаковку» этого контента по ГОСТу. Что очень неудобно, а с момента введения санкционных режимов и небезопасно.

С уходом глобальных вендоров с российского рынка остро встал вопрос миграции на отечественное ПО, однако здесь зрелых предложений до 2022 г. практически не было. Продукт «Сфера.Документы» находится в высокой степени готовности: он уже апробирован в компаниях ИТ-холдинга Т1 и показал свою эффективность для enterprise-сегмента.

Сокращение затрат на разработку и изменение документации. Специалисты, занятые на крупных проектах, утверждают, что 3–7 процентов стоимости закладывается на оформление документов. За счет подключения инструментов работы со структурированными документами можно достичь значительной экономии. Кроме того, их использование сводит к минимуму отвлечение сотрудников от целевой деятельности по разработке ПО и снижает риски их увольнения.

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

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

Разрешить культурный конфликт agile с бюрократией можно с помощью тех же инструментов работы со структурированными документами. Подсказки в шаблонах и автоматизация заполнения разделов документа через интеграцию с системой источников данных, например, с другими продуктами «Сферы» или CRM и ERP системами облегчает работу разработчика. Кроме того, чтобы сократить сроки согласования документа и избежать его возврата на доработку, подключаются механизмы упрощенной проверки и работы с версиями.

Заключение

Работая с крупными государственными и коммерческими заказчиками, мы в полной мере ощутили на себе сложность разработки и согласования программных документов. Именно поэтому в ряду первых инструментов платформы производства «Сфера» были те, что автоматизируют забюрократизированные процессы в целом и работу со сложно структурированными документами в частности. Мы видим, что сегодня эти сервисы востребованы сотрудниками многих компаний, производящих ИТ-продукты, в первую очередь, бизнес-аналитиками и разработчиками.

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

Для подробного знакомства с возможностями инструмента «Сфера.Документы» приглашаем вас на вебинар: «Просто о сложном: сокращение трудозатрат на разработку программной документации», который состоится 9 февраля в 11:00.■

Полный текст статьи читайте на CNews