Навыки Reference Builder
📦

Reference Builder

Безопасно

Генерация комплексной API и технической документации

Создание исчерпывающей технической документации вручную требует много времени и подвержено ошибкам. Этот навык автоматизирует генерацию полных справочных материалов с согласованным форматированием и тщательным охватом параметров.

Поддерживает: Claude Codex Code(CC)
📊 69 Адекватно
1

Скачать ZIP навыка

2

Загрузить в Claude

Перейдите в Settings → Capabilities → Skills → Upload skill

3

Включите и начните использовать

Протестировать

Использование «Reference Builder». Задокументировать REST API endpoint: POST /api/users с параметрами: name (string, required), email (string, required), age (integer, optional)

Ожидаемый результат:

  • ### POST /api/users
  •  
  • **Описание**: Создаёт новую учётную запись пользователя в системе.
  •  
  • **Параметры**:
  • - `name` (string, required): Полное имя пользователя, 2-100 символов
  • - `email` (string, required): Валидный email адрес, должен быть уникальным
  • - `age` (integer, optional): Возраст пользователя в годах, 18-120
  •  
  • **Возвращает**: Объект пользователя с id, name, email, created_at
  •  
  • **Ошибки**: 400 (валидация), 409 (дубликат email), 500 (ошибка сервера)
  •  
  • **Пример**:
  • POST /api/users
  • {"name": "Jane Doe", "email": "jane@example.com", "age": 30}

Использование «Reference Builder». Задокументировать схему базы данных User с полями: id, username, email, created_at, status

Ожидаемый результат:

  • ### Схема User
  •  
  • | Поле | Тип | Ограничения | Описание |
  • |-------|------|-------------|-------------|
  • | id | UUID | PRIMARY KEY | Уникальный идентификатор |
  • | username | VARCHAR(50) | NOT NULL, UNIQUE | Отображаемое имя пользователя |
  • | email | VARCHAR(255) | NOT NULL, UNIQUE | Контактный email адрес |
  • | created_at | TIMESTAMP | NOT NULL, DEFAULT NOW() | Время создания учётной записи |
  • | status | ENUM | NOT NULL, DEFAULT 'active' | Статус учётной записи: active, suspended, deleted |
  •  
  • **Индексы**: username_idx, email_idx, status_idx
  •  
  • **Связи**: Один-ко-многим с Posts, Один-к-одному с Profile

Аудит безопасности

Безопасно
v1 • 2/24/2026

This is a prompt-only skill containing no executable code. Static analysis scanned 0 files with 0 lines of code and detected no security patterns. The skill consists entirely of documentation instructions and prompt templates for creating technical references.

0
Просканировано файлов
0
Проанализировано строк
0
находки
1
Всего аудитов
Проблем безопасности не найдено
Проверено: claude

Оценка качества

38
Архитектура
100
Сопровождаемость
87
Контент
31
Сообщество
100
Безопасность
74
Соответствие спецификации

Что вы можете построить

Генерация API Reference

Создание комплексной API документации для внутренних или публичных API с полными списками параметров, типами возвращаемых значений, кодами ошибок и примерами использования.

Документация конфигурации

Генерация подробных руководств по конфигурации для сложных приложений, документируя все настройки, значения по умолчанию, ограничения и значения для конкретных окружений.

Документация SDK

Создание исчерпывающих справочных материалов по SDK, включая иерархии классов, сигнатуры методов, определения типов и примеры интеграции.

Попробуйте эти промпты

Базовая документация метода API 
Задокументируйте следующую API конечную точку как полную справочную запись. Включите сигнатуру метода, все параметры с типами и ограничениями, возвращаемые значения, возможные ошибки и базовый пример использования:

Endpoint: [METHOD] [URL]
Parameters: [list parameters]
Context: [describe what it does]
Справочник параметров конфигурации 
Создайте комплексную справочную таблицу конфигурации для следующих настроек. Для каждого параметра документируйте тип, значение по умолчанию, допустимый диапазон, является ли он обязательным, имя переменной окружения и любые зависимости от других настроек:

[Provide list of configuration parameters]
Документация схемы с примерами 
Сгенерируйте полную документацию схемы для следующей модели данных. Включите типы полей, правила валидации, ограничения, связи с другими моделями, информацию об индексации и предоставьте три примера: минимальную валидную запись, полностью заполненную запись и граничный случай:

[Provide schema definition]
Полное справочное руководство по модулю 
Создайте полный технический справочник для следующего модуля. Структурируйте его следующим образом: 1) Раздел обзора, объясняющий назначение, 2) Таблица быстрого справочника всех публичных методов, 3) Подробные записи для каждого метода с сигнатурами, параметрами, типами возвращаемых значений, ошибками и примерами, 4) Перекрёстные ссылки между связанными методами, 5) Рекомендации по производительности и 6) Распространённые ошибки, которых следует избегать:

[Provide module source code or interface definition]

Лучшие практики

  • Документируйте поведение и намерения, а не детали реализации — фокусируйтесь на том, что делает код, а не как
  • Включайте примеры как успешного выполнения, так и сценариев обработки ошибок для полного охвата
  • Используйте согласованную терминологию во всей документации — создайте и следуйте глоссарию

Избегать

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

Часто задаваемые вопросы

Какие типы документации может генерировать этот навык?
Этот навык генерирует API reference, руководства по конфигурации, документацию схем, руководства по устранению неполадок, руководства по миграции и полные справочники по модулям. Он охватывает любую техническую документацию, требующую исчерпывающих списков параметров и структурированного форматирования.
Нужно ли мне предоставлять исходный код для документирования?
Да, этот навык требует, чтобы вы предоставили исходный код, спецификации API или определения схем, которые нужно задокументировать. Он не может автоматически извлекать документацию из вашей кодовой базы — вы должны предоставить материалы для документирования.
Насколько точна сгенерированная документация?
Точность документации зависит от полноты ваших исходных материалов. Всегда проверяйте сгенерированную документацию против фактических реализаций, особенно для критических API или руководств по конфигурации, используемых в продакшене.
Может ли этот навык документировать несколько языков программирования?
Да, навык не зависит от языка и может документировать API, конфигурации и схемы независимо от языка программирования. Он фокусируется на документации интерфейсов, а не на специфичных для языка деталях реализации.
Поддерживает ли этот навык спецификации OpenAPI или Swagger?
Навык может использовать спецификации OpenAPI как исходный материал и может генерировать документацию в формате, совместимом с соглашениями OpenAPI. Однако он не автоматически парсит файлы OpenAPI — вы должны предоставить соответствующие детали спецификации.
Как мне обрабатывать документацию для устаревших функций?
Включите раздел Deprecated для каждой устаревшей функции, указывая версию, когда она была объявлена устаревшей, рекомендуемую альтернативу и график миграции. Навык отформатирует их согласно стандартному формату записи с чёткими рекомендациями по миграции.

Сведения для разработчиков

Автор

sickn33

Лицензия

MIT

Репозиторий

https://github.com/sickn33/antigravity-awesome-skills/tree/main/skills/reference-builder

Ссылка

main

Структура файлов

📄 SKILL.md