SKILLEMALL.ai
GitHub ↗ EN Войти

AB api-docs-writer

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

машинный переводПоказать оригиналСкрыть оригинал«Write clear, developer-facing API documentation. Use when asked to doc…»

Write clear, developer-facing API documentation. Use when asked to document an API endpoint, write API reference docs, create a developer guide, or turn a raw spec/Postman collection into documentation. Produces endpoint documentation with descriptions, parameters, request/response examples, and error codes.

ClawHub Agent Skills автор: mohitagw15856 v1.0.0 MIT-0 2 файла тело ≈ 1 665 токенов Открыть источникclawhub.ai↗ проанализирован 14 ч назад

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

Как процесс B 66/100 · Почти готов — слабые места: повторный запуск, отчётность по ходу

ИнтеграцияРазработкаТексты и документытип и темы размечены автоматически по тексту скилла
Запускается в: OpenClaw 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) Goose OpenCode
JSON
Технический рейтинг
A
94/100
безопасность, качество, тесты
Безопасность 60%
100
Качество 40%
86
Прогон на моделях
не было
Процессный рейтинг
B
66/100
Почти готов
Отчётность по ходу вес 2
0
Повторный запуск вес 4
30
Когда включается вес 12
50
три самых слабых из десяти параметров · все десять

Как улучшить

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

    Находки guard · 0

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

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

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

    • заметка frontmatter-key неизвестное поле фронтматтера "homepage"
    • заметка edit-residue в тексте есть пометки об устаревшем (строки 138): проверьте, не остались ли старые правила рядом с новыми — полная проверка читает текст на противоречия

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

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

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

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

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

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

    Внешние проверки

    ClawHub: clean
    This skill only guides the assistant to write API documentation from user-provided API details and shows no hidden installation, persistence, or data-sharing behavior.
    LLM: benign (high) · VirusTotal: · 16 июл. 2026 г.