documentation
Escrever melhor documentação
También disponible en: DaoThiHuong2111,Joseph OBrien,Joseph OBrien,sickn33,CrazySwami
A documentação frequentemente acaba desestruturada e difícil de ler. Esta skill fornece diretrizes claras para criar arquivos markdown bem organizados com estrutura, formatação e hierarquia visual adequadas.
Descargar el ZIP de la skill
Subir en Claude
Ve a Configuración → Capacidades → Skills → Subir skill
Activa y empieza a usar
Pruébalo
Usando "documentation". Escrever um guia de introdução para meu projeto Python
Resultado esperado:
- • Cria getting-started.md com cabeçalhos para pré-requisitos, instalação, início rápido e exemplos
- • Usa blocos de código para comandos e trechos de configuração
- • Adiciona marcadores para passos de referência rápida
- • Escreve diretamente no arquivo e informa a localização
Usando "documentation". Criar uma proposta de projeto para uma nova funcionalidade
Resultado esperado:
- • Gera proposal.md com declaração do problema, solução, cronograma e resultados
- • Usa seções claras com cabeçalhos para navegação fácil
- • Mantém tom persuasivo mas honesto apropriado para propostas
- • Salva na pasta proposals com nomenclatura descritiva
Usando "documentation". Documentar os endpoints da API para meu serviço REST
Resultado esperado:
- • Cria api.md com seções para cada endpoint
- • Usa tabelas para formatos de requisição/resposta
- • Inclui exemplos de código para cada operação
- • Organiza por tipo de recurso para fluxo lógico
Auditoría de seguridad
SeguroPure prompt-based skill containing only documentation guidelines. No code execution, no file access beyond standard AI capabilities, no network calls, and no external commands. Static findings are false positives - the analyzer misidentified documentation-related text as cryptographic references and markdown backticks as shell execution. This is a set of best practices for writing documentation.
Factores de riesgo
🌐 Acceso a red (1)
⚙️ Comandos externos (2)
Puntuación de calidad
Lo que puedes crear
Criar documentação técnica
Escrever READMEs claros, documentação de APIs e guias técnicos com estrutura adequada
Rascunhar planos de projeto
Criar planos e propostas acionáveis com passos concretos e fluxo lógico
Estruturar conteúdo de longa duração
Organizar notas de brainstorm, guias e especificações com cabeçalhos e hierarquia visual
Prueba estos prompts
Write a README for my project in PROJECT/README.md. Include sections for overview, installation, usage, and contributing.
Create API documentation in docs/api.md. Document the main endpoints, request/response formats, and authentication.
Write a project proposal in proposals/feature-x.md. Include problem statement, proposed solution, timeline, and expected outcomes.
Create architecture documentation in docs/architecture.md. Include system overview, component diagram, data flow, and design decisions.
Mejores prácticas
- Sempre escrever em um arquivo em vez de despejar conteúdo no terminal
- Usar cabeçalhos para criar estrutura e navegação claras
- Dividir o texto com listas, tabelas e blocos de código para legibilidade
Evitar
- Despejar conteúdo de longa duração diretamente no terminal sem um arquivo
- Ignorar o propósito do documento ao escolher tom e estrutura
- Usar muros de texto sem formatação ou hierarquia visual