Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Sugestão] Estrutura da documentação #1

Open
antonio-pedro99 opened this issue Apr 11, 2024 · 0 comments
Open

[Sugestão] Estrutura da documentação #1

antonio-pedro99 opened this issue Apr 11, 2024 · 0 comments
Assignees

Comments

@antonio-pedro99
Copy link
Member

Conforme a nossa reunião datada em 10 de abril de 2024, aqui temos a estrutura da documentação da comunidade.

Essa documentação inclui todas informações detalhadas sobre a organização, projectos, nossas iniciativas e muito mais.

  1. Página Inicial:

    • Visão geral da comunidade e a sua missão.
    • Call-to-action para se juntar à comunidade ou contribuir para projetos específicos.
      • Código de conduta
      • Licenças
      • Links úteis.
  2. Sobre Nós:

    • História da comunidade e a sua jornada até o momento.
  • Princípios e valores da comunidade.
  • Team
  • Código de conduta
  • Directrizes de Branding
  1. Comunidade:
    -Links para canais de comunicação da comunidade, como fóruns de discussão, listas de e-mail, salas de chat, redes sociais, etc.

    • Informações sobre como se conectar com outros membros, fazer perguntas e buscar ajuda.
    • Blog
      - Calendário de postagem
      - Guia de publicação completa
    • Newsletter
    • Eventos
      - Calendário de eventos da comunidade, como reuniões, hackathons, conferências, etc.
      - Informações sobre como participar de eventos ou propor novos eventos.
  2. Contribuir:

    • Guia passo-a-passo sobre como começar a contribuir com a comunidade.
      - Com documentação
      - Tradução
      - Desenvolvimento
      - Evangelismo
      - UI/UX Design
    • Diretrizes de contribuição, incluindo código de conduta, estilo de código, e processo de envio de pull requests.
    • Lista de prorjectos open source externos onde a comunidade pode contribuir
    • Pedir ajuda
  3. Projetos:

    • Lista de projetos open source mantidos pela comunidade.
    • Breve descrição de cada projeto, o seu propósito e tecnologias utilizadas.
    • Links para documentação, repositórios GitHub ou outras plataformas de desenvolvimento.
  4. Recursos:

    • Links para recursos úteis, como tutoriais, guias, ferramentas recomendadas, etc.
    • Referências para documentação oficial, fóruns de discussão e outras fontes de suporte.
  5. FAQ:

    • Perguntas frequentes sobre a comunidade, seus projetos e processos de contribuição.
    • Respostas claras e concisas para ajudar os usuários a encontrar as informações de que precisam rapidamente.
  6. Contacto:

    • Formulário de contato ou endereço de e-mail para perguntas gerais ou consultas específicas.
    • Informações sobre como relatar problemas, sugestões ou preocupações sobre a comunidade ou seus projetos.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

6 participants