39 lines
2.4 KiB
Markdown
39 lines
2.4 KiB
Markdown
# Модуль: Публичная документация
|
|
|
|
**Ответственность**: проводит автора без опыта программирования от открытия fork до проверенного PDF.
|
|
**Расположение**: `README.md`, `docs/`
|
|
|
|
## Публичный интерфейс
|
|
|
|
| Документ | Назначение |
|
|
|----------|------------|
|
|
| `README.md` | Краткий обязательный маршрут и все важные ссылки |
|
|
| `docs/README.md` | Полная пользовательская навигация |
|
|
| `docs/documents.md` | Один main, режимы, профили, главы и assets |
|
|
| `docs/formatting.md` | Таблицы, рисунки, формулы и ссылки |
|
|
| `docs/examples/` | Компилируемые исходники |
|
|
| `docs/vscode.md` | Расширения, preview и tasks |
|
|
| `docs/git.md` | Совместная работа простыми словами |
|
|
| `docs/private-assets.md` | Копирование `.private`, один переключатель, роли и offsets |
|
|
| `docs/writing-style.md` | Заготовка для редактирования технического текста |
|
|
| `docs/troubleshooting.md` | Диагностика типовых проблем |
|
|
|
|
## Инварианты
|
|
|
|
- `docs/` виден в Explorer и находится в корне.
|
|
- Все обязательные сценарии доступны из root README.
|
|
- Каждый Typst-фрагмент с нетривиальным API имеет компилируемую версию.
|
|
- Термины Git объясняются бытовыми аналогиями.
|
|
- Developer details остаются в `.template/development/`.
|
|
- Документация не обещает автоматическую установку внутренних VSIX.
|
|
|
|
## Намеренно НЕ обрабатывает
|
|
|
|
- DDD architecture и migration internals.
|
|
- Обучение программированию.
|
|
- Администрирование Git-сервера.
|
|
|
|
## Заметки для агента
|
|
|
|
> Любое новое пользовательское действие сначала появляется в root README, затем раскрывается в `docs/`. Проверяйте относительные Markdown links и компиляцию public examples автоматически.
|