Introdução
A Cumbuca Docs é o espaço oficial de documentação da comunidade Cumbuca. Como somos uma comunidade totalmente remota e organizada de forma distribuída, a documentação não é apenas apoio, ela é a base do funcionamento da comunidade.
Objetivo
A Cumbuca Docs existe para registrar como a comunidade funciona, como toma decisões, como se organiza e como executa seus projetos. Ela concentra informações institucionais, guias operacionais, processos internos, infraestrutura, governança e orientações para membros.
Seu objetivo é garantir clareza, transparência e continuidade. Tudo o que é importante para a comunidade deve, idealmente, estar documentado aqui. Isso reduz dependência de pessoas específicas, facilita a entrada de novos membros e fortalece a cultura de registro compartilhado.
Como ler
A documentação está organizada de forma modular. Você pode navegar pelo menu lateral ou utilizar a busca para encontrar um tema específico.
Existem dois caminhos principais de leitura.
-
Leitura exploratória: Para quem quer entender como a comunidade funciona de forma geral, navegando pelos núcleos e suas respectivas áreas.
-
Leitura direcionada: Para quem precisa resolver algo específico, como configurar infraestrutura, entender um processo ou executar uma atividade. Nesse caso, use a busca ou vá direto ao núcleo relacionado.
Independentemente do caminho escolhido, é fundamental que toda pessoa leia, pelo menos, as seções “Cumbuca Docs” e “A Comunidade” antes de avançar para outras áreas. Essas seções apresentam a visão geral de como a documentação e a comunidade funcionam, como estão organizadas e quais princípios orientam sua estrutura e manutenção.
Estrutura
A Cumbuca Docs é organizada principalmente por núcleos. Cada núcleo representa uma área de atuação dentro da comunidade, como Infraestrutura, Comunicação, Eventos, Open Source, entre outros. Essa organização facilita a navegação e permite que cada área concentre seus processos, guias e registros em um único lugar.
Além da organização por núcleos, a documentação também conta com seções gerais, que apresentam a base institucional da comunidade. Entre elas estão “Cumbuca Docs”, “A Comunidade” e “A Cumbuca”. Essas seções oferecem uma visão ampla sobre como a comunidade funciona, sua estrutura, seus princípios e sua forma de organização.
Dessa forma, a Cumbuca Docs combina duas camadas complementares: conteúdos gerais, que explicam o todo, e conteúdos por núcleo, que detalham cada área específica.
Público-alvo
A Cumbuca Docs é destinada a:
- Pessoas ativas da comunidade
- Novas pessoas integrantes em processo de onboarding
- Pessoas líderes e responsáveis por núcleos
- Pessoas colaboradoras externas que precisam entender como a comunidade funciona
- Qualquer pessoa interessada na estrutura organizacional da Cumbuca
O nível de detalhamento pode variar conforme o tema, mas a intenção é que qualquer membro consiga compreender os processos sem depender de explicações informais.
Manutenção da Cumbuca Docs
A Cumbuca Docs não é apenas um repositório de textos. Ela é parte central da forma como a comunidade funciona. Documentar é uma prática organizacional contínua e estratégica.
Conteúdo
A manutenção do conteúdo da Cumbuca Docs é coletiva. Cada núcleo é responsável por manter sua própria área atualizada. Sempre que um processo muda, a documentação correspondente deve ser revisada.
Manter a documentação atualizada faz parte do trabalho de cada núcleo. A qualidade da Docs é resultado do compromisso contínuo da comunidade com registro, clareza e transparência.
Infraestrutura
A infraestrutura técnica da Cumbuca Docs é de responsabilidade do Núcleo de Documentação. Esse núcleo cuida da configuração do ambiente de publicação, da manutenção do subdomínio utilizado pela documentação, do processo de deploy e da estrutura técnica que mantém o site funcionando.
Enquanto o conteúdo é descentralizado entre os núcleos, a base técnica que mantém a documentação online é gerenciada pelo Núcleo de Documentação.
A seguir, vamos detalhar como contribuir com a documentação, quais são as boas práticas esperadas e como cada pessoa pode colaborar para manter a Cumbuca Docs clara, atualizada e consistente.