technical-analysis
Анализируйте API, модели данных и системные интеграции
Технические системы требуют тщательной документации для обеспечения надежности, безопасности и поддерживаемости. Этот навык предоставляет структурированные шаблоны для анализа и документирования API, моделей данных, интеграций и требований безопасности с последовательным форматированием.
Скачать ZIP навыка
Загрузить в Claude
Перейдите в Settings → Capabilities → Skills → Upload skill
Включите и начните использовать
Протестировать
Использование «technical-analysis». Analyze the user management API endpoints
Ожидаемый результат:
- ### Endpoint: GET /api/users
- **Purpose**: Retrieve paginated list of users
- **Authentication**: Bearer token required
- **Response**: { content: User[], total: number, page: number }
- ### Endpoint: POST /api/users
- **Purpose**: Create new user account
- **Authentication**: Admin role required
Использование «technical-analysis». Document the customer entity data model
Ожидаемый результат:
- ## Entity: Customer
- ### Attributes
- | Name | Type | Required | Description |
- |------|------|----------|-------------|
- | id | UUID | Yes | Primary key |
- | email | string | Yes | Unique email address |
- ### Relationships
- | Related Entity | Type | Description |
- |---------------|------|-------------|
- | Order | 1:N | Customer has many orders |
Аудит безопасности
БезопасноDocumentation-only skill providing markdown templates for technical analysis. All static findings are false positives: placeholder patterns in templates and ASCII diagrams were misidentified as shell commands. No code execution, network access, or credential handling occurs.
Оценка качества
Что вы можете построить
Документирование конечных точек устаревших API
Создавайте комплексную документацию для недокументированных REST API путем анализа определений маршрутов, классов контроллеров и существующих паттернов кода.
Создание справочной документации по модели данных
Документируйте сущности базы данных, их связи, ограничения и индексы для использования в качестве справочника разработчиками и архитекторами данных.
Анализ безопасности интеграций с третьими сторонами
Документируйте методы аутентификации, потоки данных и требования безопасности для интеграций с внешними системами для выявления пробелов.
Попробуйте эти промпты
Проанализируйте REST API в этой кодовой базе. Для каждой конечной точки задокументируйте: HTTP-метод, путь, цель, требования аутентификации, параметры запроса, схемы ответа и обработку ошибок. Используйте шаблоны навыка технического анализа.
Изучите модели базы данных и задокументируйте сущности с их атрибутами, типами данных, связями, ограничениями и индексами. Включите бизнес-правила, где применимо.
Проследите потоки данных через внешние интеграции. Задокументируйте исходные и целевые системы, логику преобразования, методы аутентификации и паттерны обработки ошибок.
Проанализируйте реализацию аутентификации и авторизации. Задокументируйте модель контроля доступа, роли, разрешения, меры защиты данных и требования соответствия.
Лучшие практики
- Предоставляйте полную документацию конечных точек, включая все параметры, заголовки и возможные коды ответа
- Включайте бизнес-правила и логику проверки в документацию сущностей
- Явно документируйте потоки аутентификации и меры защиты данных
- Перечисляйте зависимости и требования SLA для интеграций
Избегать
- Оставлять заполнители без внесения фактических значений из кодовой базы
- Документировать только успешные сценарии без сценариев ошибок
- Пропускать отображение связей между сущностями
- Упускать детали аутентификации и авторизации из документации интеграций