BF API-design-doc
Инструмент для генерации документации API в стандартизированном формате. На основе входных данных, таких как документ с требованиями, DDL базы данных и т. д., выполняется стандартизированное и нормализованное проектирование API с выводом полного документа с описанием интерфейса API, включая спецификацию кодов ошибок, формат интерфейса, определение входных и выходных параметров, примеры JSON и т. д., что направляет последующую разработку кода и отладку между фронтендом и бэкендом. Сценарии использования включают: (1) проектирование интерфейсов RESTful API на основе бизнес-требований, (2) генерация соответствующей документации интерфейсов CRUD на основе DDL базы данных, (3) стандартизация существующей документации интерфейсов API, (4) предоставление стандартизированной документации спецификаций интерфейсов для отладки между фронтендом и бэкендом.
машинный переводПоказать оригиналСкрыть оригинал«标准化API接口设计文档生成工具。根据需求文档、数据库DDL等输入，进行API的标准化、规范化设计，输出完整的API接口设计文档，包括错误码…»
标准化API接口设计文档生成工具。根据需求文档、数据库DDL等输入，进行API的标准化、规范化设计，输出完整的API接口设计文档，包括错误码规范、接口格式规范、入参出参定义、JSON示例等，指导后续的代码开发和前后端联调。使用场景包括：(1) 根据业务需求设计RESTful API接口，(2) 基于数据库DDL生成对应的CRUD接口文档，(3) 规范化现有API接口文档，(4) 为前后端联调提供标准化的接口规范文档
Инструмент для генерации документации API в стандартизированном формате.
Как процесс F 33/100 · Не запустится — Скилл ссылается на файлы, которых нет в архиве: assets/templates/api-doc-template.md
Как улучшить
- Скажите в description, КОГДА применять скилл («используй, когда…», примеры запросов): это главный сигнал для агента.
- В тексте есть ссылки на отсутствующие файлы: добавьте файлы или уберите ссылки.
- Свои кейсы (evals/evals.json, 4–6 реальных запросов с ожидаемыми ответами): тогда полная проверка прогонит именно их, а не черновик от модели.
- spec.yaml с триггерными фразами и утверждениями — контракт поведения для CI; `skilltest init` создаст шаблон.
Находки guard · 0
✓ Критических и высоких находок нет
Просканировано файлов: 7. Улики замаскированы. Пометки в серых чипах объясняют, почему серьёзность понижена.
По спецификации Agent Skills
- предупреждение
name-formatname должен быть в kebab-case (строчные буквы, цифры, дефисы) - предупреждение
description-no-whendescription не говорит, КОГДА применять скилл (нет "use when / используй когда") - предупреждение
missing-refссылка на отсутствующий файл: assets/templates/api-doc-template.md
Процессный рейтинг: все десять параметров 33/100
- 0Инструменты и файлы. Не хватает 1 файла(ов): assets/templates/api-doc-template.md
- 0Результат и критерий готовности. Не сказано, что считать результатом
- 0Входы и предусловия. Не сказано, что нужно иметь на входе
- 0Ошибки и развилки. Линейный процесс без обработки сбоев
- 0Отчётность по ходу. Скилл ничего не сообщает по ходу работы
- 20Когда включается. Не сказано, при каком запросе скилл включается
- 30Повторный запуск. Изменяющих операций: 3, без проверки текущего состояния
- 100Шаги. Шагов: 47
- 100Согласованность. Имя и обязательные поля на месте
- 100Стоимость исполнения. Тело инструкции 512 токенов
Всё перечисленное измерено по тексту скилла, а не оценено моделью: цифры проверяемы. Вес параметра тем больше, чем чаще из-за него процесс встаёт.
Сигналы качества
- +5В description нет примеров фраз, по которым скилл должен срабатывать
- +4Описание не говорит, когда скилл НЕ применять (ложные срабатывания)
- +3Формат ответа не описан: модель каждый раз решает сама
- +4Нет примеров входа/выхода
- +1Лицензия не указана
- +2Инструкции на одном языке
- +3Длина description 209 символов: достаточно сигнала, не съедает бюджет
- +4Структура: 13 заголовков
- +3Пошаговые инструкции: 47 пунктов
- +4Справочные файлы упоминаются в инструкциях (4 из 4)
База качества 70; замечания lint вычитаются, сигналы прибавляют до 100. Итог: 61.