29 lines
2.4 KiB
Markdown
29 lines
2.4 KiB
Markdown
# Документация пользователя Scientia
|
|
|
|
Этот каталог содержит только материалы для авторов документов. Для работы с ним не нужно знать внутреннюю архитектуру Typst-шаблона.
|
|
|
|
## Рекомендуемый порядок
|
|
|
|
1. Пройдите [первый запуск и настройку VS Code](vscode.md).
|
|
2. Выберите вид документа по инструкции [Работа с документами](documents.md).
|
|
3. Откройте [каталог приёмов оформления](formatting.md) и копируйте подходящие примеры.
|
|
4. Перед совместной работой прочитайте [Git для авторов](git.md).
|
|
5. Для финального выпуска подключите [приватные подписи и печати](private-assets.md).
|
|
|
|
## Навигация
|
|
|
|
| Документ | Содержание |
|
|
|----------|------------|
|
|
| [documents.md](documents.md) | Один `main.typ`, режимы, виды документов, главы и ресурсы |
|
|
| [formatting.md](formatting.md) | Рисунки, таблицы, формулы, ссылки, CSV и списки |
|
|
| [examples/README.md](examples/README.md) | Компилируемые примеры отчёта, письма, ТКП, договора и оформления |
|
|
| [vscode.md](vscode.md) | Расширения, предпросмотр, автосохранение и задачи |
|
|
| [git.md](git.md) | Commit, branch, pull, push, merge и конфликты простыми словами |
|
|
| [private-assets.md](private-assets.md) | Папка `.private`, подписи сотрудников и индивидуальные смещения |
|
|
| [writing-style.md](writing-style.md) | Заготовка запроса для редактирования технического текста |
|
|
| [troubleshooting.md](troubleshooting.md) | Решение типовых ошибок |
|
|
|
|
## Где находится разработка шаблона
|
|
|
|
Архитектура, ADR, тесты, snapshots и заметки сопровождающих находятся в `.template/development/`. Обычному автору открывать этот каталог не требуется.
|