Как устроен ГОСТ-ОН
ГОСТ-ОН — платформа ведения технической документации, в которой документы собираются из единого источника данных. Главный принцип платформы: документ = шаблон + данные.
- Шаблон — текст документа в разметке Markdown с командами Jinja. Вместо конкретных значений в тексте стоят обращения к переменным:
{{ название_системы }}. - Данные — переменные и объекты проекта. Они заполняются один раз и используются во всех документах проекта.
Единый источник данных
При предпросмотре и экспорте платформа подставляет значения переменных в шаблон и собирает готовый документ. Поэтому правка значения в одном месте автоматически обновляет все документы, где оно используется, а комплект документации остается согласованным.
С чего начать
- Создайте рабочее пространство и проект (см. «Рабочие пространства и проекты»).
- Опишите структуру данных и заполните значения переменных (см. «Данные проекта: переменные и объекты»).
- Напишите шаблоны документов в редакторе (см. «Редактор документов» и «Синтаксис шаблонов»).
- Выгрузите результат (см. «Экспорт и публикация»).
Следующая