Перейти к содержимому
Robozon: база знаний
Esc
navigateopen⌘Jpreview
На этой странице

Как поддерживать базу знаний актуальной

Документация не должна быть вторым, независимым вариантом модели. После изменения результата сначала меняются сценарий, код и тест, затем текст.

Документация не должна быть вторым, независимым вариантом модели. После изменения результата сначала меняются сценарий, код и тест, затем текст.

Что менять после разных правок

Изменение Обновить
Новый параметр сценария Справочник сценариев, словарь, примеры API.
Новая метрика Справочник метрик, виджеты, учебный разбор результата.
Изменение формулы или окна Пояснения про поток и хвост, проверку результатов, защиту.
Новая политика Справочник политик, сравнение, объяснение маршрутизации.
Новый виджет Справочник виджетов и учебник дашборда.
Изменились точные цифры Главный README, учебный пример и страницы со сравнением.

Безопасный порядок работы

  1. Измените код и добавьте или обновите тест.
  2. Запустите тесты.
  3. Выполните воспроизводимый сценарий и сохраните его контекст.
  4. Сверьте контрольные числа с submission/report/data/canonical-kpis.json.
  5. Обновите только те примеры, к которым относится изменение.
  6. Выполните .venv/bin/python scripts/verify-submission-report.py.
  7. Найдите старые контрольные примеры: rg '23 141|100 013|99 997|86 130' README.md docs knowledge-base submission.
  8. Проверьте относительные ссылки и прочитайте изменённый маршрут как новичок.
  9. Запустите тесты ещё раз.

Стиль базы знаний

  • Сначала русский термин, затем технический идентификатор в обратных кавычках.
  • При первом упоминании объясняйте сокращение одним предложением.
  • Не называйте входной поток результатом.
  • Не называйте процентильный диапазон доверительной гарантией.
  • Любое число сопровождайте сценарием и горизонтом либо заменяйте командой, которая его получает.
  • В учебных текстах сначала используйте название из дашборда; имя JSON-файла указывайте только рядом с командой или API.

Эта страница была полезной?