SKILLEMALL.ai
GitHub ↗ EN Войти

BD api-docs-writer

Пишет понятную документацию API для разработчиков. Используйте, когда нужно документировать API endpoint, написать справочную документацию API, создать руководство для разработчиков или преобразовать необработанную спецификацию или коллекцию Postman в документацию. Создает документацию endpoint с описаниями, параметрами, примерами запросов/ответов и кодами ошибок.

машинный переводПоказать оригиналСкрыть оригинал«Escribe documentación clara de API orientada a desarrolladores. Úsalo…»

Escribe documentación clara de API orientada a desarrolladores. Úsalo cuando necesites documentar un endpoint de API, escribir documentos de referencia de API, crear una guía para desarrolladores o convertir una especificación bruta o colección de Postman en documentación. Produce documentación de endpoints con descripciones, parámetros, ejemplos de solicitud/respuesta y códigos de error.

mohitagw15856/pm-claude-skills Agent Skills автор: mohitagw15856 MIT 1 файл тело ≈ 1 496 токенов Открыть источникgithub.com↗ проанализирован 2 дн назад

Пишет понятную документацию API для разработчиков.

Как процесс D 46/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
87/100
безопасность, качество, тесты
Безопасность 60%
100
Качество 40%
67
Прогон на моделях
не было
Процессный рейтинг
D
46/100
Процесс не доведён
Результат и критерий готовности вес 14
0
Входы и предусловия вес 11
0
Отчётность по ходу вес 2
0
три самых слабых из десяти параметров · все десять

Как улучшить

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

Находки guard · 0

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

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

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

  • предупреждение description-no-when description не говорит, КОГДА применять скилл (нет "use when / используй когда")

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

  • 0Результат и критерий готовности. Не сказано, что считать результатом
  • 0Входы и предусловия. Не сказано, что нужно иметь на входе
  • 0Отчётность по ходу. Скилл ничего не сообщает по ходу работы
  • 20Когда включается. Не сказано, при каком запросе скилл включается
  • 30Повторный запуск. Изменяющих операций: 1, без проверки текущего состояния
  • 50Ошибки и развилки. Развилок: 0, есть раздел про ошибки
  • 60Инструменты и файлы. Используются инструменты (web), но во frontmatter они не объявлены
  • 85Шаги. Шагов: 24, расплывчатых формулировок: 1
  • 100Согласованность. Имя и обязательные поля на месте
  • 100Стоимость исполнения. Тело инструкции 1496 токенов

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

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

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

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