documentation
Gerar Documentação Técnica
Também disponível em: DaoThiHuong2111,Joseph OBrien,Joseph OBrien,CrazySwami,BfdCampos
Esta skill automatiza a criação de documentação técnica, incluindo documentação de API, arquivos README e documentos de arquitetura. Ela ajuda desenvolvedores a manter documentação consistente e profissional sem esforço manual.
Baixar o ZIP da skill
Upload no Claude
Vá em Configurações → Capacidades → Skills → Upload skill
Ative e comece a usar
Testar
A utilizar "documentation". Gere um README para uma ferramenta CLI Python que processa arquivos CSV
Resultado esperado:
# CSV Processor CLI
A command-line tool for processing and transforming CSV files.
## Installation
```bash
pip install csv-processor
```
## Usage
```bash
csv-processor input.csv --output output.csv --transform uppercase
```
## Features
- Read and write CSV files
- Apply transformations
- Filter rows by condition
- Export to multiple formats
A utilizar "documentation". Documente este endpoint de API: POST /users/{id}/orders
Resultado esperado:
## Create User Order
**Endpoint:** `POST /users/{id}/orders`
Creates a new order for a specific user.
### Parameters
- `id` (path, required): User's unique identifier
- `items` (body, required): Array of order items
- `shipping_address` (body, required): Delivery address
### Response
```json
{
"order_id": "ord_123",
"status": "pending",
"total": 99.99
}
```
Auditoria de Segurança
Alto RiscoStatic analysis detected 72 potential security issues including 61 instances of shell command execution, 11 references to weak cryptographic algorithms, and 2 instances of system reconnaissance patterns. These patterns are highly unusual for a documentation skill and require manual review. The high density of external command invocations and security-related patterns suggests this skill may contain functionality beyond simple documentation generation.
Problemas de Alto Risco (1)
Problemas de Risco Médio (1)
Problemas de Baixo Risco (1)
Fatores de risco
⚙️ Comandos externos (61)
⚡ Contém scripts
Padrões Detectados
Pontuação de qualidade
O Que Você Pode Construir
Geração de Documentação de API
Gera automaticamente documentação abrangente de API a partir do código-fonte, incluindo endpoints, parâmetros e tipos de resposta.
Criação de README do Projeto
Cria arquivos README polidos com guias de introdução, instruções de instalação e diretrizes de contribuição.
Aprimoramento de Comentários de Código
Adiciona ou melhora comentários inline e docstrings para melhorar a legibilidade e manutenibilidade do código.
Tente Estes Prompts
Gere um arquivo README.md para este projeto. Inclua seções para: Título do projeto, Descrição, Instalação, Uso, Contribuição e Licença.
Gere documentação de API para o seguinte código. Inclua descrições de endpoints, detalhes de parâmetros, exemplos de requisição/resposta e códigos de erro.
Crie documentação de arquitetura incluindo visão geral do sistema, descrições de diagramas de componentes, fluxo de dados e decisões de design para esta base de código.
Adicione comentários inline abrangentes e docstrings ao seguinte código. Explique lógica complexa, documente parâmetros e valores de retorno, e adicione comentários de cabeçalho aos arquivos.
Melhores Práticas
- Forneça instruções claras e específicas sobre o formato e estrutura de documentação desejados
- Inclua documentação existente ou contexto de código ao solicitar atualizações
- Revise a documentação gerada quanto à precisão técnica antes de publicar
- Use diretrizes consistentes de formatação e estilo em toda a documentação
Evitar
- Solicitar documentação sem fornecer código-fonte ou contexto
- Esperar que a skill entenda comportamento em tempo de execução sem execução
- Confiar apenas em docs geradas sem revisão técnica manual
- Gerar documentação para código sem comentários ou estrutura