Woo2iiko Documentation — Version 2 (Build Plan)
Внутренний план построения документации V2. Не публикуется на сайте.
Цель
Полный аудит продукта Woo2iiko v2.0.0.5 (feature-first, 47 фич) и создание документации V2 с покрытием ≥95% пользовательского функционала. V1 сохранена в docs-v1/. Источник правды — исходный код плагина: /home/alex/Projects/woocommerce.local/wp-content/plugins/woo2iiko/.
Принципы
- Документируем только функционал, подтверждённый в коде (README фич + docs/).
- Аудитория: business users и WooCommerce-администраторы.
- Каждая настройка и каждый воркфлоу объясняются.
- Все скриншоты — плейсхолдеры
. - Язык — русский.
- Формат — VitePress markdown с frontmatter.
Структура дерева V2
docs/
├── index.md # Главная — обзор продукта, режимы, навигация
├── getting-started/
│ ├── overview.md # Что такое Woo2iiko, для кого
│ ├── requirements.md # PHP 8.3+, WP 6.4+, WC 7.6+, iiko Cloud
│ ├── quick-start.md # Установка за 5 шагов
│ └── glossary.md # Термины (iiko, терминал, номенклатура, стоп-лист…)
├── install/
│ ├── purchase.md # Лицензия, UpdatePulse
│ ├── install.md # Установка, активация, удаление
│ ├── update.md # Обновления
│ └── uninstall.md # Удаление, опция iiko_delete_data
├── onboarding/
│ ├── wizard.md # Setup wizard
│ ├── connect-iiko.md # Token broker vs Legacy API key
│ ├── organizations.md # Выбор организации/терминала
│ └── first-import.md # Первый импорт номенклатуры
├── modes/ # Три бизнес-режима
│ ├── index.md # Обзор режимов
│ ├── delivery.md # Сайт доставки (основной)
│ ├── qr-menu.md # QR-меню ресторана
│ └── pay-by-table.md # Оплата по столу
├── workflows/ # Бизнес-процессы сквозные
│ ├── product-import.md # Импорт каталога
│ ├── product-export-order.md # Экспорт заказа в iiko
│ ├── checkout.md # Оформление заказа
│ ├── delivery-zones.md # Зоны доставки, расчёт
│ ├── stop-list.md # Стоп-листы, остатки
│ ├── order-tracking.md # Отслеживание статуса
│ ├── sms-auth.md # SMS/Email авторизация
│ └── background-sync.md # Фоновые процессы/cron
├── configuration/ # Справочник настроек по разделам
│ ├── index.md # Карта настроек
│ ├── connection.md # API connection, token broker
│ ├── general.md # Основные (debug, UI, translit)
│ ├── import.md # Настройки импорта
│ ├── products.md # Товары, модификаторы, КБЖУ, AJAX qty
│ ├── checkout.md # Checkout-форма, поля
│ ├── geo.md # Геокодирование
│ ├── delivery.md # Доставка, зоны, расписание
│ ├── payment.md # Оплата, маппинг шлюзов
│ ├── bonuses.md # Бонусы iiko
│ ├── sms.md # SMS-сервисы, SmsAuth
│ ├── notifications.md # Telegram, email, perf alerts
│ ├── cache.md # Object cache, CacheStorage
│ └── settings-manager.md # Экспорт/импорт/сброс настроек
├── features/ # Отдельные возможности
│ ├── bonuses-loona.md # Loona.ai
│ ├── coupons.md # Скидки/купоны iiko
│ ├── address-manager.md # Управление адресами
│ ├── zone-checker.md # Виджет проверки зоны
│ ├── gutenberg-blocks.md # Блоки iiko/checkout, saved-addresses
│ ├── pay-by-table-details.md # Детали оплаты по столу
│ ├── reserve-tables.md # Бронь столов (QR)
│ ├── multi-point.md # Сетевые рестораны (PointChecker)
│ ├── performance.md # Мониторинг
│ ├── logs.md # Логи, debug
│ ├── errors.md # Обработка ошибок
│ └── templates.md # Переопределение шаблонов
├── loyalty/
│ ├── index.md
│ ├── iiko-card.md # Бонусы iiko Card
│ └── loona.md # Loona.ai
├── integrations/
│ ├── iiko-cloud.md # iiko Cloud API
│ ├── sms-providers.md # SMSC, sms_aero, sms.ru, intel…
│ ├── geo-providers.md # 2GIS, Yandex, DaData
│ └── payment-gateways.md # Шлюзы оплаты, ЮKassa
├── developer/
│ ├── rest-api.md # REST endpoints
│ ├── wp-cli.md # WP-CLI команды
│ ├── hooks.md # PHP-хуки для расширений
│ └── webhooks.md # Вебхуки iiko
├── troubleshooting/
│ ├── index.md # Диагностика
│ ├── connection-issues.md # Проблемы подключения к iiko
│ ├── import-issues.md # Проблемы импорта
│ ├── export-issues.md # Заказы не уходят в iiko
│ ├── checkout-issues.md # Проблемы оформления
│ └── common-errors.md # Коды ошибок, частые проблемы
└── reference/
├── settings-full.md # ПОЛНЫЙ справочник всех iiko_* настроек
├── shortcodes.md # Все шорткоды
├── cron-jobs.md # Все cron-задачи
└── migration-v1-to-v2.md # Гид миграцииCoverage mapping (фича → документ)
Каждая из 47 фич должна быть отражена минимум в одном документе.
| Фича | Основной документ | Доп. упоминания |
|---|---|---|
| AddressManager | features/address-manager.md | workflows/checkout.md |
| AddressNormalization | configuration/geo.md (формат адреса) | — |
| AdminUI | configuration/index.md, onboarding/* | все разделы |
| AdminUIWizard | onboarding/wizard.md | — |
| BackgroundProcess | workflows/background-sync.md | reference/cron-jobs.md |
| Bonuses | configuration/bonuses.md, loyalty/iiko-card.md | workflows/checkout.md |
| Cache | configuration/cache.md | — |
| CacheStorage | configuration/cache.md | reference/wp-cli.md |
| CheckoutForm | configuration/checkout.md, workflows/checkout.md | modes/delivery.md |
| CheckoutSchedule | configuration/delivery.md (расписание) | modes/delivery.md |
| DeliveryCalendar | configuration/delivery.md, workflows/checkout.md | — |
| Geocoding | configuration/geo.md, integrations/geo-providers.md | workflows/delivery-zones.md |
| GutenbergBlocks | features/gutenberg-blocks.md | — |
| IikoCategoriesTaxonomy | features/coupons.md, workflows/product-import.md | — |
| LoonaBonuses | features/bonuses-loona.md, loyalty/loona.md | workflows/checkout.md (mutex), troubleshooting/checkout-issues.md (mutex), reference/settings-full.md (loona_bonuses_hint) |
| Modal | features/templates.md | — |
| ModifiersFilter | configuration/import.md | workflows/product-import.md |
| OrderEmail | workflows/order-tracking.md | integrations/… |
| OrderExport | workflows/product-export-order.md | troubleshooting/export-issues.md |
| OrderTracking | workflows/order-tracking.md | — |
| PayByTable | modes/pay-by-table.md, features/pay-by-table-details.md | — |
| Performance | features/performance.md | configuration/notifications.md |
| PointChecker | features/multi-point.md | modes/index.md |
| ProductImport | workflows/product-import.md, configuration/import.md | onboarding/first-import.md |
| ProductModifiers | configuration/products.md | — |
| ProductNutritional | configuration/products.md | — |
| ReserveTables | features/reserve-tables.md, modes/qr-menu.md | — |
| SettingsManager | configuration/settings-manager.md | — |
| SmsAuth | workflows/sms-auth.md, configuration/sms.md | modes/pay-by-table.md |
| SmsNotifications | configuration/sms.md, integrations/sms-providers.md | — |
| StopList | workflows/stop-list.md | troubleshooting/… |
| TelegramNotifications | configuration/notifications.md | — |
| Transliteration | configuration/general.md | — |
| UserLoginTracker | reference/cron-jobs.md | — |
| UserPluginSettings | configuration/sms.md | — |
| WooAccount | features/address-manager.md (ЛК) | workflows/sms-auth.md |
| WooAjaxAddToCart | configuration/products.md | — |
| WooAjaxQty | configuration/products.md | — |
| WooCoupon | features/coupons.md | — |
| WooOrderMetaBox | workflows/product-export-order.md | troubleshooting/… |
| WooPayment | configuration/payment.md, integrations/payment-gateways.md | modes/pay-by-table.md |
| WooShipping | workflows/delivery-zones.md, configuration/delivery.md | — |
| WpCli | developer/wp-cli.md | reference/cron-jobs.md |
| WpDBUpdater | install/update.md | — |
| WpML | integrations/… (WPML) | onboarding/… |
| WpRestApi | developer/rest-api.md, developer/webhooks.md | — |
| ZoneChecker | features/zone-checker.md | workflows/delivery-zones.md |
Статус сборки
- [x] V1 сохранена как docs-v1/
- [x] Дерево V2 создано
- [x] Feature inventory собран (47 фич)
- [x] Документы написаны — 72 файла, ~29 000 слов
- [x] VitePress sidebar/nav обновлён (config.mjs syntax OK)
- [x] Проверка покрытия — 100% (47/47 фич), 0 битых ссылок
Финальная статистика
- Документов: 72 (V1 было 40)
- Уникальных настроек в справочнике: 115
- Файлов со скриншот-placeholders: 24
- Покрытие фич: 47/47 (100%)
- Битых ссылок в sidebar: 0