From 3eba1b1eec69e88e082c9756a56e728b003950b6 Mon Sep 17 00:00:00 2001 From: ingridSCarvalho Date: Fri, 30 Aug 2024 23:49:04 -0300 Subject: [PATCH 1/3] [feat] - update quality document --- docs/gestao/planoQualidade.md | 53 ++++++++++++++++++++++++++++++++++- 1 file changed, 52 insertions(+), 1 deletion(-) diff --git a/docs/gestao/planoQualidade.md b/docs/gestao/planoQualidade.md index 459ff20..998672c 100644 --- a/docs/gestao/planoQualidade.md +++ b/docs/gestao/planoQualidade.md @@ -5,17 +5,68 @@ De acordo com a ISO 25010, a qualidade de um produto de software é definida pelo grau em que ele atende aos requisitos de seus usuários, agregando valor. Esses requisitos, que incluem funcionalidade, desempenho, segurança, manutenibilidade, entre outros, são representados no modelo de qualidade, que categoriza a qualidade do produto em características e subcaracterísticas. Para alcançar esses requisitos, é essencial desenvolver e monitorar métricas de forma contínua. O objetivo do planejamento de qualidade é descrever como esse monitoramento foi realizado durante o projeto. + ## Processo de Qualidade Para a coleta de métricas em nosso projeto, integramos cada serviço desenvolvido com a ferramenta SonarQube. Utilizamos a interface SonarCloud, que proporciona uma visibilidade mais amigável para a análise de todas as métricas coletadas em cada serviço. +O processo se caracteriza na validação de us com o cliente por critérios de aceitação e protótipo, desenvolvimento, aceitação e apontamento de melhorias + +## Métricas Monitoradas: +* Cobertura de Código +* Duplicação de Código +* Vulnerabilidades e Bugs +* Integração com CI/CD: Configuração do SonarCloud com pipelines de integração contínua. +* Alertas e Relatórios: Configuração de thresholds para alertas automáticos e geração de relatórios. + +## Políticas de Código e Revisão +* Pull Requests e Code Review: Processo de revisão de código e melhores práticas para garantir qualidade. +* Padrões de Codificação: Ferramentas e regras aplicadas para padronização do código. +* Merge Guidelines: Critérios para fusão de branches e deploy. + +## Ferramentas de Teste +**Vitest**: Framework de testes rápido e leve, projetado para o ecossistema JavaScript, com foco em integração com Vite. Suporta mocks, TypeScript e testes ESM, acelerando o desenvolvimento front-end. + +**SonarCloud**: plataforma de análise de código que identifica bugs, vulnerabilidades e code smells. Oferece suporte a várias linguagens, integrando-se facilmente ao fluxo CI/CD para garantir a qualidade do código. + +**ZenHub**: ferramenta de gerenciamento de projetos que se integra ao GitHub, oferecendo recursos como quadros kanban e relatórios de produtividade + +## Acompanhamento de métricas do sonar + +### Release 1 -![sonarCloud](../docs/assets/sonarCloud.png) +Funcionalidades presentes: +- US01 - Fazer login +- US02 - Solicitar filiação +- US04 - Cadastrar usuários +- US33 - Atualizar dados de usuário + +### Release 2 +Funcionalidades presentes: +- US02 - Solicitar filiação (Ajustes pedidos na Release 1) +- US19- Cadastrar benefícios +- US34 - Gerenciar filiações + +### Release 3 +Funcionalidades presentes: +- US03 - Cadastrar fornecedores +- US05 - Cadastrar contas bancárias +- US17 - Cadastrar perfis no sistema +### Release MVP +Funcionalidades presentes: +- US01 - Fazer login no sistema (Ajustes pedidos na Release 1) +- US03 - Cadastrar fornecedores (Ajustes pedidos na Release 3) +- US16 - Visualizar dashboard sobre os sindicalizados +- US20 - Cadastrar movimentações financeiras +- US23 - Consulta do Histórico de Contribuições do sindicalizado +- US35 - Cadastro de órgão/lotação +- US34 - Gerenciar solicitações de filiação (Ajustes pedidos na Release 2) ## Histórico de Versões | Alteração | Data | Autor | |----------------------|----------|--------------| | Criação do documento | 28/07/24 | Ingrid Carvalho | +| Atualizações sobre o sonar| 22/08/2024 | Ingrid Carvalho | ## Referências [ISO/IEC 25010](https://iso25000.com/index.php/en/iso-25000-standards/iso-25010) From b73f34af81d02a5ca82633f4da219b80f3fc622a Mon Sep 17 00:00:00 2001 From: Ingrid Carvalho <69825746+ingridSCarvalho@users.noreply.github.com> Date: Sat, 31 Aug 2024 00:04:47 -0300 Subject: [PATCH 2/3] [Fix] - Update planoQualidade.md --- docs/gestao/planoQualidade.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/gestao/planoQualidade.md b/docs/gestao/planoQualidade.md index 998672c..5c7d2bc 100644 --- a/docs/gestao/planoQualidade.md +++ b/docs/gestao/planoQualidade.md @@ -8,8 +8,11 @@ De acordo com a ISO 25010, a qualidade de um produto de software é definida pel ## Processo de Qualidade -Para a coleta de métricas em nosso projeto, integramos cada serviço desenvolvido com a ferramenta SonarQube. Utilizamos a interface SonarCloud, que proporciona uma visibilidade mais amigável para a análise de todas as métricas coletadas em cada serviço. -O processo se caracteriza na validação de us com o cliente por critérios de aceitação e protótipo, desenvolvimento, aceitação e apontamento de melhorias +Para garantir a qualidade do projeto, integramos cada serviço desenvolvido com a ferramenta SonarQube, utilizando a interface SonarCloud para proporcionar uma análise mais amigável e detalhada de todas as métricas coletadas. O processo é orientado pela validação das US com o cliente, utilizando protótipos e critérios de aceitação, seguido pela implementação contínua de melhorias. Após o desenvolvimento, as funcionalidades passam pelos testes de aceitação conduzidos pelo cliente, assegurando que ajustes e aperfeiçoamentos sejam aplicados. Caso novas melhorias sejam identificadas, elas são incorporadas ao processo de desenvolvimento, reforçando a qualidade do produto. + +

+ eps qualidade +

## Métricas Monitoradas: * Cobertura de Código @@ -66,7 +69,7 @@ Funcionalidades presentes: | Alteração | Data | Autor | |----------------------|----------|--------------| | Criação do documento | 28/07/24 | Ingrid Carvalho | -| Atualizações sobre o sonar| 22/08/2024 | Ingrid Carvalho | +| Atualizações sobre o sonar| 31/08/2024 | Ingrid Carvalho | ## Referências [ISO/IEC 25010](https://iso25000.com/index.php/en/iso-25000-standards/iso-25010) From 162daf2f1c22693fe56f31c17a4020ba95ae3bf9 Mon Sep 17 00:00:00 2001 From: saracampss Date: Sun, 8 Sep 2024 15:23:37 -0300 Subject: [PATCH 3/3] [fix] - review qualidade doc and add it to mkdocs Signed-off-by: saracampss --- docs/gestao/planoQualidade.md | 48 ++++++++++++++++++++++------------- mkdocs.yml | 1 + 2 files changed, 32 insertions(+), 17 deletions(-) diff --git a/docs/gestao/planoQualidade.md b/docs/gestao/planoQualidade.md index 34878d5..3ed007a 100644 --- a/docs/gestao/planoQualidade.md +++ b/docs/gestao/planoQualidade.md @@ -1,11 +1,9 @@ # Plano de Qualidade - ## Introdução De acordo com a ISO 25010, a qualidade de um produto de software é definida pelo grau em que ele atende aos requisitos de seus usuários, agregando valor. Esses requisitos, que incluem funcionalidade, desempenho, segurança, manutenibilidade, entre outros, são representados no modelo de qualidade, que categoriza a qualidade do produto em características e subcaracterísticas. Para alcançar esses requisitos, é essencial desenvolver e monitorar métricas de forma contínua. O objetivo do planejamento de qualidade é descrever como esse monitoramento foi realizado durante o projeto. - ## Processo de Qualidade Para garantir a qualidade do projeto, integramos cada serviço desenvolvido com a ferramenta SonarQube, utilizando a interface SonarCloud para proporcionar uma análise mais amigável e detalhada de todas as métricas coletadas. O processo é orientado pela validação das US com o cliente, utilizando protótipos e critérios de aceitação, seguido pela implementação contínua de melhorias. Após o desenvolvimento, as funcionalidades passam pelos testes de aceitação conduzidos pelo cliente, assegurando que ajustes e aperfeiçoamentos sejam aplicados. Caso novas melhorias sejam identificadas, elas são incorporadas ao processo de desenvolvimento, reforçando a qualidade do produto. @@ -15,20 +13,25 @@ Para garantir a qualidade do projeto, integramos cada serviço desenvolvido com

## Métricas Monitoradas: -* Cobertura de Código -* Duplicação de Código -* Vulnerabilidades e Bugs -* Integração com CI/CD: Configuração do SonarCloud com pipelines de integração contínua. -* Alertas e Relatórios: Configuração de thresholds para alertas automáticos e geração de relatórios. + +- Cobertura de Código +- Duplicação de Código +- Vulnerabilidades e Bugs +- Integração com CI/CD: Configuração do SonarCloud com pipelines de integração contínua. +- Alertas e Relatórios: Configuração de thresholds para alertas automáticos e geração de relatórios. ## Políticas de Código e Revisão -* Pull Requests e Code Review: Processo de revisão de código e melhores práticas para garantir qualidade. -* Padrões de Codificação: Ferramentas e regras aplicadas para padronização do código. -* Merge Guidelines: Critérios para fusão de branches e deploy. -## Ferramentas de Teste +- Pull Requests e Code Review: Processo de revisão de código e melhores práticas para garantir qualidade. +- Padrões de Codificação: Ferramentas e regras aplicadas para padronização do código. +- Merge Guidelines: Critérios para fusão de branches e deploy. + +## Ferramentas de Teste + **Vitest**: Framework de testes rápido e leve, projetado para o ecossistema JavaScript, com foco em integração com Vite. Suporta mocks, TypeScript e testes ESM, acelerando o desenvolvimento front-end. +**Jest**: Framework de testes completo para JavaScript, amplamente usado para testes de unidade, integração e ponta a ponta. Oferece suporte a mocks, snapshots, e uma interface fácil de usar. Integrado com Babel e TypeScript, é ideal para projetos React e Node.js, fornecendo relatórios detalhados e feedback rápido para desenvolvedores. + **SonarCloud**: plataforma de análise de código que identifica bugs, vulnerabilidades e code smells. Oferece suporte a várias linguagens, integrando-se facilmente ao fluxo CI/CD para garantir a qualidade do código. **ZenHub**: ferramenta de gerenciamento de projetos que se integra ao GitHub, oferecendo recursos como quadros kanban e relatórios de produtividade @@ -36,26 +39,34 @@ Para garantir a qualidade do projeto, integramos cada serviço desenvolvido com ## Acompanhamento de métricas do sonar ### Release 1 + Funcionalidades presentes: + - US01 - Fazer login - US02 - Solicitar filiação - US04 - Cadastrar usuários - US33 - Atualizar dados de usuário - + ### Release 2 + Funcionalidades presentes: + - US02 - Solicitar filiação (Ajustes pedidos na Release 1) - US19- Cadastrar benefícios - US34 - Gerenciar filiações - + ### Release 3 + Funcionalidades presentes: + - US03 - Cadastrar fornecedores - US05 - Cadastrar contas bancárias - US17 - Cadastrar perfis no sistema ### Release MVP + Funcionalidades presentes: + - US01 - Fazer login no sistema (Ajustes pedidos na Release 1) - US03 - Cadastrar fornecedores (Ajustes pedidos na Release 3) - US16 - Visualizar dashboard sobre os sindicalizados @@ -65,10 +76,13 @@ Funcionalidades presentes: - US34 - Gerenciar solicitações de filiação (Ajustes pedidos na Release 2) ## Histórico de Versões -| Alteração | Data | Autor | -|----------------------|----------|--------------| -| Criação do documento | 28/07/24 | Ingrid Carvalho | -| Atualizações sobre o sonar| 31/08/2024 | Ingrid Carvalho | + +| Alteração | Data | Autor | +| -------------------------- | ---------- | --------------- | +| Criação do documento | 28/07/24 | Ingrid Carvalho | +| Atualizações sobre o sonar | 31/08/2024 | Ingrid Carvalho | +| Revisão | 08/09/2024 | Sara Campos | ## Referências + [ISO/IEC 25010](https://iso25000.com/index.php/en/iso-25000-standards/iso-25010) diff --git a/mkdocs.yml b/mkdocs.yml index 7211182..f515496 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -39,6 +39,7 @@ nav: - Arquitetura: gestao/arquitetura.md - EAP: gestao/eap.md - Metodologia: gestao/metodologia.md + - Qualidade: gestao/planoQualidade.md - Custo: gestao/custo.md - Guia de contribuição: gestao/guia-de-contribuicao.md - Alinhamento da equipe: