Appearance
Пошаговый процесс работы
Ниже описан полный цикл работы пользователя — от входа в систему до получения финального .docx файла.
1. Авторизация и вход в систему
Работа начинается с авторизации пользователя.
После входа становятся доступны:
- шаблоны оформления;
- созданные документы;
- история изменений и рендеринга.
Проект ориентирован на долгосрочную работу:
пользователь может возвращаться к документам, дорабатывать их и пересобирать результат в любой момент.
2. Создание и настройка шаблона оформления
Первый ключевой этап — создание шаблона оформления.
Шаблон — это набор правил, а не текст документа.
Он определяет:
- стили заголовков и основного текста;
- отображение формул, таблиц и рисунков;
- правила нумерации элементов;
- оформление титульных листов;
- структуру содержания и списка литературы.
Важно
Шаблон настраивается один раз и может использоваться многократно.
Один и тот же шаблон может применяться:
- к разным документам;
- для переоформления одного текста под разные требования.
3. Создание документа и привязка к шаблону
После подготовки шаблона пользователь создаёт документ и привязывает его к выбранному шаблону.
Роли чётко разделены:
- документ отвечает за:
- текст;
- структуру;
- логические связи (ссылки, источники, нумерацию);
- шаблон отвечает только за внешний вид.
TIP
Один и тот же документ можно рендерить с разными шаблонами без изменения текста.
4. Разбиение документа на файлы
Для удобства работы документ может быть разбит на несколько файлов.
Типичный пример:
- отдельный файл для введения;
- файлы для глав;
- файл для заключения;
- файл для списка литературы.
Это позволяет:
- не работать с одним большим текстом;
- проще ориентироваться в структуре;
- редактировать части документа независимо.
При финальной сборке:
- все файлы автоматически объединяются;
- порядок задаётся настройками документа;
- результат всегда представляет собой один цельный документ.
5. Работа в редакторе
Основная работа выполняется во встроенном Markdown-редакторе.
Редактор поддерживает:
- стандартный Markdown-синтаксис;
- структурирование текста;
- использование Liquid JS для логики.
Пользователь пишет обычный текст, не задумываясь о стилях, шрифтах и отступах.
6. Предпросмотр документа
Редактор предоставляет режим предпросмотра, который отображает:
- результат рендеринга Markdown;
- применение Liquid-логики;
- подставленные переменные;
- актуальные номера формул, таблиц, рисунков и ссылок.
Важно понимать
Предпросмотр не является финальным Word-документом.
Он показывает:
- логическую корректность документа;
- правильность ссылок и нумерации.
Окончательные шрифты, отступы и стили применяются только на этапе финального рендеринга.
7. Рендеринг финального документа
После завершения работы над текстом пользователь запускает финальный рендеринг.
На этом этапе:
- Markdown и Liquid преобразуются в итоговую структуру;
- применяется выбранный шаблон;
- формируется корректно оформленный файл
.docx.
Полученный документ:
- полностью готов к сдаче;
- соответствует требованиям оформления;
- открывается в Microsoft Word и аналогах;
- при необходимости может быть слегка отредактирован вручную.
Итог
Рабочий процесс выстроен так, чтобы:
- исключить ручное форматирование;
- избежать ошибок нумерации и структуры;
- сделать результат предсказуемым и воспроизводимым.
Пользователь один раз настраивает правила, после чего система берёт на себя всю рутинную работу.