Skip to content

Reduzir densidade do README e criar um caminho de onboarding mais curto #68

Description

@rodri-oliveira-dev

Parent roadmap: rodri-oliveira-dev/rodri-oliveira-dev#30

Contexto

O README contém documentação técnica rica, porém acumula onboarding, contrato público, arquitetura, garantias, observabilidade, extensibilidade e manutenção em um único fluxo longo.

A meta não é remover profundidade, e sim permitir que um consumidor entenda e experimente a biblioteca rapidamente antes de entrar nos detalhes.

Escopo

  • Preservar no README principal:
    • propósito e problema;
    • garantias e limites essenciais;
    • instalação;
    • Quick Start executável;
    • exemplo mínimo de DI/dispatcher;
    • links claros para documentação aprofundada.
  • Mover ou consolidar detalhes extensos em docs/ quando já existir local adequado:
    • modelo de entrega e leases;
    • retry/classificação;
    • segurança/assinatura;
    • observabilidade;
    • implementação de stores;
    • operação em produção;
    • extensibilidade.
  • Criar uma pequena seção "Read next" / "Documentation map".
  • Não esconder a garantia at-least-once nem sugerir exactly-once.
  • Manter explícito que durabilidade real depende de store durável fornecido/configurado pelo consumidor.

Definition of Done

  • Novo usuário encontra propósito, instalação e primeiro exemplo sem percorrer documentação interna extensa.
  • Quick Start continua compilável/coerente com a API publicada.
  • Garantias e limites essenciais permanecem visíveis no README.
  • Conteúdo movido fica acessível por links claros em docs/.
  • Não há duplicação conflitante entre README e docs.
  • README PT-BR/EN permanecem factualmente equivalentes, se ambos forem mantidos.
  • Links e snippets relevantes são validados.
  • CI permanece verde.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions