Статус документации¶
На этой странице автоматические гарантии и выполненные технические проверки отделены от проверок, для которых нужны люди или реальное окружение. Статус последний раз пересмотрен 2026-07-23.
Подтверждённые проверки¶
| Проверка | Подтверждение |
|---|---|
| Поддерживаемые страницы на английском и русском остаются парными | make docs-quality проверяет каждую страницу User, Admin, Reference и Operator, а также обе главные страницы. |
| Публичный и закрытый сайты собираются со строгой проверкой ссылок | Строгие сборки MkDocs запускаются локально и в CI-job docs. |
| Operator-процедуры не попадают в публичный сайт | Quality gate проверяет дерево публичной сборки и все ссылки в публичном HTML. В закрытой сборке обязательно должны быть английский и русский индексы Operator. |
| Ссылки помощи из продукта остаются публичными, двуязычными и привязанными к аудитории | Quality gate проверяет DOCS_PATHS и DOCS_AUDIENCES, а web-тесты — URL и поведение локали. |
| Публикуемая REST reference доступна только для чтения | Сгенерированный артефакт содержит ровно 11 разрешённых операций GET. Сборка отклоняет запрещённые семейства endpoint или устаревшую копию артефакта. |
| Чистое окружение можно развернуть | Закрытый smoke test развёртывания окружения выполнен 2026-07-23 с изолированным состоянием и входом нового пользователя. |
| Stateful backup и restore работают по инструкции | Закрытый multi-store restore drill выполнен 2026-07-23 для PostgreSQL, Temporal, Qdrant, MinIO, Redis и состояния Phoenix. |
| Для изменений документации действует review contract | CONTRIBUTING.md и стандартный шаблон merge request требуют описать влияние на документацию и явно назвать непроверенные границы. |
Полная локальная проверка из корня репозитория:
make docs-quality
Публичный портал запускается командой make docs-serve. Авторизованные
сопровождающие могут отдельно открыть Operator-сборку командой
make docs-serve-internal.
Ещё не подтверждено независимой проверкой¶
Для следующих проверок нужны люди, общая инфраструктура или внешние провайдеры. Автоматические проверки не объявляют их выполненными:
- usability walkthrough новым пользователем, который не участвовал в написании документации;
- полный walkthrough MVP проверяющим, который не участвовал в реализации;
- развёртывание на общем staging с реальными DNS, TLS, reverse proxy и callback внешних провайдеров;
- полный администраторский путь для launch stack: приглашение, настройка connector, первая синхронизация, approval policy и проверка audit.
После каждого walkthrough добавляйте сюда датированное подтверждение и найденные блокеры. Нельзя подменять результат человеческой или staging-проверки результатом локальной сборки.