📝 Документация OmniCraft ERP (VitePress) — Редполитика и стандарты

Этот документ содержит стандарты, редполитику и правила оформления пользовательской документации и сайта проекта OmniCraft ERP (директория website/).

---

🧭 1. Основные правила и Редполитика

При написании, обновлении и локализации документации обязательно соблюдайте следующие правила:

1. Сквозной учебный проект (Лор):

   • Все практические примеры, сценарии и скриншоты в документации базируются на едином сквозном тестовом проекте — «Производство глиняных шаров с соломой» (с использованием оборудования: соломорезки, тестомесы для глины, бочки для грязи, масло-разделители и т.д.).
   • Запрещено выдумывать абстрактные примеры («Товар 1», «Тест»). Если для нового раздела не хватает точных параметров или названий — запросите скриншоты или данные из тестовой базы.

2. 100% синхронизация с интерфейсом (UI-Sync):

   • Все названия вкладок, кнопок, модальных окон, таблиц и полей ввода берутся строго и дословно из словарей локализации (locales/ru.json и др.).
   • Названия элементов выделяются жирным шрифтом: например, вкладка «Сырьё», кнопка «Добавить партию».

3. Инфостиль и Tone of Voice:

   • Практичный, деловой и уважительный тон. Пишем для мастеров и ремесленников («мастер — не бухгалтер»).
   • Никаких рекламных клише, «воды», общих фраз и превосходных степеней. Фокус на сокращении рутины и наглядных примерах.

4. Синтаксис и возможности VitePress:

   • Используйте семантические коллауты для акцентирования внимания:

     ::: tip Совет
     Полезные рекомендации по экономии времени или настройке.
     :::
     
     ::: warning Внимание
     Важные предупреждения о влиянии операций на финансовый баланс или списание FIFO.
     :::

   • Применяйте таблицы, списки, .svg-иконки и встроенные компоненты для удобства восприятия.
   • Сохраняйте корректную структуру Frontmatter в начале страниц:

     ---
     title: Заголовок страницы
     description: Краткое описание страницы для навигации и SEO
     ---

5. Мультиязычность и синхронизация:

   • При изменении или добавлении материалов в русскую версию (website/ru/docs/) обязательно синхронно вносите соответствующие правки в основную/английскую версию (website/docs/).

---

🛠 2. Структура директории website/

• ru/docs/ — русскоязычная документация пользователя (база знаний, руководства по модулям, бизнес-логика).
• docs/ — англоязычная версия документации.
• .vitepress/ — конфигурация темы, меню навигации, сайдбара и плагинов VitePress.
• public/ — статичные ассеты, скриншоты, схемы и иконки.