technical-analysis
Analisar APIs, Modelos de Dados e Integrações de Sistemas
Sistemas técnicos requerem documentação completa para garantir confiabilidade, segurança e manutenibilidade. Esta skill fornece templates estruturados para analisar e documentar APIs, modelos de dados, integrações e requisitos de segurança com formatação consistente.
Télécharger le ZIP du skill
Importer dans Claude
Allez dans Paramètres → Capacités → Skills → Importer un skill
Activez et commencez à utiliser
Tester
Utilisation de "technical-analysis". Analise os endpoints da API de gerenciamento de usuários
Résultat attendu:
- ### Endpoint: GET /api/users
- **Propósito**: Recuperar lista paginada de usuários
- **Autenticação**: Bearer token obrigatório
- **Resposta**: { content: User[], total: number, page: number }
- ### Endpoint: POST /api/users
- **Propósito**: Criar nova conta de usuário
- **Autenticação**: Papel de Admin obrigatório
Utilisation de "technical-analysis". Documente o modelo de dados da entidade cliente
Résultat attendu:
- ## Entidade: Customer
- ### Atributos
- | Nome | Tipo | Obrigatório | Descrição |
- |------|------|-------------|-----------|
- | id | UUID | Sim | Chave primária |
- | email | string | Sim | Endereço de email único |
- ### Relacionamentos
- | Entidade Relacionada | Tipo | Descrição |
- |---------------------|------|-----------|
- | Order | 1:N | Cliente tem muitos pedidos |
Audit de sécurité
SûrDocumentation-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.
Score de qualité
Ce que vous pouvez construire
Documentar Endpoints de API Legada
Gerar documentação abrangente para APIs REST não documentadas através da análise de definições de rotas, classes de controladores e padrões de código existentes.
Criar Documentação de Referência de Modelo de Dados
Documentar entidades de banco de dados, seus relacionamentos, restrições e índices para servir como referência para desenvolvedores e arquitetos de dados.
Analisar Segurança de Integração com Terceiros
Documentar métodos de autenticação, fluxos de dados e requisitos de segurança para integrações de sistemas externos para identificar lacunas.
Essayez ces prompts
Analise a API REST nesta base de código. Para cada endpoint, documente: método HTTP, caminho, propósito, requisitos de autenticação, parâmetros de requisição, schemas de resposta e tratamento de erros. Use os templates da skill technical-analysis.
Examine os modelos de banco de dados e documente entidades com seus atributos, tipos de dados, relacionamentos, restrições e índices. Inclua regras de negócio quando aplicável.
Rastreie fluxos de dados através de integrações externas. Documente os sistemas de origem e destino, lógica de transformação, métodos de autenticação e padrões de tratamento de erros.
Analise a implementação de autenticação e autorização. Documente o modelo de controle de acesso, papéis, permissões, medidas de proteção de dados e requisitos de conformidade.
Bonnes pratiques
- Fornecer documentação completa de endpoints incluindo todos os parâmetros, cabeçalhos e códigos de resposta possíveis
- Incluir regras de negócio e lógica de validação na documentação de entidades
- Documentar fluxos de autenticação e medidas de proteção de dados explicitamente
- Listar dependências e requisitos de SLA para integrações
Éviter
- Deixar placeholders sem preencher com valores reais da base de código
- Documentar apenas cenários de sucesso sem cenários de erro
- Pular mapeamentos de relacionamentos entre entidades
- Omitir detalhes de autenticação e autorização da documentação de integração