O grupo deverá entregar a versão final da documentação do projeto desenvolvido. Para o refinamento a ser feito na última sprint, deve-se considerar as issues registradas pelo professor orientador no decorrer do projeto. #
Padrão de entrega:
1 - O texto desenvolvido pelo grupo deve estar disponível no repositório do GitHub (branch main), dentro da pasta docs e em formato markdown.
2 - As figuras utilizadas no documento devem sempre ser referenciadas no texto, com descrições textuais que estimulem a coesão entre o que é apresentado visualmente e o restante do texto.
3 - Todas as figuras utilizadas na documentação devem estar salvas dentro da pasta docs, em uma subpasta chamada assets.
4 - As issues abertas pelo orientador no decorrer do projeto somente podem ser fechadas por ele. A condição fundamental para o fechamento de um issue é a existência de ao menos um commit que referencie aquele issue diretamente. #
Padrão de qualidade:
1 - Fechamento adequado das issues de documentação abertas pelo professor orientador (até 2,5 pontos).
2 - O documento deve apresentar os objetivos, metas e requisitos do projeto de forma clara e, quando cabível, quantificável (até 1,0 pontos).
3 - Deve-se apresentar uma descrição detalhada da implementação do sistema, com diagramas UML de sequência e implementação devidamente integrados à explicação textual (até 2,0 pontos).
4 - A documentação deve apresentar a implementação e resultados dos testes de segurança do sistema (até 1,0 pontos).
5 - A documentação deve apresentar a implementação e resultados dos testes de performance e escalabilidade do sistema (até 1,0 pontos).
6 - O documento deve ser coeso, apresentando o desenvolvimento do projeto do começo ao fim de modo que a sua reprodução posterior seja possível (até 1,0 pontos).
7 - O documento deve apresentar de forma clara e acessível as orientações para execução do software desenvolvido (até 1,5 pontos).
O grupo deverá entregar a versão final da documentação do projeto desenvolvido. Para o refinamento a ser feito na última sprint, deve-se considerar as issues registradas pelo professor orientador no decorrer do projeto. # Padrão de entrega:
1 - O texto desenvolvido pelo grupo deve estar disponível no repositório do GitHub (branch main), dentro da pasta docs e em formato markdown.
2 - As figuras utilizadas no documento devem sempre ser referenciadas no texto, com descrições textuais que estimulem a coesão entre o que é apresentado visualmente e o restante do texto.
3 - Todas as figuras utilizadas na documentação devem estar salvas dentro da pasta docs, em uma subpasta chamada assets.
4 - As issues abertas pelo orientador no decorrer do projeto somente podem ser fechadas por ele. A condição fundamental para o fechamento de um issue é a existência de ao menos um commit que referencie aquele issue diretamente. # Padrão de qualidade:
1 - Fechamento adequado das issues de documentação abertas pelo professor orientador (até 2,5 pontos).
2 - O documento deve apresentar os objetivos, metas e requisitos do projeto de forma clara e, quando cabível, quantificável (até 1,0 pontos).
3 - Deve-se apresentar uma descrição detalhada da implementação do sistema, com diagramas UML de sequência e implementação devidamente integrados à explicação textual (até 2,0 pontos).
4 - A documentação deve apresentar a implementação e resultados dos testes de segurança do sistema (até 1,0 pontos).
5 - A documentação deve apresentar a implementação e resultados dos testes de performance e escalabilidade do sistema (até 1,0 pontos).
6 - O documento deve ser coeso, apresentando o desenvolvimento do projeto do começo ao fim de modo que a sua reprodução posterior seja possível (até 1,0 pontos).
7 - O documento deve apresentar de forma clara e acessível as orientações para execução do software desenvolvido (até 1,5 pontos).