🏆 Desafio Mestre da Documentação

Pratique uma das habilidades mais valiosas — e negligenciadas — do desenvolvimento: escrever documentação clara e profissional.

48 horas • 1 README.md • 2 Badges Exclusivos

Quero Participar!

Por Que Este Desafio?

A Documentação É Sua Assinatura

No mercado, quem documenta bem é quem entrega valor. Um bom README não só ajuda outros devs — ele mostra sua maturidade técnica, empatia e profissionalismo.

Para Quem É?

  • Iniciantes em programação
  • Pessoas em transição de carreira
  • Estudantes e devs que querem melhorar o portfólio
  • Quem já desenvolve, mas nunca priorizou a documentação

📌 Requisitos do README.md

Seu README deve conter obrigatoriamente estes 8 itens:

1
Título do Projeto

Nome claro e direto.

2
Descrição

O que faz? Para quem serve? Em 2–3 linhas.

3
Tecnologias Utilizadas

Lista das principais ferramentas e linguagens.

4
Instalação

Passo a passo para rodar localmente.

5
Como Usar

Exemplos práticos, prints ou GIFs (opcional, mas recomendado).

6
Estrutura de Pastas

Breve explicação da organização do projeto.

7
Contribuição

Como outros devs podem ajudar no projeto.

8
Licença

Ex: MIT, Apache 2.0 — basta um link.

🧭 Como Participar — Passo a Passo

1️⃣ Faça um fork deste repositório

Clique em Fork no topo da página do repositório.

2️⃣ Escolha um projeto

Pode ser seu (antigo ou novo), ou um open source simples. Até um generate-readme serve!

3️⃣ Crie ou revise o README.md

Siga os 8 requisitos acima. Capriche — esse README pode ir no seu portfólio!

4️⃣ Envie no grupo da comunidade

Use o formato:
#DesafioMestreDaDocumentação Meu README: <link> Indicado por: @nome (opcional)

⏳ Prazo: 48 horas

A partir do anúncio oficial no grupo.

Manual Completo do Desafio Exemplo de Projeto Base

🧩 Subdesafio: “Dev que Apoia Dev”

Indique alguém que está começando, precisa de apoio ou quer melhorar o portfólio.

Se ela entregar o README dentro do prazo e mencionar você:
Indicado por: @seu-nome

Você ganha o badge exclusivo: 🤝 Dev que Apoia Dev

🏅 Seus Badges

Mestre da Documentação

✅ Entrega válida do README com todos os 8 itens

PR com título: [mestre] Entrega do Desafio 48h

Dev que Apoia Dev

✅ Alguém que você indicou completou o desafio

PR com título: [apoia] Indicação do usuário X

Tudo é automático: badges, certificados e merge — basta seguir o título do PR!