BF explanation-docs
Шаблоны объяснительной документации для контента, ориентированного на понимание — концептуальные руководства, объясняющие, почему что-то работает так, а не иначе. Используйте при написании объяснительной документации, концептуального руководства, документации по пониманию/фону, обоснования дизайна или объяснения архитектуры, или когда вас спрашивают, как/почему что-то работает. Основано на основных принципах написания документации.
машинный переводПоказать оригиналСкрыть оригинал«Explanation documentation patterns for understanding-oriented content…»
Explanation documentation patterns for understanding-oriented content - conceptual guides that explain why things work the way they do. Use when writing an explanation doc, conceptual guide, understanding/background doc, design rationale, or architecture explanation, or when asked how/why something works. Builds on the docs-style core writing principles.
Шаблоны объяснительной документации для контента, ориентированного на понимание — концептуальные руководства, объясняющие, почему что-то работает так, а не…
Как процесс F 37/100 · Не запустится — Скилл ссылается на файлы, которых нет в архиве: ../docs-style/references/diataxis-compass.md, /concepts/related-1, /concepts/related-2
Как улучшить
- В тексте есть ссылки на отсутствующие файлы: добавьте файлы или уберите ссылки.
- Свои кейсы (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ссылка на отсутствующий файл: /concepts/related-1 - предупреждение
missing-refссылка на отсутствующий файл: /concepts/related-2 - предупреждение
missing-refссылка на отсутствующий файл: /reference/detail - предупреждение
missing-refссылка на отсутствующий файл: /concepts/cqrs-architecture - предупреждение
missing-refссылка на отсутствующий файл: /concepts/api-gateway - предупреждение
missing-refссылка на отсутствующий файл: /concepts/token-security - предупреждение
missing-refссылка на отсутствующий файл: /reference/auth-api - предупреждение
missing-refссылка на отсутствующий файл: ../docs-style/SKILL.md - предупреждение
missing-refссылка на отсутствующий файл: ../howto-docs/SKILL.md - предупреждение
missing-refссылка на отсутствующий файл: ../reference-docs/SKILL.md - предупреждение
missing-refссылка на отсутствующий файл: ../tutorial-docs/SKILL.md
Процессный рейтинг: все десять параметров 37/100
- 0Инструменты и файлы. Не хватает 12 файла(ов): ../docs-style/references/diataxis-compass.md, /concepts/related-1, /concepts/related-2
- 0Результат и критерий готовности. Не сказано, что считать результатом
- 0Входы и предусловия. Не сказано, что нужно иметь на входе
- 0Отчётность по ходу. Скилл ничего не сообщает по ходу работы
- 20Когда включается. Не сказано, при каком запросе скилл включается
- 30Повторный запуск. Изменяющих операций: 1, без проверки текущего состояния
- 60Ошибки и развилки. Развилок: 2
- 70Стоимость исполнения. Тело инструкции 4605 токенов
- 100Шаги. Шагов: 40
- 100Согласованность. Имя и обязательные поля на месте
Всё перечисленное измерено по тексту скилла, а не оценено моделью: цифры проверяемы. Вес параметра тем больше, чем чаще из-за него процесс встаёт.
Сигналы качества
- +5В description нет примеров фраз, по которым скилл должен срабатывать
- +4Описание не говорит, когда скилл НЕ применять (ложные срабатывания)
- +3Формат ответа не описан: модель каждый раз решает сама
- +1Лицензия не указана
- +2Инструкции на одном языке
- +3Длина description 356 символов: достаточно сигнала, не съедает бюджет
- +4Структура: 24 заголовков
- +3Пошаговые инструкции: 40 пунктов
- +4Есть примеры (11 блоков кода)
База качества 70; замечания lint вычитаются, сигналы прибавляют до 100. Итог: 72.