BD writing-reference-docs
Как написать раздел справки по функциям/хукам/действиям, а также как написать или переработать весь набор многостраничной документации приложения (Обзор/Функции/Разговор с агентом/Использование в нескольких приложениях/Руководство разработчика): подпись простым языком, реальные аргументы, эскалация примеров, основанных на реальном приложении, проверенное поведение агента, сокращенный текст без тире или точек с запятой. Используйте при написании или редактировании страницы справки packages/core/docs/content или при переработке набора документации template-<app>*.mdx.
машинный переводПоказать оригиналСкрыть оригинал«How to write a function/hook/action reference section, and how to writ…»
How to write a function/hook/action reference section, and how to write or rework a whole app's multi-page doc set (Overview/Features/Talk to the Agent/Cross-App Use/Developer Guide): plain-language signature, real arguments, escalating examples grounded in a real app, verified agent behavior, trimmed prose with no em dashes or semicolons. Use when writing or editing a packages/core/docs/content reference page, or reworking a template-<app>*.mdx doc set.
Как написать раздел справки по функциям/хукам/действиям, а также как написать или переработать весь набор многостраничной документации приложения…
Как процесс D 46/100 · Процесс не доведён — Скилл ссылается на файлы, которых нет в архиве: ..., scripts/i18n-no-translate-terms.txt
Как улучшить
- В тексте есть ссылки на отсутствующие файлы: добавьте файлы или уберите ссылки.
- Свои кейсы (evals/evals.json, 4–6 реальных запросов с ожидаемыми ответами): тогда полная проверка прогонит именно их, а не черновик от модели.
- spec.yaml с триггерными фразами и утверждениями — контракт поведения для CI; `skilltest init` создаст шаблон.
Находки guard · 0
✓ Критических и высоких находок нет
Просканировано файлов: 1. Улики замаскированы. Пометки в серых чипах объясняют, почему серьёзность понижена.
По спецификации Agent Skills
- предупреждение
missing-refссылка на отсутствующий файл: ... - предупреждение
missing-refссылка на отсутствующий файл: scripts/i18n-no-translate-terms.txt - заметка
frontmatter-keyнеизвестное поле фронтматтера "scope"
Процессный рейтинг: все десять параметров 46/100
- 0Инструменты и файлы. Не хватает 2 файла(ов): ..., scripts/i18n-no-translate-terms.txt
- 0Результат и критерий готовности. Не сказано, что считать результатом
- 0Отчётность по ходу. Скилл ничего не сообщает по ходу работы
- 20Когда включается. Не сказано, при каком запросе скилл включается
- 30Повторный запуск. Изменяющих операций: 8, без проверки текущего состояния
- 55Ошибки и развилки. Развилок: 1
- 70Входы и предусловия. Входные данные и предусловия перечислены
- 100Шаги. Шагов: 27
- 100Согласованность. Имя и обязательные поля на месте
- 100Стоимость исполнения. Тело инструкции 3369 токенов
- low Разделов верхнего уровня: 10. Похоже на несколько доменов в одном скилле
- low Ответ описан самодельной разметкой (4 тегов): типизированный вызов надёжнее
Всё перечисленное измерено по тексту скилла, а не оценено моделью: цифры проверяемы. Вес параметра тем больше, чем чаще из-за него процесс встаёт.
Сигналы качества
- +5В description нет примеров фраз, по которым скилл должен срабатывать
- +4Описание не говорит, когда скилл НЕ применять (ложные срабатывания)
- +3Формат ответа не описан: модель каждый раз решает сама
- +1Лицензия не указана
- +2Инструкции на одном языке
- +3Длина description 458 символов: достаточно сигнала, не съедает бюджет
- +4Структура: 15 заголовков
- +3Пошаговые инструкции: 27 пунктов
- +4Есть примеры (1 блоков кода)
База качества 70; замечания lint вычитаются, сигналы прибавляют до 100. Итог: 74.