diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 00000000..e69de29b diff --git a/404.html b/404.html new file mode 100644 index 00000000..5afa35c6 --- /dev/null +++ b/404.html @@ -0,0 +1,1690 @@ + + + +
+ + + + + + + + + + + + + + +O Mínimo Produto Viável (MVP) é uma abordagem essencial no desenvolvimento de produtos, cujo principal objetivo é criar uma versão inicial simplificada que entregue a proposta de valor central da ideia. Para esta finalidade, utilizamos a ferramenta Canva para a produção do MVP.
+ +O MVP desempenha um papel crucial no desenvolvimento do produto, pois fornece uma visão geral que ajuda a determinar sua viabilidade e funcionalidades. Além disso, permite a identificação de problemas e áreas de melhoria, contribuindo para a redução de riscos à medida que a equipe avalia a aceitação do público. Essa avaliação direciona o foco da equipe para as partes mais importantes do projeto. A divisão do MVP em categorias facilita ainda mais essa análise.
+ +Foram utilizadas diversas plataformas no desenvolvimento e teste do projeto. O Telegram serviu como interface visual para os testes do chatbot, enquanto o site do Brasil Participativo, que representa o cliente final da aplicação, foi o ambiente onde o MVP foi avaliado. Além disso, o GitHub foi utilizado para elaborar a GitPage e documentar o projeto de forma colaborativa.
+ +Nosso MVP é um chatbot de assistência virtual projetado para facilitar a experiência dos usuários no site Brasil Participativo, ajudando-os na navegação e compreensão do ambiente virtual.
+ +Nosso MVP rodará no servidor e estará sempre disponivel para teste, a implementação do bot é baseada na seleção com números, o usuário segue o fluxo estabelecido pelo cliente.
+ +Nosso MVP será executado em um servidor e estará constantemente disponível para testes. A implementação do bot é baseada em seleções numéricas, permitindo que o usuário siga o fluxo estabelecido pelo cliente de forma intuitiva e eficiente.
+ +O percurso do usuário começa quando ele acessa o site e utiliza o widget para se comunicar com o chatbot. Enquanto isso, os desenvolvedores têm a flexibilidade de modificar completamente o funcionamento e a lógica do chatbot durante suas jornadas.
+ +A métrica de validação consiste em verificar se o usuário consegue concluir a conversa de forma satisfatória, mantendo um baixo nível de desvio entre os fluxos. Além disso, a satisfação do usuário final em relação ao produto também é considerada um indicador positivo de validação.
+ +O grupo é composto por seis pessoas, dedicando um total de 120 horas semanais. Desenvolvemos nosso MVP ao longo de um período de dois meses.
+ +Versão | +Data | +Descrição | +Autor | +
---|---|---|---|
1.0 | +28/03/2024 | +Criação do documento | +Gabriel Scheidt | +
2.0 | +28/03/2024 | +Alteração de layout e do MVP | +Gabriel Scheidt | +
2.1 | +08/04/2024 | +Atualização do MVP | +Isaque Augusto | +
O vídeo é uma demonstração detalhada do funcionamento do nosso Mínimo Produto Viável (MVP) para o site Brasil Participativo. Este vídeo mostra a interface do usuário diretamente no site, onde o chatbot está integrado para melhorar a experiência do usuário.
+ + +Figura 1: Captura de tela do chatbot operando no servidor de teste do site Brasil Participativo.
+Na imagem temos a interface do usuário onde o chatbot está ativo, destacando como ele interage com os visitantes do site. A interface do chatbot é projetada para ser intuitiva, permitindo que os usuários naveguem facilmente pelas opções disponíveis e obtenham respostas eficientes para suas consultas. Este teste demonstra a funcionalidade do chatbot em um ambiente real, assegurando que o sistema é robusto e confiável para uso público.
+ +A plataforma utilizada no desenvolvimento e teste do projeto foi o Botpress enquanto o site Brasil Participativo serviu como o ambiente de avaliação do MVP, representando o cliente final. O GitHub foi utilizado para a elaboração da GitPage e para a documentação colaborativa do projeto.
+ +O MVP consiste em um chatbot de assistência virtual projetado para otimizar a experiência dos usuários no site Brasil Participativo, auxiliando-os na navegação e compreensão do ambiente virtual.
+ +O MVP é operado em um servidor, estando sempre disponível para testes. Sua implementação é baseada na seleção de botões com perguntas predefinidas, guiando o usuário conforme o fluxo determinado pelo cliente.
+ +O MVP é executado em um servidor e está constantemente acessível para testes. Sua implementação permite ao usuário seguir o fluxo estabelecido pelo cliente de maneira intuitiva e eficiente, por meio de seleções de botões.
+ +A jornada do usuário inicia ao acessar o site e utilizar o widget para interagir com o chatbot. Simultaneamente, os desenvolvedores têm a flexibilidade de modificar completamente a funcionalidade e a lógica do chatbot durante essas jornadas.
+ +A métrica de validação é verificar se o usuário consegue concluir a conversa de maneira satisfatória, mantendo um baixo nível de desvio entre os fluxos. A satisfação do usuário final em relação ao produto também é considerada um indicador chave de validação.
+ +O grupo é formado por seis pessoas, dedicando um total de 120 horas semanais ao projeto. O desenvolvimento do MVP começou em 19/04/2024 e foi concluído em 03/05/2024.
+ +Versão | +Data | +Descrição | +Autor | +
---|---|---|---|
1.0 | +10/05/2024 | +Criação do documento | +Thiago Marques | +
Como participantes, colaboradoras e líderes, nós nos comprometemos a fazer com que a participação em nossa comunidade seja uma experiência livre de assédio para todas as pessoas, independentemente de idade, tamanho do corpo, deficiência aparente ou não aparente, etnia, características sexuais, identidade ou expressão de gênero, nível de experiência, educação, situação sócio-econômica, nacionalidade, aparência pessoal, raça, casta, religião ou identidade e orientação sexuais.
+ +Comprometemo-nos a agir e interagir de maneiras que contribuam para uma comunidade aberta, acolhedora, diversificada, inclusiva e saudável.
+ +Exemplos de comportamentos que contribuem para criar um ambiente positivo para a nossa comunidade incluem:
+Exemplos de comportamentos inaceitáveis incluem:
+A liderança da comunidade é responsável por esclarecer e aplicar nossos padrões de comportamento aceitáveis e tomará ações corretivas apropriadas e justas em resposta a qualquer comportamento que considerar impróprio, ameaçador, ofensivo ou problemático.
+ +A liderança da comunidade tem o direito e a responsabilidade de remover, editar ou rejeitar comentários, commits, códigos, edições na wiki, erros e outras contribuições que não estão alinhadas com este Código de Conduta e irá comunicar as razões por trás das decisões da moderação quando for apropriado.
+ +Este Código de Conduta se aplica dentro de todos os espaços da comunidade e também se aplica quando uma pessoa estiver representando oficialmente a comunidade em espaços públicos. Exemplos de representação da nossa comunidade incluem usar um endereço de e-mail oficial, postar em contas oficiais de mídias sociais ou atuar como uma pessoa indicada como representante em um evento online ou offline.
+ +Ocorrências de comportamentos abusivos, de assédio ou que sejam inaceitáveis por qualquer outro motivo poderão ser reportadas para a liderança da comunidade, responsável pela aplicação, via contato chatbotbrasilparticipativo@gmail.com . Todas as reclamações serão revisadas e investigadas imediatamente e de maneira justa.
+ +A liderança da comunidade tem a obrigação de respeitar a privacidade e a segurança de quem reportar qualquer incidente.
+ +A liderança da comunidade seguirá estas Diretrizes de Impacto na Comunidade para determinar as consequências de qualquer ação que considerar violadora deste Código de Conduta:
+ +Impacto na comunidade: Uso de linguagem imprópria ou outro comportamento considerado anti-profissional ou repudiado pela comunidade.
+Consequência: Aviso escrito e privado da liderança da comunidade, esclarecendo a natureza da violação e com a explicação do motivo pelo qual o comportamento era impróprio. Um pedido de desculpas público poderá ser solicitado.
+Impacto na comunidade: Violação por meio de um incidente único ou atitudes repetidas.
+Consequência: Advertência com consequências para comportamento repetido. Não poderá haver interações com as pessoas envolvidas, incluindo interações não solicitadas com as pessoas que estiverem aplicando o Código de Conduta, por um período determinado. Isto inclui evitar interações em espaços da comunidade, bem como canais externos como as mídias sociais. A violação destes termos pode levar a um banimento temporário ou permanente.
+Impacto na comunidade: Violação grave dos padrões da comunidade, incluindo a persistência do comportamento impróprio.
+Consequência: Banimento temporário de qualquer tipo de interação ou comunicação pública com a comunidade por um determinado período. Estarão proibidas as interações públicas ou privadas com as pessoas envolvidas, incluindo interações não solicitadas com as pessoas que estiverem aplicando o Código de Conduta. A violação destes termos pode resultar em um banimento permanente.
+Impacto na comunidade: Demonstrar um padrão na violação das normas da comunidade, incluindo a persistência do comportamento impróprio, assédio a uma pessoa ou agressão ou depreciação a classes de pessoas.
+Consequência: Banimento permanente de qualquer tipo de interação pública dentro da comunidade.
+Este Código de Conduta é adaptado do Contributor Covenant, versão 2.1, disponível em https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.
+As Diretrizes de Impacto na Comunidade foram inspiradas pela +Aplicação do código de conduta Mozilla.
+Para obter respostas a perguntas comuns sobre este código de conduta, veja a página de Perguntas Frequentes (FAQ) em https://www.contributor-covenant.org/faq. Traduções estão disponíveis em https://www.contributor-covenant.org/translations.
+Versão | +Data | +Descrição | +Autor | +
---|---|---|---|
1.0 | +28/03/2024 | +Criação do histórico de versão | +Gabriel Scheidt | +
Obrigado(a) por considerar contribuir para este projeto! Valorizamos o envolvimento da comunidade para melhorar continuamente.
+Antes de começar, sugerimos que você leia nosso código de conduta para garantir um ambiente respeitoso e colaborativo.
+git checkout -b feature-nova
.git commit -m 'Adiciona nova feature'
.git push origin feature-nova
.Abra um pull request neste repositório.
+Para mantermos o padrão dos passos acima, consulte os guias. Padrão de Commit e Branches
+Por favor, siga os padrões de codificação e estilo estabelecidos neste projeto. Certifique-se de que seu código está formatado corretamente.
+Com isso, nomes de variáveis devem ser definidos seguindo o camel case, nomes começando com letra minuscula, palavras juntas e sem acentos, com a letra maiúscula indicando onde haveria espaço. EX: estaVariavel.
+Para outras práticas de codificação serão seguidas o PEP8.
+Obs: Você pode executar o Pylint para auxiliar a manter o padrão de qualidade do projeto.
+E.g pylint directory/mymodule.py
Para utilizar o pylint deve ser instalado executando o seguinte comando:
+pip install pylint
O pylint pode ser integrado em diversas IDEs, pode ser verificado esta possibilidade na documentação.
+Se você encontrar problemas ou bugs, por favor, abra uma issue descrevendo o problema. Inclua informações detalhadas sobre como reproduzir o problema e o ambiente em que ele ocorreu.
+Adoramos receber sugestões e melhorias! Sinta-se à vontade para abrir uma issue para discutir novas ideias ou melhorias para o projeto.
+Ao contribuir, você concorda que suas contribuições serão licenciadas sob a Licença do Projeto.
+Agradecemos suas contribuições!
+Contato: chatbotbrasilparticipativo@gmail.com
+Versão | +Data | +Descrição | +Autor | +
---|---|---|---|
1.0 | +28/03/2024 | +Criação do histórico de versão | +Gabriel Scheidt | +
1.1 | +01/04/2024 | +Adição de links de políticas de commits e licença | +Arthur Taylor | +
1.2 | +03/04/2024 | +Definição dos pdrões de codificação | +Arthur Taylor | +
O presente projeto será desenvolvido coletivamente por todos os integrantes de sua equipe. Para a garantia de uma boa cooperação entre os membros e um consequente bom andamento do projeto, faz-se necessária a elaboração de uma política de commits e branching.
+ +Deste modo, este documento visa estabelecer regras e princípios cuja adoção facilitará a organização do repositório.
+Para o estabelecimento de uma política de commits, serão observados alguns dos princípios da especificação Conventional Commits e opcionais derivados do guia GitMoji.
+A estrutura básica de um commit (adaptada do Conventional Commits) será:
+tipo: descrição das alterações
+
+Como alternativa, poderão ser adotados elementos do GitMoji no lugar do tipo do commit:
+:gitmoji: descrição das alterações
+
+Dentre os possíveis tipos, podemos ter:
+Tipo (texto) | +GitMoji | +Uso | +
---|---|---|
feat | +:sparkles: :sparkles: |
+Feature implementada no projeto | +
doc | +:memo: :memo: |
+Criação ou atualização de documentação do projeto | +
fix | +:bug: :bug: |
+Correção de erro no projeto | +
str | +:art: :art: |
+Alterações na estrutura ou organização do projeto (incluindo wiki do GitPages) | +
Para eventuais situações onde o commit aborde questões que não se encaixem nos tipos supracitados, recomenda-se que sejam seguidos os demais princípios descritos no Conventional Commits ou no GitMoji.
+Quanto à descrição das alterações, estas devem ser sucintas e descritivas, apresentando um resumo das modificações que o commit faz (em português).
+Para a política de branching, serão observados alguns princípios estabelecidos no artigo do GitKraken, os quais serão adaptados para o escopo de nosso projeto.
+Primeiramente, será absolutamente contraindicada a realização de commits e alterações na branch main, a qual deverá ser única e só poderá sofrer alterações mediante a aprovação de pull requests previamente revisados por integrantes do grupo.
+Para além da main, deverão ser criadas branches (preferencialmente a partir da própria main) para a realização de alterações, as quais devem ser nomeadas conforme a seguinte estrutura:
+tipo/nome-da-alteracao
+
+Dentre os possíveis tipos, temos: +- feat: declara uma branch criada para a implementação de features do projeto; +- doc: declara uma branch criada para o desenvolvimento de documentação do projeto; +- fix: declara uma branch criada para a resolução de eventuais problemas encontrados no projeto; +- str: declara uma branch criada para implementação de alterações estruturais no projeto.
+O nome-da-alteracao deverá preferencialmente ser composto por poucas (ou apenas uma) palavras significativas quanto ao contexto da branch.
+Demais possibilidades de tipos de branches deverão seguir preferencialmente os princípios postos no artigo do GitKraken.
+Versão | +Data | +Descrição | +Autor | +
---|---|---|---|
1.0 | +01/04/2024 | +Criação do histórico de versão | +Arthur Taylor | +
Este documento busca elucidar um pouco mais sobre como estará estruturada a arquitetura do bot em desenvolvimento pela equipe, fornecendo uma visualização de como utilizaremos as tecnlogias em busca da resoução do problema em nosso escopo.
+Neste diagrama podemos ver como as tecnologias selecionadas atuam no nosso bot.
+Podemos dividir o escopo do projeto da seguinte forma:
+Atualmente o Brasil Partivipativo conta com um suporte a dúvidas extremamente lento, que precisa ser otimizado para que possa sanar as duvidas de quem busca utilizar o serviço. A forma como o suporte está estruturado hoje é a resposta de perguntas sendo realizadas via email, gerando assim uma demanda para uma pessoa, e atrasando assim a resposta uma vez que o grande fluxo de perguntas pode fazer com que os servidores que estão designados para isso possam ter uma sobrecarga.
+Nossa solução é a implementação de um chatbot para que possamos dar respostas mais ágeis para as pessoas que gostariam de utilizar a plataforma mas acabam com eventuais dúvidas, não sendo nescessário a espera pela resposta de um email para que o usuário tenha sua dúvida sanada.
+O grupo decidiu pela utilização da ferramenta "Botpress" como a principal ferramenta para a criação do bot, mais informações podem ser conferidas no documento de tecnologia.
+Versão | +Data | +Descrição | +Autor | +
---|---|---|---|
1.0 | +06/05/2024 | +Criação do documento | +Arthur Taylor | +
1.1 | +26/06/2024 | +Atualização do diagrama e corrige português | +Arthur Taylor | +