AF tutorial-docs
Шаблоны руководств для документации — обучающие руководства, которые учат через практическое выполнение. Используйте при написании руководства, учебного пособия, руководства по началу работы или онбордингу, руководства для начинающих/вводного руководства или любого практического руководства «учись, делая». Основано на основных принципах написания документации.
машинный переводПоказать оригиналСкрыть оригинал«Tutorial patterns for documentation - learning-oriented guides that te…»
Tutorial patterns for documentation - learning-oriented guides that teach through guided doing. Use when writing a tutorial, learning guide, getting-started or onboarding guide, beginner/introductory guide, or any learn-by-doing hands-on guide. Builds on the docs-style core writing principles.
Шаблоны руководств для документации — обучающие руководства, которые учат через практическое выполнение.
Как процесс F 46/100 · Не запустится — Скилл ссылается на файлы, которых нет в архиве: ../docs-style/references/diataxis-compass.md, /images/tutorial-dashboard.png, ../docs-style/SKILL.md
Как улучшить
- В тексте есть ссылки на отсутствующие файлы: добавьте файлы или уберите ссылки.
- Свои кейсы (evals/evals.json, 4–6 реальных запросов с ожидаемыми ответами): тогда полная проверка прогонит именно их, а не черновик от модели.
- spec.yaml с триггерными фразами и утверждениями — контракт поведения для CI; `skilltest init` создаст шаблон.
Находки guard · 0
✓ Критических и высоких находок нет
Просканировано файлов: 3. Улики замаскированы. Пометки в серых чипах объясняют, почему серьёзность понижена.
По спецификации Agent Skills
- предупреждение
missing-refссылка на отсутствующий файл: ../docs-style/references/diataxis-compass.md - предупреждение
missing-refссылка на отсутствующий файл: /images/tutorial-dashboard.png - предупреждение
missing-refссылка на отсутствующий файл: ../docs-style/SKILL.md - предупреждение
missing-refссылка на отсутствующий файл: ../howto-docs/SKILL.md - предупреждение
missing-refссылка на отсутствующий файл: ../reference-docs/SKILL.md - предупреждение
missing-refссылка на отсутствующий файл: ../explanation-docs/SKILL.md
Процессный рейтинг: все десять параметров 46/100
- 0Инструменты и файлы. Не хватает 6 файла(ов): ../docs-style/references/diataxis-compass.md, /images/tutorial-dashboard.png, ../docs-style/SKILL.md
- 0Результат и критерий готовности. Не сказано, что считать результатом
- 0Отчётность по ходу. Скилл ничего не сообщает по ходу работы
- 20Когда включается. Не сказано, при каком запросе скилл включается
- 30Повторный запуск. Изменяющих операций: 8, без проверки текущего состояния
- 55Ошибки и развилки. Развилок: 1
- 70Входы и предусловия. Входные данные и предусловия перечислены
- 100Шаги. Шагов: 34
- 100Согласованность. Имя и обязательные поля на месте
- 100Стоимость исполнения. Тело инструкции 2841 токенов
- low Разделов верхнего уровня: 10. Похоже на несколько доменов в одном скилле
Всё перечисленное измерено по тексту скилла, а не оценено моделью: цифры проверяемы. Вес параметра тем больше, чем чаще из-за него процесс встаёт.
Сигналы качества
- +5В description нет примеров фраз, по которым скилл должен срабатывать
- +4Описание не говорит, когда скилл НЕ применять (ложные срабатывания)
- +3Формат ответа не описан: модель каждый раз решает сама
- -2Ссылки на localhost: у другого пользователя не заработает
- +1Лицензия не указана
- +2Инструкции на одном языке
- +3Длина description 294 символов: достаточно сигнала, не съедает бюджет
- +4Структура: 27 заголовков
- +3Пошаговые инструкции: 34 пунктов
- +4Есть примеры (18 блоков кода)
- +4Справочные файлы упоминаются в инструкциях (1 из 1)
База качества 70; замечания lint вычитаются, сигналы прибавляют до 100. Итог: 74.