Documentação do projeto de software: 30% implementação mais rápida de novas funcionalidades

A Innowise desenvolveu documentação do projeto para compreender a arquitetura, a estrutura e os componentes de um sistema de software.

Cliente

Indústria

Banking

Região

Cliente desde

2023

O nosso cliente é um ator proeminente no sector dos sistemas de pagamento bancário, operando num mercado altamente competitivo e dinâmico. A empresa é conhecida pela sua abordagem inovadora à tecnologia financeira e tem uma presença significativa no seu domínio.

As informações pormenorizadas sobre o cliente não podem ser divulgadas ao abrigo dos termos do NDA.

Desafio

Colmatar o défice de documentação

O cliente estava a preparar-se para obter certificações ISO, um passo fundamental para aumentar a sua credibilidade no mercado e eficiência operacional. No entanto, deparou-se com um grande obstáculo: a ausência de documentação de projectos de software. Esta lacuna não era apenas um obstáculo à certificação, mas também um estrangulamento na melhoria das suas operações. Os novos membros da equipa tinham dificuldades com a integração e os programadores perdiam tempo precioso a desvendar as complexidades do sistema para cada nova funcionalidade adicionada.

Além disso, a falta de documentação clara constituía uma barreira significativa na comunicação entre as partes interessadas, os programadores e os responsáveis pela manutenção do sistema. A expetativa do cliente em relação a nós não era apenas preencher esta lacuna, mas criar uma base robusta que facilitasse futuras melhorias e manutenção do sistema.

Solução

Fornecimento de documentação sobre o software do projeto para uma melhor compreensão e eficiência do sistema

Na Innowise, começámos a recolher e a documentar os pormenores intrincados do sistema de software do cliente. A nossa solução incluía três componentes principais: especificação de requisitos de software (SRS), documento de arquitetura da solução (SAD) e normas de design. Ao longo do processo, os programadores do cliente colaboraram connosco, fornecendo informações valiosas sobre a estrutura do sistema, os formatos de dados, as funcionalidades do processo e muito mais.

Especificação de requisitos de software (SRS)

A primeira tarefa da nossa equipa consistiu em obter uma compreensão holística dos objectivos comerciais do cliente e dos requisitos do sistema. Esta fase consistiu em traçar um quadro abrangente do que o sistema pretendia alcançar no contexto mais alargado das operações comerciais do cliente.

Definição do objetivo comercial e do sistema

Começámos por definir o objetivo do negócio e do sistema. Isto foi crucial para alinhar as funcionalidades do software com os objectivos estratégicos do cliente. Realizámos discussões aprofundadas com os principais intervenientes para confirmar que o nosso entendimento era exato e englobava aspirações futuras. Este conhecimento profundo permitiu-nos antecipar não só os requisitos actuais, mas também os futuros.

Definição dos requisitos funcionais

Em seguida, delineámos os requisitos funcionais num formato cuidadosamente estruturado que detalhava todos os aspectos da funcionalidade do sistema - desde cálculos básicos a algoritmos complexos de processamento de dados. Estes requisitos foram classificados por ordem de prioridade com base no seu impacto na eficácia global do sistema e na eficiência operacional do cliente.

Casos de utilização e diagramas BPMN

Para complementar as nossas descrições textuais, utilizámos casos de utilizador e diagramas de notação e modelo de processos empresariais (BPMN). Estas ferramentas foram muito úteis para visualizar as operações do sistema, fornecendo uma representação gráfica dos fluxos de trabalho e dos processos. Os casos de utilização ofereceram cenários do mundo real que ajudaram a compreender a forma como os diferentes utilizadores interagiriam com o sistema, enquanto os diagramas BPMN ofereceram uma visão mais técnica dos fluxos de processos dentro do sistema.

Documentação exaustiva dos componentes e características

A nossa equipa não se limitou aos requisitos de alto nível. Aprofundámos os detalhes, documentando cada componente e caraterística do sistema. Esta documentação exaustiva abrangeu tudo, desde elementos da interface do utilizador a back-end processos. O nosso objetivo era garantir que os programadores e os responsáveis pela manutenção do sistema pudessem compreender e navegar facilmente no sistema.

Documento de arquitetura da solução (SAD)

Após o desenvolvimento da especificação dos requisitos de software, a nossa atenção passou a centrar-se na elaboração do documento de arquitetura da solução.

Estabelecer uma ponte entre as necessidades técnicas e os objectivos comerciais

Os projectos técnicos enfrentam desafios significativos para alinhar os aspectos técnicos com os objectivos comerciais. O nosso documento desempenhou um papel fundamental para colmatar esta lacuna. Ao descrever claramente a forma como cada elemento da arquitetura do sistema contribuía diretamente para os objectivos comerciais, fornecemos uma justificação clara para as decisões de arquitetura.

Documentar o estado atual da tecnologia

Uma parte essencial da nossa abordagem foi documentar o estado atual da tecnologia no sistema do cliente. Isto envolveu uma análise minuciosa das tecnologias, estruturas e ferramentas utilizadas na criação do sistema. Avaliámos a sua eficácia, escalabilidade e a forma como se integravam com outros componentes do sistema. Esta análise foi fundamental para identificar áreas de melhoria e garantir que a arquitetura proposta fosse construída sobre uma base tecnológica sólida e moderna.

Normas de conceção

A peça final do nosso puzzle de documentação eram as normas de conceção. Esta secção foi crucial, pois definiu as do sistema de pagamento identidade visual e funcional.

Descrições estéticas pormenorizadas

Começámos com os aspectos estéticos, documentando os esquemas de cores, a tipografia e a linguagem visual geral utilizada no sistema. Não se tratou apenas de listar as cores e os nomes dos tipos de letra, mas também de aprofundar a psicologia subjacente a estas escolhas, explicando como se alinham com a identidade da marca e os objectivos da experiência do utilizador. Por exemplo, explicámos por que razão foram escolhidos tons específicos pelo seu apelo visual e potencial impacto psicológico nos utilizadores, melhorando a usabilidade e o envolvimento do utilizador.

Elementos funcionais e interacções

Para além da estética, explorámos os elementos funcionais. Isto incluiu nomes de campos, cabeçalhos e a disposição da informação em cada ecrã. Analisámos em pormenor a conceção de elementos interactivos, como botões, cursores e menus pendentes, documentando o seu funcionamento em diferentes estados (por exemplo, pairar, clicar, inativo). O nosso objetivo era garantir a consistência e a intuitividade das interacções do utilizador em todo o sistema.

Notificações e ecrãs pop-up

Detalhámos o design das mensagens pop-up para erros e confirmações de acções, garantindo que eram visualmente consistentes e transmitiam informações claras, concisas e úteis. Também nos concentrámos bastante no sistema de notificação, que incluía alertas por correio eletrónico e notificações no sistema. Isto envolveu detalhar o design dos modelos de correio eletrónico, o tom das mensagens e os accionadores destas notificações. Assegurámos que estas notificações não eram apenas informativas, mas também concebidas de uma forma que reflectia a voz da marca e melhorava a experiência geral do utilizador.

Processo

Fase de descoberta

Começámos com uma fase de descoberta, compreendendo profundamente o sistema e os requisitos do cliente. Isto envolveu a criação de um roteiro detalhado do projeto, a definição de marcos claros e a identificação de potenciais desafios e soluções para conseguir uma experiência de documentação sem problemas.

Fase de documentação

Durante a fase de documentação, produzimos o SRS, o SAD e as normas de conceção. Esta fase foi iterativa, envolvendo validação e refinamento constantes.

Comunicação e ferramentas

A comunicação foi fundamental. Utilizámos vários canais como videochamadas, e-mails e plataformas de colaboração para uma interação constante. O acompanhamento das tarefas foi gerido através do Jira, mantendo a transparência e o progresso atempado.

Equipa

Analista de negócios

Designer UI/UX

Arquiteto

Resultados

30% Implementação mais rápida de novas funcionalidades e processo de integração simplificado

A solução que fornecemos para o sistema de pagamento bancário o projeto foi abrangente e multifacetado, tendo conduzido a resultados tangíveis e com impacto. Em primeiro lugar, o cliente está agora prestes a obter a certificação ISO. Em segundo lugar, a nossa documentação abrangente melhorou o processo de integração dos membros da equipa recém-contratados. Mais ainda, resultou numa integração mais fluida de novas funcionalidades, poupando tempo e reduzindo as curvas de aprendizagem dos programadores.

A redução da complexidade e a maior clareza nas operações do sistema significam que a equipa pode concentrar-se mais na inovação e menos na navegação nas estruturas existentes. Por último, a clareza das funcionalidades, requisitos e restrições do sistema melhorou consideravelmente a compreensão e a comunicação entre todos os intervenientes.

Duração do projecto

outubro de 2023 - dezembro de 2023

30%

implementação mais rápida de novas funcionalidades

processo de integração mais rápido

Casos relacionados

Contactar-nos!

Marcar uma chamada ou preencha o formulário abaixo e entraremos em contacto consigo assim que tivermos processado o seu pedido.

Nome

Empresa

Correio electrónico

Telefone

Mensagem Inclua os detalhes do projeto, a duração, o conjunto de tecnologias, os profissionais de TI necessários e outras informações relevantes

Gravar uma mensagem de voz sobre o seu
projeto para nos ajudar a compreendê-lo melhor

Anexar documentos adicionais, se necessário

Enviar ficheiro

Pode anexar até 1 ficheiro de 2MB no total. Ficheiros válidos: pdf, jpg, jpeg, png

Informamos que, ao clicar no botão Enviar, o Innowise's processará os seus dados pessoais de acordo com a nossa Política de Privacidade com o objectivo de lhe fornecer informações adequadas.

O que é que acontece a seguir?

Após termos recebido e processado o seu pedido, entraremos em contacto consigo para detalhar as necessidades do seu projecto e assinar um NDA para garantir a confidencialidade das informações.

Após a análise dos requisitos, os nossos analistas e programadores elaboram uma proposta de projecto com o âmbito dos trabalhos, tamanho da equipa, tempo e custos e custos.