Bem vindo a nossa documentação da API do Team Bee!

Essa documentação foi inteiramente escrita em mkdocs! Para visitar como ela funciona, você pode visitar essa doc! mkdocs.org.

Roadmap sobre os principais assuntos a serem estudados:

Uma das principais dúvidas da equipe é: "por onde eu começo?". Diante disso, desenvolvemos um roadmap dos conhecimentos mínimos para dar o ponta pé inicial! Roadmap

O que você vai encontrar nessa documentação?

Backend

• Implementação do WSGI PEP333

Frontend

• Wireframe e fluxos do produto

Biblioteca

Nessa biblioteca você vai encontrar nossas funções documentadas profundamente. Além disso, materiais importante para compreender o funcionamento técnico do nosso projeto.

• Git e github. Como você pode puxar atualizações e commitar no local correto?
  • Como fazer o pull request no local correto.
  • Como se fosse a primeira vez: configurando upstream
  • Depois de ter branch s-01 criada!
• Configurações do projeto. Como consigo rodar esse projeto na minha máquina?
  • Virtualenvs
  • Instale o pyenv

Metodológias ágeis - scrum

O documento que regeu o manifesto ágil possui 12 princípios. Leia sempre que tiver dúvida se a equipe ou você está indo bem!

Maior prioridade A satisfação do cliente somados as entregas parciais e contínuas do software, de forma adianta e com valor agredado. Não há foco em documentações rígidas, e sim na iteração constante com o cliente.

Mudanças são bem vindas. O início do desenvolvimento de software é dificil identificar todos os requisitos. O software precisa amadurecer e o cliente muitas vezes não consegue prever todas as suas necessidades antes de ter uma versão funcional do software. O método ágil adota a filosofia de que mudanças feitas mais tarde no processo não são prejudiciais. Além dissotodas as mudanças que contribuem para a melhoria do software dentro das necessidades do cliente são bem-vindas.

Entregas frequentes As entregas devem ser frequentes, de funcionalidades que estejam usáveis no ideal do MVP (mínimo produto viável).Periodicidade de tempo de entregas rápidas dão um ritmo ao trabalho da equipe de desenvolvimento. Atrasos de entrega constantem denúnciam a falência dos prazos.

Equipe única de negócios e desenvolvedores Um dos princípios da abordagem ágil é ter uma equipe única de negócios e desenvolvedores, pois o trabalho conjunto das pessoas de negócio com os desenvolvedores é importante para manter a mesma comunicação durante todo o projeto. Portanto, PO e SM codam também.

Motivação Equipe motivada é sinal de qualidade no proeto. É necessário que haja uma confiança na equipe para o desenvolvimento do trabalho que precisa ser realizado. Na abordagem ágil as equipes ágeis são autogerenciadas, com uma comunicação direta e constante com feedbacks frequentes com o comprometimento de todos os envolvidos para a entrega.

Conversa frente a frente. Um dos princípios do manifesto ágil é a conversa frente a frente, face a face, presencial. É um método eficiente e eficaz para a transmissão de qualquer informação para a equipe e entre as equipes de desenvolvimento do software.. Os feedbacks devem ser diretos e na cara.

Software Funcional É preciso garantir enregas ao fim da sprint. Um dos princípios do manifesto ágil é a entrega de um software funcional em várias etapas até a entrega do projeto final do software que está sendo desenvolvido.

Desenvolvimento sustentável Para garantir um desenvolvimento sustentável no método ágil, é importante evitar a produtividade por horas de trabalho, o que cansa o desenvolvedor, porém, valorizando a produtividade pela capacidade criativa na execução.

Agilidade É importante direcionar a atenção às necessidades de mudança e evitar documentações extensas.

Simplicidade Criação e a entrega de um software de qualidade que resolve as necessidades do cliente. Isso é realmente essencial? É possível torná-lo simples? As respostas de perguntas como essas direcionam o desenvolvimento do software para a sua simplicidade.

Times Auto Organizáveis Buscar por um conjunto restrito e muito simples de regras que deve ser obedecido por todos os membros da equipe.

Reflexões regulares Compreender o processo em que está o desenvolvimento do software, assim como velocidade e dinamismo da equipe e cada um dos seus membros. Em conversas francas e dinâmicas de grupo.

Commandos para rodar essa documentação localmente

• mkdocs serve - Inicia o projeto na sua máquina
• mkdocs build - Constroi a documentação
• mkdocs -h - Devolve comandos de ajuda