hads
Ajuda seu agente a criar documentação legível por humanos e IA. É útil para otimizar textos técnicos e garantir que modelos de IA entendam o conteúdo.
O que ela faz
Esta ferramenta ajuda a organizar documentos técnicos para que tanto pessoas quanto inteligências artificiais (IA) possam entendê-los facilmente. Ela usa um formato especial chamado HADS para separar fatos importantes, contexto e problemas conhecidos.
Quando usar
- ✓Ao escrever documentação técnica que precisa ser clara para humanos e IAs.
- ✓Ao converter documentos existentes para o formato HADS.
- ✓Ao otimizar documentos para que a IA os leia de forma mais eficiente.
Exemplo do que pedir para a IA
“Transforme este manual em formato HADS, separando os fatos, o contexto e os bugs conhecidos.”
Quer saber mais? Abra as seções abaixo.
Como usar
O jeito mais fácil: copie a mensagem abaixo e cole no Claude, ChatGPT, Cursor ou outra IA. Ela lê a skill e segue as instruções.
Link da skill
Mensagem pronta para colar
Como funciona
A IA lê o documento e identifica blocos específicos marcados com [SPEC] para fatos, [NOTE] para contexto e [BUG] para problemas. Ela usa essas marcações para entender e processar a informação de forma organizada.
Instalação
Jeito mais fácil: copie o link da skill e cole no Claude, ChatGPT ou Cursor pedindo para seguir as instruções.
No terminal (Claude Code, Codex, Cursor), na pasta do projeto:
npx skills add wshobson/agents --skill hadsOu baixe só o arquivo:
curl -L https://raw.githubusercontent.com/wshobson/agents/main/plugins/documentation-standards/skills/hads/SKILL.md -o SKILL.mdConteúdo técnico (SKILL.md)
Tradução do texto original do autor no GitHub. Os comandos e códigos estão como no original.
Claude HADS Skill
Versão 1.0.0 · Padrão de Documentação Humano-IA · 2026 · HADS 1.0.0
INSTRUÇÃO DE LEITURA DA IA
Esta skill ensina o Claude a ler, gerar e validar documentos HADS.
Leia todos os blocos [SPEC] antes de responder a qualquer solicitação relacionada a HADS.
Leia os blocos [NOTE] se precisar de contexto sobre intenção ou casos extremos.
1. O QUE É HADS
[SPEC]
- HADS = Padrão de Documentação Humano-IA (Human-AI Document Standard)
- Convenção para documentação técnica em Markdown
- Quatro tipos de blocos:
**[SPEC]**,**[NOTE]**,**[BUG]**,**[?]** - Todo documento HADS requer: título H1, declaração de versão, manifesto da IA
- O manifesto da IA aparece antes da primeira seção de conteúdo, informa à IA o que ler/ignorar
- Extensão de arquivo:
.md— Markdown padrão, nenhuma ferramenta necessária
2. TIPOS DE BLOCOS
[SPEC]
**[SPEC]** Authoritative fact. Terse. Bullet lists, tables, code. AI reads always.
**[NOTE]** Human context, history, examples. AI may skip.
**[BUG]** Verified failure + fix. Required fields: symptom, cause, fix. Always read.
**[?]** Unverified / inferred. Lower confidence. Always flagged.
Regras de tags de bloco:
- Negrito, em sua própria linha:
**[SPEC]** - O conteúdo segue imediatamente (sem linha em branco entre a tag e o conteúdo)
- Múltiplos blocos de tipos diferentes permitidos por seção
- Blocos BUG com título permitidos:
**[BUG] Short description** - Sem aninhamento de blocos dentro de blocos
3. ESTRUTURA DE DOCUMENTO REQUERIDA
[SPEC]
# Document Title
**Version X.Y.Z** · Author · Date · [metadata]
---
## AI READING INSTRUCTION
Read `[SPEC]` and `[BUG]` blocks for authoritative facts.
Read `[NOTE]` only if additional context is needed.
`[?]` blocks are unverified — treat with lower confidence.
---
## 1. First Section
**[SPEC]**
...
Elementos necessários em ordem:
- Título H1
**Version X.Y.Z**no cabeçalho (primeiras 20 linhas)- Seção de manifesto da IA antes da primeira seção de conteúdo
- Seções de conteúdo (H2), subseções (H3)
4. COMO O CLAUDE LÊ HADS
[SPEC] Ao encontrar um documento HADS:
- Encontre e leia o manifesto da IA primeiro
- Leia todos os blocos
[SPEC]— esta é a verdade fundamental - Leia todos os blocos
[BUG]— sempre, antes de gerar qualquer código ou configuração - Leia os blocos
[NOTE]apenas se[SPEC]for insuficiente para responder à consulta - Trate o conteúdo
[?]como hipótese — observe a incerteza na resposta
Otimização de tokens: para documentos grandes, escaneie primeiro os títulos das seções e, em seguida, leia apenas os blocos [SPEC] e [BUG] nas seções relevantes.
5. COMO O CLAUDE GERA HADS
[SPEC] Quando solicitado a escrever documentação no formato HADS:
- Comece com o bloco de cabeçalho (título, versão, metadados)
- Adicione o manifesto da IA — sempre inclua, nunca pule
- Organize o conteúdo em seções H2 numeradas
- Para cada fato: escreva como
[SPEC]— conciso, lista ou tabela ou código - Para cada "porquê" ou contexto: escreva como
[NOTE] - Para cada modo de falha conhecido com correção confirmada: escreva como
[BUG] - Para cada afirmação não verificada: escreva como
[?] - Termine com a seção de changelog
Regras de conteúdo para [SPEC]:
- Prefira listas com marcadores a prosa
- Prefira tabelas para fatos com múltiplos campos
- Prefira blocos de código para sintaxe, formatos, exemplos
- Máximo de 2 frases de prosa — se precisar de mais, mova para
[NOTE]
Regras de conteúdo para [BUG]:
- Sempre inclua: sintoma, causa, correção
- Opcional: versões afetadas, solução alternativa
- Título na mesma linha:
**[BUG] Short description**
[NOTE]
Ao converter documentação existente para HADS: extraia fatos para [SPEC], mova narrativa e histórico para [NOTE], apresente todos os problemas conhecidos como [BUG]. Não duplique conteúdo entre os tipos de bloco.
6. REGRAS DE VALIDAÇÃO
[SPEC] Um documento HADS válido deve ter:
- Título H1
**Version X.Y.Z**nas primeiras 20 linhas- Manifesto da IA antes da primeira seção de conteúdo
- Todas as tags de bloco em negrito:
**[SPEC]**não[SPEC]não [SPEC] - Blocos
[BUG]contêm no mínimo sintoma + correção
Validador: (planejado — ainda não incluído nesta versão)
7. EXEMPLOS DE INTERAÇÕES
[SPEC]
Usuário: "Escreva a documentação HADS para esta API REST" → Gere o documento HADS completo: cabeçalho, manifesto, seções com blocos [SPEC]/[NOTE]/[BUG]
Usuário: "Converta este README para o formato HADS" → Reestruture o conteúdo existente em blocos HADS, preserve todos os fatos, adicione o manifesto
Usuário: "Este documento é HADS válido?" → Verifique: título H1, versão, manifesto, formatação de tag de bloco, completude do bloco BUG
Usuário: "Resuma este documento HADS" → Leia apenas os blocos [SPEC] e [BUG], retorne um resumo estruturado
Usuário: "O que esta API faz?" (documento HADS fornecido)
…
Perguntas frequentes
O que são os blocos [SPEC], [NOTE] e [BUG]?
[SPEC] contém fatos importantes e diretos. [NOTE] oferece contexto adicional, como exemplos ou histórico. [BUG] descreve falhas conhecidas e como corrigi-las.
Por que usar o formato HADS?
O HADS torna a documentação mais clara para IAs, que muitas vezes a leem antes dos humanos. Isso garante que a IA entenda as informações essenciais sem se perder em detalhes.
O que é o 'AI manifest'?
É uma instrução no início do documento que diz à IA exatamente quais partes ler (como [SPEC] e [BUG]) e quais pode pular (como [NOTE], a menos que precise de mais contexto).
Detalhes
Descrição original do autor
Use when writing technical documentation that needs to be readable by both humans and AI models, converting existing docs to HADS format, validating a HADS document, or optimizing documentation for token-efficient AI consumption.
repo: wshobson/agents
Popularidade
- Estrelas no GitHub
- 41 mil
- Posição no ranking
- #4859
- Licença
- MIT
- Atualizada em
- 15/10/2026
Comentários
- …
Mais skills deste repositório
screen-reader-testing
Faz seu agente testar sites usando leitores de tela para garantir que sejam acessíveis.
wshobson/agents
wcag-audit-patterns
Ajuda seu agente a auditar sites para acessibilidade e corrigir problemas de acordo com as diretrizes WCAG.
wshobson/agents
multi-reviewer-patterns
Faz seu agente coordenar revisões de código paralelas, deduplicando achados e consolidando relatórios.
wshobson/agents
parallel-debugging
Permite ao agente depurar problemas complexos com investigações paralelas e análise de causa raiz.
wshobson/agents
Skills parecidas
architecture-decision-records
Faz seu agente registrar decisões importantes sobre a estrutura do projeto. Ajuda a entender o porquê das escolhas feitas e a manter um histórico claro das mudanças.
affaan-m/ECC
code-tour
Faz seu agente criar guias passo a passo no código, com locais exatos em arquivos e linhas. É útil para apresentar um projeto, explicar código ou revisar mudanças. Ajuda a entender como um sistema funciona.
affaan-m/ECC
codebase-onboarding
Ajuda seu agente a analisar um código desconhecido e criar um guia de integração. Ele inclui um mapa da arquitetura, pontos de entrada e convenções. Ideal para quem está começando em um novo projeto.
affaan-m/ECC