Autor: Anderson Melo

  • A importância do Guia de Estilos no processo de desenvolvimento de software

    A importância do Guia de Estilos no processo de desenvolvimento de software

    A competividade do mercado e a necessidade de projetos serem entregues de maneira mais rápida e com qualidade é algo que toda empresa almeja. Não existe uma fórmula mágica para atingirmos esse objetivo, mas é possível dar pequenos passos para chegarmos lá. A padronização de alguns processos internos é um desses passos, principalmente quando nos referimos ao desenvolvimento de software.

    Na Neomind, um dos processos que recebeu uma atenção especial foi a etapa de criação e desenvolvimento de interfaces. Tudo começou com um Guia de Estilos criado pela equipe de User Experience e é essa história que vamos contar a você hoje.

    Por que criar um Guia de Estilos?

    Seguir padrões pré-estabelecidos é muito importante para manter a consistência de um produto. Isso permite com que o processo de criação e desenvolvimento aconteça de forma mais rápida, possibilitando a viabilidade dos projetos executados e garantindo a qualidade do produto.

    Percebemos isso quando ainda não tínhamos um padrão de código-fonte. Na ocasião, muitos dos componentes acabavam sendo criados diversas vezes, por várias pessoas e sempre com um código-fonte diferente. Além disso, existiam pontos de inconsistência que não batiam com o mockup das telas, tanto no estilo, como no comportamento daquele componente.

    Foi aí que vimos a necessidade da adoção de um guia de estilos (style guide). Com a adoção, o projeto passou a facilitar a aprendizagem dos padrões utilizados no design e no código-fonte do produto, além de se tornar um recurso acessível a todos os colaboradores para visualização dos componentes.

    Era uma vez… nosso Style Guide

    No início, nosso Guia de Estilos era um pequeno livro (físico) e um arquivo PDF, nos quais eram exibidos os padrões de cores, tamanhos de fontes, botões, iconografia e alguns modelos de componentes. Manter um guia de estilos físico trazia certos problemas. Um deles era o de que a cada alteração ou inserção de um componente novo era necessário imprimir uma nova versão e descartar a antiga, o que ocasionava em custos de impressão e muito desperdício de papel (fato que não combina com uma mentalidade paperless, a qual somos adeptos aqui na Neomind).

    Percebendo isso, começamos a utilizar apenas o arquivo PDF. Desse modo, todos os colaboradores passaram a ter o documento em seus computadores e a atualização do mesmo era mais fácil.

    Elementos do Fusion Platform no Guia de Estilos da Neomind

    Nosso guia de estilos passou para uma nova etapa, com o projeto batizado de “Style Guide”. O objetivo era o de torná-lo digital e, para isso, ele foi baseado no framework Bootstrap.

    O Bootstrap foi criado em 2010 por um designer e um desenvolvedor do Twitter, com o propósito de facilitar o desenvolvimento de telas. Essencialmente, trata-se de uma biblioteca que possui diversos componentes com interfaces amigáveis e modernas, além da responsividade que facilita muito a criação de telas que necessitam se adaptar conforme a resolução dos monitores, tablets e smartphones.

    Ele é uma das bibliotecas mais populares e mais utilizadas no mundo, em virtude da facilidade de uso, da documentação disponibilizada e por ser totalmente gratuito. Isso faz com que exista também uma grande comunidade envolvida.

    Bootstrap

    Como o Bootstrap possui o seu próprio padrão de interface, fizemos a customização, transformando-o em uma biblioteca específica para uso da Neomind. Além disso, foi necessário adaptar os componentes para que os mesmos ficassem com a cara do Fusion Platform. Fazendo isso, conseguimos manter a nossa identidade visual e adaptar os comportamentos dos componentes. Também atualizamos nossa biblioteca com componentes que já haviam sido criados ou que estavam em processo de desenvolvimento.

    Como trabalhamos com o Guia de Estilos

    Todas as interfaces criadas para o Fusion Platform são modeladas com base nos comportamentos e necessidades dos usuários, que são nossos clientes. Isso acontece porque buscamos sempre deixar nosso produto intuitivo e fácil de ser utilizado.

    Toda vez que notamos que os usuários estão com dificuldades de realizar determinada ação, reavaliamos a funcionalidade e aplicamos os devidos ajustes para torná-la mais usual possível. Por isso é tão importante manter nossos clientes próximos dos nossos processos de criação e de desenvolvimento.

    Com o guia de estilos, nossa equipe de UX consegue ter uma referência para a criação de novas telas e funcionalidades, sem que seja necessário criar diferentes componentes com comportamentos similares e até mesmo iguais. Assim é possível ter ganhos de produtividade na etapa de criação e de desenvolvimento, pois os componentes são desenvolvidos apenas uma vez.

    Muitos dos componentes possuem variações, como por exemplo o componente de seleção de itens, onde em um dos modelos é possível selecionar apenas um dos itens. Em outro, pode-se selecionar vários itens, itens com ícones ou fotos, itens pré-selecionados e opção apenas para o modo de visualização.

    Design Fusion Platform
    Exemplo de componente do Guia de Estilos

    Quando há a necessidade de criação de um novo componente, é realizado um alinhamento da equipe de UX com o time de Inovação para discutir a viabilidade técnica. Além de seguir os padrões pré-estabelecidos, é necessário que os componentes sejam compatíveis com diferentes navegadores e versões antigas desses navegadores, o que muitas vezes inviabiliza alguns cenários planejados.

    O código-fonte dos componentes deve ser criado de uma maneira que possibilite a reutilização em outros cenários sem que seja necessário realizar ajustes. É claro que algumas vezes mudanças precisam ser feitas, pois alguns cenários podem ser muito específicos e não terem sido pensados no momento de criação.

    Fechando…

    Todos os componentes ficam disponíveis para serem consultados e testados para que o cliente possa ter sempre o melhor em interface. Como o Style Guide é um projeto a parte, nossos desenvolvedores só precisam fazer o download do projeto em nosso repositório e executá-lo.

    Para os colaboradores da empresa, o Guia de Estilos é de grande valia, pois dessa forma é possível entender os padrões que foram pré-estabelecidos no design e no desenvolvimento do produto e conhecer a gama de componentes disponíveis.

    Um guia de estilos não é algo imutável. Por isso, é importante mantê-lo em constante evolução, já que a tecnologia evolui rapidamente e precisamos acompanhá-la para não ficarmos para trás.

    Referências:
    Coletivo UX, Get Bootstrap, UX Design Brasil, Guia de Estilo Web



  • Atividades não documentadas: não deixe a informalidade tomar conta da sua rotina

    Atividades não documentadas: não deixe a informalidade tomar conta da sua rotina

    A produtividade é um fator muito importante na rotina de trabalho. Não é à toa que estamos cercados de artigos, vídeos e livros sobre como gerenciar o tempo de maneira produtiva. A conhecida Gestão do Tempo nunca foi tão abordada quanto hoje em dia.

    Muitas vezes, justamente por estarmos em busca da produtividade, acabamos deixando de lado fatores que são muito importantes, acreditando que o desempenho será maior. Isso acontece pois entendemos que, de certa forma, esses fatores acabam consumindo nosso tempo precioso. E assim, acabamos optando erroneamente por uma opção mais simples.

    Um dos fatores que acaba ficando de fora é a existência de atividades não documentadas, o que faz com que a empresa não atue com formalidade nas documentações.

    Mas, o que significa formalidade?

    Segundo o Dicionário Priberam, formalidade seria “Condição necessária para certos atos ou documentos se poderem executar ou serem válidos“. Com base nesse conceito, trocar a formalidade pela informalidade no ambiente de trabalho parece ser algo um pouco trabalhoso, concorda?.

    Um dos grandes problemas da comunicação informal está na falta do controle que um gestor tem sobre as atividades executadas. Se uma atividade não está centralizada em um determinado local, essa informação pode ser facilmente perdida ou até mesmo vir a ser uma informação inválida. Em outras palavras: atividades não documentadas são sinônimos de informalidade.

    Como resolver problemas de atividades não documentadas?

    Qualquer mudança durante a realização de uma atividade pode ocasionar em um grande problema no final, principalmente se essa mudança ocorrer de forma informal, ou seja, não for validada e aprovada. Para resolver problemas envolvendo atividades não documentadas, podemos seguir algumas ações.

    Uma delas é possibilitar que todas as atividades sejam encontradas e acessadas facilmente. Para isso, elas precisam estar bem identificadas e, nesse caso, uma boa nomeação do documento e a data são informações essenciais a serem disponibilizadas.

    É indispensável que a descrição da atividade seja clara, pois quem executá-la precisa entender tudo o que foi pedido, saber o prazo para realização e até mesmo a ordem de execução das atividades. Apesar de parecer algo simples, essas informações podem economizar minutos, ou, às vezes, até mesmo horas preciosas no dia de um colaborador. Portanto, se pensarmos em um número grande de colaboradores, atividades não documentadas representarão perda de dinheiro para a empresa.

    Exemplos de documentação de atividades

    A documentação de atividades é válida para qualquer ação que ocorra em uma empresa:

    • Solicitações de compras,
    • Solicitações de viagens,
    • Autorizações específicas para realização de alguma atividade (um evento por exemplo),
    • Autorização de acesso a determinadas áreas e setores da empresa (muito útil quando um terceiro precisa realizar algum serviço, como consertar o alarme por exemplo),
    • Entre outras.

    Perceba que a formalidade tem um foco muito claro de controlar atividades da empresa por meio do gerenciamento da documentação da empresa. Em outras palavras: formalidade representa atuar para eliminar atividades não documentadas.

    Como a Neomind eliminou a informalidade e aprimorou a documentação das atividades de seus times?

    Para exemplificar, utilizarei como exemplo o time de Inovação da Neomind. De forma geral, essa é a equipe que atua diretamente no desenvolvimento de novas funcionalidades e na melhoria de módulos já existentes no Fusion Platform, mantendo o produto sempre atualizado conforme as necessidades do mercado e, principalmente, conforme a constante atualização das tecnologias.

    Com o Fusion GED é possível fazer a gestão de todo o ciclo de vida dos documentos. Seguindo com o exemplo da equipe de Inovação, utilizamos o Fusion GED para fazer toda a gestão das especificações de funcionalidades geradas.

    Sempre que uma nova funcionalidade do Fusion é desenvolvida, ela precisa passar por algumas etapas. São realizadas várias reuniões, feitas diversas análises e estudos de viabilidade para então chegarmos na geração da especificação. Nessa especificação, criada pelo time de User Experience (UX), são detalhadas todas as regras de negócio da funcionalidade e é também definida toda a parte visual das telas.

    Como a especificação é um dos principais documentos utilizados no nosso dia a dia, ela é publicada no GED, seguindo para o fluxo e aprovação dos gestores. Nesse processo podem acontecer reprovações de algum requisito ou até mesmo do visual. Se esse for o caso, o documento retorna para o time de UX, o qual fará as devidas avaliações e correções.

    Após a correção, o documento vai novamente para aprovação dos gestores e segue dois caminhos:

    • Sendo aprovada, a especificação é liberada para o time de Inovação para então darmos início ao desenvolvimento da funcionalidade.
    • Se por algum motivo for necessário realizar algum ajuste visual ou nas regras de negócio, a especificação passa por todo o processo até ser liberada novamente.

    Perceba que o importante é garantir que todos estejam cientes das alterações e que o documento esteja armazenado em um local seguro, onde todos os envolvidos possuem acesso.

    Assim que o desenvolvimento da funcionalidade é finalizado, o time de Quality (QA) é acionado. Ele é responsável por testar todas as regras de negócio e, junto com a equipe de UX, certificar-se de que o visual está correspondente ao que foi projetado. Para isso, mais uma vez a especificação é consultada dentro do GED e os testes são realizados com base no documento que está publicado.

    Ter o documento disponibilizado em um único lugar reduz o problema de que os envolvidos no projeto possam estar trabalhando com uma versão desatualizada da especificação, facilita a busca e garante que o documento não será esquecido ou até mesmo perdido. Se dois meses ou 10 anos depois que a funcionalidade foi finalizada alguém precisar de alguma informação referente ao requisito, esse documento ainda estará disponível.

    Com a utilização do Fusion GED para fazer o gerenciamento dos documentos, evitamos o desperdício de papel, que pode ser rasurado facilmente (sobre o assunto, recomendo a leitura do artigo Paperless: o que é e como dar os primeiros passos para a era sem papel).

    Concluindo

    A documentação das atividades é essencial nas organizações, por isso, devemos tomar cuidado com a informalidade e evitar os possíveis atalhos que em um primeiro momento podem encurtar o caminho, mas que no final podem dobrar o percurso.

    As informações da atividade são essenciais e devem ser preenchidas para facilitar a busca e o entendimento dos executores. É importante avaliar uma ferramenta para fazer a gestão desses documentos e que se encaixe nas necessidades do seu negócio, além de verificar qual a melhor forma de utilizá-la no seu time ou na sua empresa, garantindo que ela funcione de maneira eficaz e atinja os objetivos estabelecidos.

    Todavia, lembre-se que apenas a escolha da ferramenta não salvará sua vida e a do seu time. É necessário aplicar mudanças na cultura dos colaboradores para que se habituem a eliminar atividades não documentadas e deixar de lado a informalidade que abordei neste artigo. Todo esse processo pode se tornar um pouco burocrático, mas acredito que você concordará comigo que somente assim conseguiremos reduzir os erros e evitar possíveis transtornos.

    Não esqueça: fique por dentro de nossos conteúdos e acompanhe o Blog da Neomind. Ou, ainda, deixe um comentário contando o que achou. Esperamos que ele tenha sido útil para você.

    documentação de processos

    Referências
    Priberam, Unifac, 1doc

Fale com a gente