Habilidades documentation
📦

documentation

Alto Risco ⚙️ Comandos externos⚡ Contém scripts

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.

Suporta: Claude Codex Code(CC)
⚠️ 57 Ruim
1

Baixar o ZIP da skill

2

Upload no Claude

Vá em Configurações → Capacidades → Skills → Upload skill

3

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 Risco
v1 • 2/24/2026

Static 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.

1
Arquivos analisados
262
Linhas analisadas
5
achados
1
Total de auditorias

Problemas de Alto Risco (1)

Weak Cryptographic Algorithm References
The skill contains 11 references to weak cryptographic algorithms. This is unusual for a documentation skill and may indicate the skill implements cryptographic functionality rather than just documenting it. Possible legitimate use: educational content about crypto vulnerabilities. Possible malicious: actual weak crypto implementation.
Problemas de Risco Médio (1)
Ruby/Shell Backtick Command Execution
The skill contains 61 instances of Ruby/shell backtick execution. While a documentation tool might legitimately invoke documentation generators via shell, the volume is unusual and warrants verification that commands are hardcoded and safe.
Problemas de Baixo Risco (1)
System Reconnaissance Patterns
The skill contains 2 references to system reconnaissance patterns. This is highly unusual for a documentation skill and may indicate the skill performs system enumeration rather than just documenting code.

Padrões Detectados

Shell Command Execution via BackticksCryptographic Weakness References
Auditado por: claude

Pontuação de qualidade

38
Arquitetura
100
Manutenibilidade
87
Conteúdo
50
Comunidade
13
Segurança
83
Conformidade com especificações

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

Geração Básica de README
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.
Documentação de API
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.
Documentação de Arquitetura
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.
Comentários 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

Perguntas Frequentes

Esta skill pode gerar docs para qualquer linguagem de programação?
Sim, suporta a maioria das linguagens populares incluindo Python, JavaScript, Java, Go e Ruby. A qualidade depende da estrutura do código e comentários existentes.
É necessário acesso a uma aplicação em execução?
Não, ela gera documentação a partir de código-fonte estático. Você não precisa de uma aplicação em execução.
Pode atualizar documentação existente?
Sim, você pode fornecer documentação existente e solicitar que a skill a atualize, aprimore ou sincronize com alterações no código.
Quais formatos pode gerar?
A saída principal é Markdown, mas também pode gerar HTML, texto puro e formatar para sistemas de documentação específicos.
Quão precisa é a documentação de API gerada?
A precisão depende da qualidade do código. Código bem estruturado com assinaturas de função claras e comentários produz docs precisas. Lógica complexa pode exigir revisão manual.
Pode documentar arquiteturas de microsserviços?
Sim, pode documentar interações de serviços, contratos de API e arquitetura de sistema quando fornecidos os arquivos de código e configuração relevantes.

Detalhes do Desenvolvedor

Estrutura de arquivos

📄 SKILL.md