SKILLEMALL.ai
GitHub ↗ EN Войти

CC api-docs-writer

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

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

Escribe documentación clara y orientada a desarrolladores. Úsalo cuando se te pida documentar un endpoint de API, escribir docs de referencia de API, crear una guía de desarrollador, o convertir una especificación cruda o colección Postman en documentación. Produce documentación de endpoint con descripciones, parámetros, ejemplos de request/response y códigos de error.

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

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

Как процесс C 51/100 · Есть пробелы — Скилл ссылается на файлы, которых нет в архиве: references/example-first-docs.md, templates/endpoint-entry.md

ИнтеграцияРазработкатип и темы размечены автоматически по тексту скилла
Запускается в: 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
Технический рейтинг
C
84/100
безопасность, качество, тесты
Безопасность 60%
100
Качество 40%
61
Прогон на моделях
не было
Процессный рейтинг
C
51/100
Есть пробелы
Скилл ссылается на файлы, которых нет в архиве: references/example-first-docs.md, templates/endpoint-entry.md
Инструменты и файлы вес 18
0
Отчётность по ходу вес 2
0
Когда включается вес 12
20
три самых слабых из десяти параметров · все десять

Как улучшить

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

Находки guard · 0

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

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

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

  • предупреждение description-no-when description не говорит, КОГДА применять скилл (нет "use when / используй когда")
  • предупреждение missing-ref ссылка на отсутствующий файл: references/example-first-docs.md
  • предупреждение missing-ref ссылка на отсутствующий файл: templates/endpoint-entry.md

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

Не запустится. Скилл ссылается на файлы, которых нет в архиве: references/example-first-docs.md, templates/endpoint-entry.md
  • 0Инструменты и файлы. Не хватает 2 файла(ов): references/example-first-docs.md, templates/endpoint-entry.md
  • 0Отчётность по ходу. Скилл ничего не сообщает по ходу работы
  • 20Когда включается. Не сказано, при каком запросе скилл включается
  • 30Повторный запуск. Изменяющих операций: 1, без проверки текущего состояния
  • 50Ошибки и развилки. Развилок: 0, есть раздел про ошибки
  • 60Результат и критерий готовности. Формат результата описан, критерия завершения нет
  • 70Входы и предусловия. Входные данные и предусловия перечислены
  • 85Шаги. Шагов: 30, расплывчатых формулировок: 1
  • 100Согласованность. Имя и обязательные поля на месте
  • 100Стоимость исполнения. Тело инструкции 2041 токенов

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

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

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

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