Contribuir com Documentação — Guia Escritores
Contribuir com Documentação
A documentação é tão importante quanto o código. Veja como ajudar.
Por Que Contribuir
- Ajuda novos usuários
- Torna OpenClaw acessível globalmente
- Reconhecimento na comunidade
- Melhora suas habilidades de escrita técnica
Tipos de Contribuição
Correções
- Erros de português/gramática
- Links quebrados
- Informação desatualizada
- Código que não funciona
Melhorias
- Exemplos mais claros
- Explicações mais detalhadas
- Screenshots e diagramas
- Casos de uso reais
Novos Conteúdos
- Tutoriais
- Guias de integração
- Receitas/automações
- Traduções
Como Contribuir
1. Fork do Repositório
# Clone o repo de docs
git clone https://github.com/openclaw/docs
cd docs
2. Crie uma Branch
git checkout -b docs/minha-contribuicao
3. Faça suas Alterações
Docs usam Markdown. Estrutura:
content/
├── guias/
├── tutoriais/
├── integracoes/
├── receitas/
└── faq/
4. Teste Localmente
# Se usa Hugo
hugo server -D
# Veja em localhost:1313
5. Commit e PR
git add .
git commit -m "docs: adiciona tutorial de X"
git push origin docs/minha-contribuicao
Abra Pull Request no GitHub.
Estilo de Escrita
Tom
- Direto - Vá ao ponto
- Amigável - Não seja robótico
- Prático - Exemplos reais
Formatação
# Título Principal (H1)
## Seções (H2)
### Subseções (H3)
**Negrito** para ênfase
`código` para inline
Estrutura de Página
---
title: "Título da Página"
description: "Descrição para SEO"
tags: ["tag1", "tag2"]
---
# Título
Introdução em 1-2 parágrafos.
## Primeira Seção
Conteúdo...
## Segunda Seção
Conteúdo...
## Próximos Passos
Links relacionados.
Checklist de Qualidade
- Título claro e descritivo
- Descrição com palavras-chave
- Introdução explica o objetivo
- Exemplos de código funcionam
- Links internos para relacionados
- Sem erros de português
- Formatação consistente
Boas Práticas
Sim Faça
- Use exemplos reais
- Inclua output esperado
- Explique o “porquê”, não só o “como”
- Adicione links para aprofundar
Não Evite
- Parágrafos muito longos
- Jargão sem explicação
- Informação redundante
- Assumir conhecimento prévio
Reconhecimento
Contribuidores são listados em:
- CONTRIBUTORS.md
- Página de agradecimentos
- Release notes (para contribuições significativas)
Precisa de Ajuda?
- Discord: Canal #docs
- GitHub: Abra uma issue
- Email: docs@clawd.bot