Система подготовки ГОСТ документации в среде Atlassian Confluence
Система GOSTGen позволит вашему Confluence стать единым источником истины для команды разработки и группы технических писателей, устраняя разрывы в содержании внутренней документации проекта и документации, передаваемой вашим заказчикам. GOSTGen — это простое решение сложных задач для проектов с большим объемом документации, требующей регулярного обновления и согласований. Подробнее
1000/1
Быстродействие на максимуме — тысяча страниц в минуту! Эффективность и надежность при любом объеме данных и количестве пользователей
300%
Увеличьте эффективность подготовки технической документации с GOSTGen и получите тройную отдачу
1/365
Внедрение без задержек — это реальность с GOSTGen. Настройка и тренинг за один день, чтобы сосредоточиться на главном весь оставшийся год
Функциональность системы GOSTGen
Основные функции системы вполне достаточны для решения задачи экспорта ГОСТ-подобной документации из Atlassian Confluence, и преследуют целью минимизировать труд технических писателей по ее созданию, оставляя при этом полную свободу в использовании Confluence в первую очередь, как систему для ведения внутренней документации.
Аббревиатуры и термины
Система поддерживает автоматический поиск аббревиатур в тексте документа и составление списка используемых терминов на основе словарей, которые ведутся в Confluence. Словари могут быть организованы иерархически: глобальный словарь, словарь пространства Confluence, словарь предметной области и даже отдельно взятого документа.
Макросы GOSTGen
GOSTGen предлагает набор простых макросов для организации нумерации рисунков, таблиц, пунктов, сносок и приложений; макросов управления ориентацией и форматом страницы и макросов включения контента в выходной документ. Использование макросов не мешает восприятию страницы в Confluence, но позволяет формировать выходной документ в соответствии со строгими правилами ГОСТ.
Макросы Confluence
Не все макросы Confluence одинаково полезны для печатного документа, а часть из них работает только в браузере и не может использоваться для серверной обработки. GOSTGen имеет достаточно строгую политику касательно стандартных макросов Confluence с точки зрения пользы от их применения для формирования ГОСТ-подобной документации.
Авто-нумерация
Нумерация таблиц, рисунков, пунктов, сносок и приложений обеспечивается применением макросов GOSTGen. Вам не нужно следить за организацией последовательной сквозной нумерации этих объектов, достаточно лишь соблюдать уникальность присваиваемых номеров в рамках текущей страницы Confluence.
Авто-пунктуация
ГОСТ достаточно строго относится к завершающим знакам препинания в абзацах, списках (перечислениях), в таблицах, в подписях к рисункам и таблицам. GOSTGen учитывает эти правила и расставляет или, наоборот, удаляет завершающие знаки препинания, естественно, учитывая общеупотребительные сокращения, которые обязаны завершаться точкой в любом случае.
Авто-кавычки
Редактор Confluence «из коробки» не позволяет устанавливать кавычки типа елочка без дополнительных усилий. Используйте двойные прямые кавычки, а GOSTGen автоматически их трансформирует согласно принятым правилам русского или английского языка с учетом вложенности
Авто-корректор таблиц
ГОСТ предъявляет достаточно простые правила к оформлению таблиц — в таблице должна быть заголовочная строка (или строки), заголовок должен повторяться при переходе на следующую страницу, а ячейки заголовка выравниваются по центру, как и колонка номера строки по порядку. Но и здесь возможно возникновение проблем — таблица в Confluence совсем не обязательно будет иметь размеченный заголовок и нужное выравнивание. GOSTGen автоматически анализирует структуру таблицы и корректирует ее при необходимости.
Авто-корректор списков
Система автоматически корректирует частые ошибки, возникающие при оформлении списков в редакторе Confluence — удаляет пустые элементы списков, проводит исправление лишних уровней сдвига вложенных списков, «склеивает» идущие подряд списки одного уровня и устанавливает знаки пунктуации в конце элементов списка. Проводится также проверка на списки с единственным элементом и распознавание параграфов, похожих на списки.
Авто-корректор параграфов
В ГОСТ-подобной документации принято выравнивать абзацы основного текста по ширине листа. Поэтому мягкий перевод строки является настоящей головной болью всех технических писателей, когда вместо нового параграфа пользователи Confluence упорно используют Shift+Enter и в выходном документе текст разлетается по всей ширине строки. GOSTGen устраняет эту проблему, аккуратно разбивая текст по мягкому переводу строк на отдельные параграфы или, наоборот объединяет текст там, где это ненужно.
Авто-кегль
ГОСТ-подобная документация предполагает использование для основного текста шрифта 12pt, но в некоторых случаях допускает использование десятого кегля. Если для основного текста регулировать кегль не имеет смысла, то для текста таблиц или текста программного кода GOSTGen предлагает механизм регулирования размера шрифта в зависимости от количества колонок в таблицах или длины строк программного кода для различной ориентации и формата страниц.
Фильтрация таблиц
Для таблиц GOSTGen предлагает возможность фильтрации данных при выводе в выходной документ. Это удобно для организации единых справочников, которые в различных документах могут быть представлены частично согласно определенному критерию отбора, и позволяет иметь единственное место хранения такого справочника в Confluence для исключения дублирования информации.
Форматирование текста
GOSTGen старается максимально передать исходное форматирование статьи Confluence в выходной документ, однако, придерживается определенных ограничений. Ограничения диктуются правилами ГОСТ и сложившейся практикой.
Стоп-слова
Нормоконтроль документа касается не только корректности оформления, но и используемых терминов или просто определенных словосочетаний. Иногда бывает трудно избавиться от исторически сложившейся лексики в документе, которая вдруг стала неприятна нормоконтролю заказчика. GOSTGen просигнализирует о наличии в документе стоп-слов, используя настроенный техническими писателями словарь «запрещенных» выражений.
Обработка ошибок
Как вы уже убедились, GOSTGen проводит множество проверок и автоматических корректировок страниц Confluence, прежде чем они станут печатным документом. Результаты этой огромной работы презентуются пользователю в виде лога сообщений с удобной навигацией по тексту результирующего документа. Каждое сообщение имеет он-лайн справку, где достаточно подробно описаны причины возникновения каждого типа сообщения и методы устранения возникших проблем.
Твердая копия
Помимо выгрузки в формат ODT, система позволяет сохранить «твердую копию» сформированного документа в виде страницы Confluence, содержащий очищенный от макросов и ссылок текст, соответствующий по своему содержанию, нумерации разделов, таблиц и рисунков, текущей версии ODT-документа. «Твердая копия» может использоваться для внесения комментариев или создания Jira-задач в рамках цикла согласования и контроля исправления замечаний к документу.
HTML-S*
Confluence не отличается любовью к «чистоте» выходного HTML и вообще к стандарту HTML5, особенно при копировании информации из текстовых редакторов LibreOffice Writer или MS Word. GOSTGen проводит очистку и автокорректировку исходной статьи Confluence, убирая избыточность форматирования и нарушения стандарта HTML5.
Безопасность
Безопасность информации является в наши дни одним из краеугольных камней информационных технологий. Техническая документация всегда была объектом, как минимум, небезынтересным для конкурентов. Что же предлагает GOSTGen в плане информационной безопасности?
Ограничения
Было бы некорректно не рассказать и об ограничениях системы. Ограничений не так много. Некоторые из них являются пунктами бэклога и будут устранены в ближайших версиях, некоторые ждут своего инвестора, а с некоторыми ограничениями не совсем пока понятна ценность их преодолении для технического писателя.
Услуги
Мы предлагаем своим пользователям полный спектр услуг, который включает сопровождение, разработку, внедрение и обучение. Сопровождение может быть базовым или индивидуальным, обеспечивая обновления и техническую поддержку для оптимальной работы системы. Разработка дополнительных функций позволяет адаптировать систему под ваши специфические нужды, сохраняя при этом совместимость с будущими версиями. Внедрение и обучение работе с GOSTGen может быть самостоятельным, но мы всегда готовы предложить экспертную помощь для более эффективного использования системы.
Сопровождение
GOSTGen предлагает две модели сопровождения — базовое и индивидуальное. Базовое сопровождение осуществляется бесплатно согласно выбранной модели лицензирования и включает в себя поставку обновлений системы и исправление возможных несоответствий ее работы заявленной функциональности. Индивидуальное сопровождение дополняет базовое в части адресных консультаций по использованию системы.
Разработка
Если вам не хватает функциональности GOSTGen «из коробки», то вы можете заказать дополнительные функции для вашей инсталляции под вашу методику ведения документации в Confluence. Архитектурно, Заказ дополнительных разработок не создает уникальной версии GOSTGen, так как все дополнения реализуются изолированно в области пользовательских функций и будут совместимы с последующими версиями системы.
Внедрение
Хорошая документация, дружественный интерфейс, онлайн справка помогут вам самостоятельно внедрить GOSTGen, но можно воспользоваться и нашим опытом, который существенно облегчит внедрение системы и поможет получить максимальный экономический эффект от ее применения.
Обучение
Обучение использованию системы GOSTGen является достаточно тривиальной задачей — система проста для пользователя, поддержана хорошо организованной и понятной документацией по каждой составляющей системы, но, при необходимости, вы всегда сможете запросить сессии онлайн обучения по любому аспекту использования системы.