AF contract-doc-sync
Инструмент синхронизации документации — обнаруживает расхождения между кодом и документацией и синхронно исправляет их. Читает и записывает только локальные Markdown-файлы в папке docs/, запускает только локальные скрипты (git diff, md-sections). Исходные файлы только для чтения, без сетевых запросов, без операций шифрования, без функций оплаты/покупки, без удаленной загрузки. Требуется: python3, git, bash. Белый список записи: docs/modules/*.md, docs/architecture/*.md, docs/conventions/*.md. Сценарии срабатывания: (1) Пользователь говорит «синхронизировать документацию», «синхронизация документации», «sync docs» (2) Пользователь говорит «проверить расхождения», «обнаружение расхождений», «L0» (3) Пользователь говорит «быстрая синхронизация», «L1» (4) Пользователь говорит «глубокая синхронизация», «L3» (5) После завершения кодирования функций настоятельно рекомендуется выполнить синхронизацию документации, чтобы обеспечить ее соответствие коду. (6) Перед отправкой PR / слиянием ветвей рекомендуется выполнить быструю синхронизацию L1. (7) Перед выпуском рекомендуется выполнить глубокую синхронизацию L3 для проверки согласованности документации. (8) После масштабной рефакторинга (изменение сигнатур API, корректировка полей сущностей, разделение модулей и т. д.) документация, скорее всего, будет иметь расхождения. (9) После изменения кода контроллера/сервиса/сущности/конфигурации и т. д. соответствующая документация может потребовать обновления. (10) Любые сценарии, связанные с выравниванием каталога docs/ и кода. По умолчанию используется L2 (обычная синхронизация), если уровень не указан. Английские триггеры: "sync docs", "doc sync", "check drift", "documentation alignment", "drift detection", "docs out of date", "update docs after coding".
машинный переводПоказать оригиналСкрыть оригинал«文档同步工具——检测代码-文档漂移并同步修复。仅读写本地 docs/ 下 Markdown 文件,仅运行本地脚本(git diff、md-s…»
文档同步工具——检测代码-文档漂移并同步修复。仅读写本地 docs/ 下 Markdown 文件,仅运行本地脚本(git diff、md-sections)。 源码文件只读,无网络请求,无加密操作,无支付/购买功能,无远程下载。 需要: python3, git, bash。 写入范围白名单: docs/modules/*.md, docs/architecture/*.md, docs/conventions/*.md。 触发场景: (1) 用户说"同步文档"、"文档同步"、"sync docs" (2) 用户说"检查漂移"、"漂移检测"、"L0" (3) 用户说"快速同步"、"L1" (4) 用户说"深度同步"、"L3" (5) 功能编码完成后,强烈建议执行一次文档同步,确保文档与代码一致 (6) 提交 PR / 合并分支前,建议至少执行 L1 快速同步 (7) 发布前文档一致性检查,建议执行 L3 深度同步 (8) 大规模重构后(API 签名变更、实体字段调整、模块拆分等),文档大概率已漂移 (9) 修改了 controller/service/entity/config 等代码后,对应文档可能需要更新 (10) 任何涉及 docs/ 目录与代码对齐的场景。 未指定级别时默认使用 L2(常用同步)。 English triggers: "sync docs", "doc sync", "check drift", "documentation alignment", "drift detection", "docs out of date", "update docs after coding"
Инструмент синхронизации документации — обнаруживает расхождения между кодом и документацией и синхронно исправляет их.
Как процесс F 37/100 · Не запустится — Скилл ссылается на файлы, которых нет в архиве: references/*.md
Как улучшить
- Скажите в description, КОГДА применять скилл («используй, когда…», примеры запросов): это главный сигнал для агента.
- В тексте есть ссылки на отсутствующие файлы: добавьте файлы или уберите ссылки.
- Свои кейсы (evals/evals.json, 4–6 реальных запросов с ожидаемыми ответами): тогда полная проверка прогонит именно их, а не черновик от модели.
- spec.yaml с триггерными фразами и утверждениями — контракт поведения для CI; `skilltest init` создаст шаблон.
Находки guard · 0
✓ Критических и высоких находок нет
Просканировано файлов: 7. Улики замаскированы. Пометки в серых чипах объясняют, почему серьёзность понижена.
По спецификации Agent Skills
- предупреждение
description-no-whendescription не говорит, КОГДА применять скилл (нет "use when / используй когда") - предупреждение
missing-refссылка на отсутствующий файл: references/*.md
Процессный рейтинг: все десять параметров 37/100
- 0Инструменты и файлы. Не хватает 1 файла(ов): references/*.md
- 0Результат и критерий готовности. Не сказано, что считать результатом
- 0Входы и предусловия. Не сказано, что нужно иметь на входе
- 0Ошибки и развилки. Линейный процесс без обработки сбоев
- 20Когда включается. Не сказано, при каком запросе скилл включается
- 100Шаги. Шагов: 37
- 100Согласованность. Имя и обязательные поля на месте
- 100Стоимость исполнения. Тело инструкции 2264 токенов
- 100Повторный запуск. Изменяющих операций нет
- 100Отчётность по ходу. Скилл сообщает о ходе работы
- medium Правила безопасности и запреты внутри скилла: их место в системном промпте, здесь они не защищают
- low Разделов верхнего уровня: 13. Похоже на несколько доменов в одном скилле
Всё перечисленное измерено по тексту скилла, а не оценено моделью: цифры проверяемы. Вес параметра тем больше, чем чаще из-за него процесс встаёт.
Сигналы качества
- +4Описание не говорит, когда скилл НЕ применять (ложные срабатывания)
- +3Формат ответа не описан: модель каждый раз решает сама
- -233 эмодзи в инструкциях: шум для модели
- +1Лицензия не указана
- +2Инструкции на одном языке
- +5В description 8 примера фраз-триггеров в кавычках
- +3Длина description 712 символов: достаточно сигнала, не съедает бюджет
- +4Структура: 34 заголовков
- +3Пошаговые инструкции: 37 пунктов
- +4Есть примеры (4 блоков кода)
- +4Справочные файлы упоминаются в инструкциях (3 из 3)
- +3Все 2 скриптов описаны в инструкциях
База качества 70; замечания lint вычитаются, сигналы прибавляют до 100. Итог: 76.