BC API Design & Documentation Generator
AI-помощник для проектирования и документирования API — генерирует спецификации RESTful/OpenAPI, пишет подробную документацию по API (руководства, учебные пособия, справочники), создает mock-серверы, проверяет дизайны API и генерирует фрагменты кода SDK. Поддерживает OpenAPI 3.0/3.1, AsyncAPI, GraphQL SDL и основные языки программирования. Разработан для бэкенд-разработчиков, менеджеров API-продуктов, DevOps-инженеров и технических писателей, которым нужно быстрее проектировать, документировать и выпускать API.
машинный переводПоказать оригиналСкрыть оригинал«AI-powered API design and documentation assistant — generate RESTful/O…»
AI-powered API design and documentation assistant — generate RESTful/OpenAPI specs, write comprehensive API docs (guides, tutorials, reference), create mock servers, validate API designs, and produce SDK code snippets. Supports OpenAPI 3.0/3.1, AsyncAPI, GraphQL SDL, and major languages. Built for backend developers, API product managers, DevOps engineers, and technical writers who need to design, document, and ship APIs faster. Keywords: API documentation, OpenAPI spec, REST API design, API reference, developer portal, API guide, Swagger, AsyncAPI, GraphQL schema, API validation, mock server, SDK generation, API设计, 接口文档, OpenAPI, Swagger文档.
AI-помощник для проектирования и документирования API — генерирует спецификации RESTful/OpenAPI, пишет подробную документацию по API (руководства, учебные…
Как процесс C 60/100 · Есть пробелы — слабые места: когда включается, согласованность, повторный запуск
Как улучшить
- Скажите в description, КОГДА применять скилл («используй, когда…», примеры запросов): это главный сигнал для агента.
- Тело SKILL.md длиннее 5 000 токенов: вынесите справочные детали в references/ и подключайте по необходимости.
- Свои кейсы (evals/evals.json, 4–6 реальных запросов с ожидаемыми ответами): тогда полная проверка прогонит именно их, а не черновик от модели.
- spec.yaml с триггерными фразами и утверждениями — контракт поведения для CI; `skilltest init` создаст шаблон.
Находки guard · 0
✓ Критических и высоких находок нет
Просканировано файлов: 2. Улики замаскированы. Пометки в серых чипах объясняют, почему серьёзность понижена.
По спецификации Agent Skills
- предупреждение
name-formatname должен быть в kebab-case (строчные буквы, цифры, дефисы) - предупреждение
description-no-whendescription не говорит, КОГДА применять скилл (нет "use when / используй когда") - предупреждение
body-longтело SKILL.md ≈ 5069 токенов (рекомендуется < 5000); вынесите детали в references/
Процессный рейтинг: все десять параметров 60/100
- 20Когда включается. Не сказано, при каком запросе скилл включается
- 30Повторный запуск. Изменяющих операций: 11, без проверки текущего состояния
- 40Согласованность. Имя во frontmatter (API Design & Documentation Generator) не совпадает с папкой (api-design-documentation)
- 50Ошибки и развилки. Развилок: 0, есть раздел про ошибки
- 60Инструменты и файлы. Используются инструменты (bash, web, python), но во frontmatter они не объявлены
- 60Результат и критерий готовности. Формат результата описан, критерия завершения нет
- 70Входы и предусловия. Входные данные и предусловия перечислены
- 70Стоимость исполнения. Тело инструкции 5069 токенов
- 100Шаги. Шагов: 80
- 100Отчётность по ходу. Скилл сообщает о ходе работы
- low Разделов верхнего уровня: 14. Похоже на несколько доменов в одном скилле
- low Ответ описан самодельной разметкой (6 тегов): типизированный вызов надёжнее
Всё перечисленное измерено по тексту скилла, а не оценено моделью: цифры проверяемы. Вес параметра тем больше, чем чаще из-за него процесс встаёт.
Сигналы качества
- +5В description нет примеров фраз, по которым скилл должен срабатывать
- +4Описание не говорит, когда скилл НЕ применять (ложные срабатывания)
- +1Лицензия не указана
- +2Инструкции на одном языке
- +3Длина description 649 символов: достаточно сигнала, не съедает бюджет
- +4Структура: 30 заголовков
- +3Пошаговые инструкции: 80 пунктов
- +3Формат ответа описан явно
- +4Есть примеры (25 блоков кода)
База качества 70; замечания lint вычитаются, сигналы прибавляют до 100. Итог: 60.