SKILLEMALL.ai
GitHub ↗ EN Войти

BC api-docs

Документируйте модуль или общедоступную поверхность API (функции, классы, команды CLI, конечные точки) из самого кода. Используйте, когда пользователь запрашивает справочник по API, документацию модуля или хочет написать документацию по использованию для общедоступного интерфейса.

машинный переводПоказать оригиналСкрыть оригинал«Document a module or public API surface (functions, classes, CLI comma…»

Document a module or public API surface (functions, classes, CLI commands, endpoints) from the code itself. Use when the user asks for API reference, to document a module, or to write usage docs for a public interface.

omnigent-ai/omnigent Agent Skills автор: omnigent-ai Apache-2.0 1 файл тело ≈ 435 токенов Открыть источникgithub.com↗ проанализирован 6 дн назад

Документируйте модуль или общедоступную поверхность API (функции, классы, команды CLI, конечные точки) из самого кода.

Как процесс C 59/100 · Есть пробелы — слабые места: результат и критерий готовности, входы и предусловия, ошибки и развилки

ИнтеграцияРазработкатип и темы размечены автоматически по тексту скилла
Запускается в: Claude / Claude Code ChatGPT / Codex Gemini CLI Cursor GitHub Copilot / VS Code Qwen Code Kimi Code CLI Z.ai (GLM) DeepSeek (Deep Code) Mistral Vibe LangChain (deepagents) OpenClaw Goose OpenCode
JSON
Технический рейтинг
B
94/100
безопасность, качество, тесты
Безопасность 60%
100
Качество 40%
84
Прогон на моделях
не было
Процессный рейтинг
C
59/100
Есть пробелы
Результат и критерий готовности вес 14
0
Входы и предусловия вес 11
0
Ошибки и развилки вес 10
0
три самых слабых из десяти параметров · все десять

Как улучшить

    Для прогона на моделях — необязательно
    • Свои кейсы (evals/evals.json, 4–6 реальных запросов с ожидаемыми ответами): тогда полная проверка прогонит именно их, а не черновик от модели.
    • spec.yaml с триггерными фразами и утверждениями — контракт поведения для CI; `skilltest init` создаст шаблон.

    Находки guard · 0

    ✓ Критических и высоких находок нет

    Просканировано файлов: 1. Улики замаскированы. Пометки в серых чипах объясняют, почему серьёзность понижена.

    По спецификации Agent Skills

    ✓ По спецификации Agent Skills замечаний нет

    Процессный рейтинг: все десять параметров 59/100

    • 0Результат и критерий готовности. Не сказано, что считать результатом
    • 0Входы и предусловия. Не сказано, что нужно иметь на входе
    • 0Ошибки и развилки. Линейный процесс без обработки сбоев
    • 0Отчётность по ходу. Скилл ничего не сообщает по ходу работы
    • 70Когда включается. Сказано, когда применять, но не сказано, когда не стоит
    • 100Инструменты и файлы. Внешние инструменты не нужны
    • 100Шаги. Шагов: 6
    • 100Согласованность. Имя и обязательные поля на месте
    • 100Стоимость исполнения. Тело инструкции 435 токенов
    • 100Повторный запуск. Изменяющих операций нет
    • low Ответ описан самодельной разметкой (11 тегов): типизированный вызов надёжнее

    Всё перечисленное измерено по тексту скилла, а не оценено моделью: цифры проверяемы. Вес параметра тем больше, чем чаще из-за него процесс встаёт.

    Сигналы качества

    • +5В description нет примеров фраз, по которым скилл должен срабатывать
    • +4Описание не говорит, когда скилл НЕ применять (ложные срабатывания)
    • +3Формат ответа не описан: модель каждый раз решает сама
    • +1Лицензия не указана
    • +2Инструкции на одном языке
    • +3Длина description 218 символов: достаточно сигнала, не съедает бюджет
    • +4Структура: 5 заголовков
    • +3Пошаговые инструкции: 6 пунктов
    • +4Есть примеры (1 блоков кода)

    База качества 70; замечания lint вычитаются, сигналы прибавляют до 100. Итог: 84.