Описание
Программный продукт «Platform V GetDocs» представляет собой систему для разработки и публикации эксплуатационной документации. Позволяет преобразовывать исходные тексты документации из разных источников в выходные формы и размещать их на веб-сайте для пользователей. Обладает следующими ключевыми особенностями и преимуществами по сравнению с аналогичными решениями:• Упрощает переход к ведению документации Docs as/like code. Подходит для параллельнойразработки документации (50+ команд).• Поддерживает версионирование документации.• Формирует документацию из MyST Markdown и reStructured Text форматов в виде статическогосайта, а также поддерживает выгрузку форматах PDF и DOCX.• Обеспечивает представление API компонентов в формате Swagger.• Позволяет формировать архивы документации для включения в дистрибутивы продуктов.
Platform V GetDocs обладает следующими функциональными характеристиками:
- Преобразование исходных кодов документации в формате Markdown и MyST Markdown в выходные формы для пользователей: веб-версия, файлы в форматах docx, pdf;
- Формирование документации на API из исходного кода и спецификаций;
- Валидация документации по настраиваемым правилам;
- Получение отчета о валидации и переход к источнику ошибки в исходных кодах;
- Формирование архива со статическим сайтом документации для включения в дистрибутив программного продукта;
- Просмотр документации на сайте в режиме технического писателя и читателя документации;
- Полнотекстовый поиск по контенту документации;
- Конфигурирование отображения контента на сайте.
Если вы обнаружили ошибку, пожалуйста, уведомите нас — выделите текст с ошибкой и нажмите клавиши Ctrl+Enter. Отключите блокировщик рекламы, если после нажатия комбинации кнопок не срабатывает всплывающее окно.
