BF howto-docs
Шаблоны руководств «Как сделать» для документации — руководства, ориентированные на задачи пользователей с конкретными целями. Используйте при написании руководства «Как сделать», руководства по задачам, процедурного руководства, пошагового руководства или документации «Как сделать». Основано на основных принципах написания документации.
машинный переводПоказать оригиналСкрыть оригинал«How-To guide patterns for documentation - task-oriented guides for use…»
How-To guide patterns for documentation - task-oriented guides for users with specific goals. Use when writing a how-to/howto guide, task guide, procedural guide, step-by-step guide, or how-to documentation. Builds on the docs-style core writing principles.
Шаблоны руководств «Как сделать» для документации — руководства, ориентированные на задачи пользователей с конкретными целями.
Как процесс F 47/100 · Не запустится — Скилл ссылается на файлы, которых нет в архиве: ../docs-style/references/diataxis-compass.md, /getting-started, /getting-started/auth
Как улучшить
- В тексте есть ссылки на отсутствующие файлы: добавьте файлы или уберите ссылки.
- Свои кейсы (evals/evals.json, 4–6 реальных запросов с ожидаемыми ответами): тогда полная проверка прогонит именно их, а не черновик от модели.
- spec.yaml с триггерными фразами и утверждениями — контракт поведения для CI; `skilltest init` создаст шаблон.
Находки guard · 0
✓ Критических и высоких находок нет
Просканировано файлов: 2. Улики замаскированы. Пометки в серых чипах объясняют, почему серьёзность понижена.
По спецификации Agent Skills
- предупреждение
missing-refссылка на отсутствующий файл: ../docs-style/references/diataxis-compass.md - предупреждение
missing-refссылка на отсутствующий файл: /getting-started - предупреждение
missing-refссылка на отсутствующий файл: /getting-started/auth - предупреждение
missing-refссылка на отсутствующий файл: /reference/webhook-signatures - предупреждение
missing-refссылка на отсутствующий файл: /how-to/verify-webhook-signatures - предупреждение
missing-refссылка на отсутствующий файл: /reference/webhook-events - предупреждение
missing-refссылка на отсутствующий файл: /how-to/webhook-retry-handling - предупреждение
missing-refссылка на отсутствующий файл: ../docs-style/SKILL.md - предупреждение
missing-refссылка на отсутствующий файл: ../tutorial-docs/SKILL.md - предупреждение
missing-refссылка на отсутствующий файл: ../reference-docs/SKILL.md - предупреждение
missing-refссылка на отсутствующий файл: ../explanation-docs/SKILL.md
Процессный рейтинг: все десять параметров 47/100
- 0Инструменты и файлы. Не хватает 11 файла(ов): ../docs-style/references/diataxis-compass.md, /getting-started, /getting-started/auth
- 0Результат и критерий готовности. Не сказано, что считать результатом
- 20Когда включается. Не сказано, при каком запросе скилл включается
- 30Повторный запуск. Изменяющих операций: 8, без проверки текущего состояния
- 65Ошибки и развилки. Развилок: 3
- 70Входы и предусловия. Входные данные и предусловия перечислены
- 85Шаги. Шагов: 39, расплывчатых формулировок: 1
- 100Согласованность. Имя и обязательные поля на месте
- 100Стоимость исполнения. Тело инструкции 2788 токенов
- 100Отчётность по ходу. Скилл сообщает о ходе работы
Всё перечисленное измерено по тексту скилла, а не оценено моделью: цифры проверяемы. Вес параметра тем больше, чем чаще из-за него процесс встаёт.
Сигналы качества
- +5В description нет примеров фраз, по которым скилл должен срабатывать
- +4Описание не говорит, когда скилл НЕ применять (ложные срабатывания)
- +3Формат ответа не описан: модель каждый раз решает сама
- +1Лицензия не указана
- +2Инструкции на одном языке
- +3Длина description 257 символов: достаточно сигнала, не съедает бюджет
- +4Структура: 22 заголовков
- +3Пошаговые инструкции: 39 пунктов
- +4Есть примеры (14 блоков кода)
База качества 70; замечания lint вычитаются, сигналы прибавляют до 100. Итог: 72.