Это полный перевод инструкции для чтения. Для установки используйте исходный пакет навыка, а не эту страницу. Канонический источник: skills/open-knowledge-format/references/operational-workflows.md. Проверенная ревизия источника: 61e75e9aa9a8719dfb480bf1f5226553b3a21d70.

Практические операции с OKF

Используйте эти инструкции, когда нужно проверить или показать существующий набор документов. Они входят в open-knowledge-format, а не устанавливаются как отдельные навыки для каждой команды. Семантику определяют актуальная схема инструмента и зафиксированная спецификация формата. Примеры предполагают установленную CLI okf; в рабочей копии репозитория вместо неё можно использовать go run ./cmd/okf. Прежде чем выбирать способ выполнения, проверьте доступность инструмента. Не устанавливайте пакеты, не регистрируйте хуки и не угадывайте префикс MCP, зависящий от приложения.

Проверить и объяснить набор документов

Входные данные: корневой каталог, требуемый --spec auto|0.1|0.2, профиль времени (date-3fcbb9f по умолчанию либо явно выбранный instant-0b87c52) и необязательный момент проверки. Уточняйте допустимое число предупреждений только тогда, когда пользователь или CI требует порог. auto определяет версию по объявлению в корневом документе; явный выбор проверяет соответствие этому объявлению. Некорректное существующее объявление — ошибка, а не повод предположить v0.2.

  1. Проверьте корень и доступный инструмент. Предпочтите validate_bundle подключённого MCP-сервера OKF, если его актуальная схема поддерживает нужные параметры; иначе используйте CLI. Для воспроизводимых результатов запросите JSON:

    okf validate --path ./knowledge --spec auto --format json --as-of 2026-09-27
    

    Для профиля с точным временем используйте --temporal-profile instant-0b87c52 и дату со временем и смещением в формате RFC3339 для --as-of. Для профиля даты используйте YYYY-MM-DD.

  2. Запишите объявленную и действующую версии, результат определения версии, профиль, число просмотренных файлов, conformant, ошибки и диагностику. Сначала исправьте базовые ошибки. Затем, если требуется оценка качества оформления, проверьте тот же снимок с --strict --check-links --check-orphans. Параметр --max-warnings 0 задаёт необязательный порог политики, а не другое определение соответствия формату. Различайте строгие предупреждения, превышение порога и базовые ошибки.
  3. Для каждого исправимого замечания укажите путь, поле и минимальное поддерживаемое исправление. После изменений повторите проверку и покажите итоговый отчёт либо путь к нему. Успешная проверка подтверждает формат, а не истинность утверждений, точность сведений об источниках или состояние verified.

Запасной путь: если MCP отсутствует, проверьте okf help либо Go CLI из рабочей копии. Если CLI недоступна или не поддерживается на этой машине, вручную изучите корневой index.md и выбранные Markdown-файлы. Назовите это ручным осмотром и оставьте соответствие формату неподтверждённым. При прерывании сохраните последний отчёт и идентификатор снимка, затем повторите проверку текущих документов; не используйте результат, полученный до редактирования. Чтение и проверка не изменяют файлы знаний.

Завершение: отчёт указывает набор документов, выбор версии, профиль, момент проверки, фактический запуск инструмента, базовый результат, отдельный результат необязательных рекомендаций и порога, а также оставшиеся замечания. Проверка фактов не подразумевается.

Запрос Действия Что показать
«Проверь формат knowledge на 27 сентября». Определить версию по корню и выбрать профиль даты; запустить okf validate --path ./knowledge --spec auto --format json --as-of 2026-09-27. Объявленную и действующую версии, базовое значение conformant, ошибки и диагностику.
«CI должен отклонять любые предупреждения». Выполнить базовую проверку, затем okf validate --path ./knowledge --spec auto --strict --check-links --check-orphans --max-warnings 0 --format json. Соответствие базовому формату и отдельный результат политики предупреждений; полный JSON-отчёт, если доступен.
«Почему этот набор документов не проходит проверку?» Изучить существующую JSON-диагностику, проверить указанные пути, исправить файлы в пределах разрешённой задачи и повторить запуск с теми же параметрами. Число замечаний до и после, изменённые файлы, нерешённые проблемы; проверка никогда не устанавливает verified.

Экспортировать и осмотреть автономный просмотрщик

Входные данные: корень набора, путь выходного HTML, версия, профиль и момент проверки, а также разрешение заменить существующий файл. Версию определяйте как описано выше. Просмотрщик — локальный экспорт для чтения: он не выполняет вложенные ресурсы и не отправляет содержимое на сервер.

  1. Проверьте CLI командой okf help либо используйте go run ./cmd/okf в рабочей копии. Выберите новый выходной путь вне набора документов и хранилища .okf/. Экспорт отклоняет существующий файл без --overwrite; перед использованием этого параметра установите разрешение на замену из задачи либо запросите его. Не заменяйте файл молча.
  2. Выполните экспорт с действительными параметрами, например:

    okf view ./knowledge --output /tmp/knowledge-viewer.html --spec auto \
      --as-of 2026-09-27
    

    Для профиля точного времени используйте --temporal-profile instant-0b87c52 и дату со временем и смещением. Без --as-of состояние актуальности остаётся unevaluated.

  3. Откройте локальный файл в браузере. Проверьте список и поиск понятий, выбранный документ, навигационные ссылки, источники и обозначения доверия, статуса и актуальности. Покажите HTML или ссылку на него. Успешный экспорт сам по себе не является визуальным осмотром и не подтверждает утверждения документов.

Запасной путь: текущий каталог из 14 MCP-инструментов не содержит экспорта просмотрщика. Если CLI, сборка или браузер недоступны либо не поддерживаются, сообщите ограничение и при возможности покажите выбранные Markdown-документы или результаты графа. Не загружайте удалённый просмотрщик, не отправляйте содержимое набора наружу и не утверждайте, что осмотрели локальный HTML, если этого не было. При прерывании проверьте наличие выходного файла и повторяйте экспорт только после решения вопроса замены. Чтение и просмотр сохраняют файлы знаний побайтно.

Завершение: укажите набор, версию, профиль, as-of, выходной путь, решение о замене, результат экспорта и реально выполненные проверки браузера. Ошибочный или неосмотренный результат обозначайте соответственно.

Запрос Действия Что показать
«Покажи набор документов как автономный HTML». Экспортировать в новый /tmp/knowledge-viewer.html, открыть локальный файл, проверить список и сведения о понятии. Путь к HTML и наблюдаемое состояние навигации и источников.
«Пересобери существующий просмотрщик после правки». Проверить разрешение на замену, использовать --overwrite, осмотреть новый файл. Путь обновлённого файла и результат визуальной проверки; без утверждения, что сведения стали проверенными.
«Покажи актуальность на точный момент». Выбрать профиль точного времени, задать --as-of с датой, временем и смещением, осмотреть обозначения. Выбранный момент и наблюдаемые обозначения; без определения времени по часам браузера.

Запасной путь поддержания знаний

Если установлен отдельный навык okf-maintain, используйте его. Этот запасной путь нужен приложению, в котором есть только данный навык и средство проверки репозитория. Поддержание знаний — необязательная политика репозитория вне соответствия OKF: сохраните okf-upkeep baseline до изменения кода, прочитайте только относящиеся к задаче понятия, сравните их утверждения с текущим кодом и контрактом, затем обновите затронутые документы либо запишите конкретную причину отсутствия влияния. После последней правки запустите okf-upkeep check и привяжите решение к текущему отпечатку. Команды и JSON-формы решения описаны в docs/knowledge-upkeep.md репозитория либо в контрактах установленного средства проверки. Правка журнала, успешная проверка формата или старый отпечаток не доказывают проведённого анализа. Если исходное состояние не сохранено, сообщите об этом и вручную разберите произошедшие изменения; не заявляйте о завершении, подтверждённом отпечатком.