Статьи // tekblueprint

Управление спецификациями и документацией

Сергей Грачев
обновлено: 6 сент. 2025 г.  опубликовано: ⏰ 2
article image

tekBlueprint.specs – инструмент управления спецификациями и документацией, который позволяет документировать проекты на различных этапах. Использование предопределенных шаблонов для блоков спецификаций и справочников может помочь значительно ускорить и упростить создание проектной документации.

ℹ️ Предупреждение

tekBlueprint.specs находится на стадии разработки и является частью tekBlueprint.

Основные возможности

Функции MVP будут включать:

  • Управление шаблонами выходной документации – создание, редактирование и хранение шаблонов документации проекта.
  • Типизация блоков спецификаций – предоставление типизированных блоков описания спецификаций: функциональные и нефункциональные требования, техническое предложение, интеграции, миграция данных, справочники и т.д.
  • Генерация документации – автоматизация процесса рендеринга документации в различные форматы: AsciiDoc (основной), Markdown. В дальнейшем могут быть преобразованы в PDF, DOCX, HTML.
  • Различные типы шаблонов – поддержка различных движков шаблонизаторов: Freemarker (основной), Mustaches.

Примеры

Документация генерируется на примере вымышленного проекта NovaPlay, который разрабатывают вымышленные компании Tech Innovations Inc (Заказчик) и ACME Corporation Ltd. (Исполнитель) с использованием различных типов шаблонов.

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

Для наглядности приведены примеры:

Specs Documentation Design Tb-Specs