Veja como o cliente RS21 e as próprias equipes de engenharia da Guru usam o Guru para tornar suas documentações de desenvolvimento mais robustas, incluindo processos e modelos.
Todas as equipes de engenharia dependem de algum tipo de ferramenta de documentação para comunicar informações importantes sobre o produto com seus colegas. Para pequenas equipes que estão começando, isso pode ser tão simples quanto um Google Doc, e para equipes maiores com produtos complexos, isso pode ser uma wiki hierárquica. Dependendo de como a empresa está estruturada, outras equipes (como RH ou marketing) também podem usar essa wiki, ou ter outras áreas onde armazenam as informações de suas equipes.
Ao se juntar a uma nova equipe de engenharia (internamente ou externamente), o processo de integração é crucial para determinar quão rapidamente um novo colega se sente pronto para contribuir. Desde configurar seu ambiente de codificação até examinar a documentação de recursos, há muito a ser feito para se atualizar e pronto para assumir novos trabalhos.
Para muitas equipes de engenharia, o processo de integração acaba sendo trabalhoso para outro colega, que é designado como o Mas ao fornecer à sua equipe Cartas verificadas por especialistas, atualizadas, no Guru, os líderes de engenharia da RS21 oferecem aos novos contratados a flexibilidade de se integrar no seu próprio ritmo. Isso permite que eles economizem tempo com seu “amigo” de integração para construir mais relacionamentos interpessoais ou responder perguntas pendentes.
Quando um novo engenheiro se junta à equipe da RS21, eles acessam o Guru para começar a trabalhar em seu material de integração. Eles irão olhar através de um “Painel de Informações da Equipe” onde podem conhecer um pouco sobre seus colegas, usar cartas de infraestrutura para configurar seus ambientes corretamente e ler os padrões de codificação da sua equipe para ter uma ideia de como colaborar melhor com seus novos colegas.
De forma semelhante, no Guru, quando um engenheiro ingressa ou se muda para uma nova equipe, sua integração é feita no Guru. Eles utilizarão Cartas de história da vida para conhecer seus colegas, ver guias sobre como devem esperar trabalhar juntos, e navegar pela Coleção de sua nova equipe no Guru para se familiarizar com as funcionalidades do produto e as áreas que agora são responsáveis.
Melhores Práticas e Padrões da Equipe
Uma vez que toda a equipe está integrada, recursos contínuos, como padrões de codificação e melhores práticas de documentação, também têm um lar no Guru. Quando documentados de uma forma que seja acessível em seus fluxos de trabalho, isso facilita para os engenheiros colaborar produtivamente com o restante da equipe e com o resto da empresa. Isso também os impede de precisar memorizar quaisquer políticas ou procedimentos ou, pior, marcar e depender de documentos desatualizados.
A Coleção de Engenharia da RS21 no Guru inclui um Painel dedicado a diretrizes de processos, incluindo Cartas com instruções para mesclar código, criar um script bash, solicitar uma revisão de código e mais. Eles também têm painéis dedicados ao estilo de sintaxe de codificação acordado pela sua equipe, instruções de configuração de AWS, informações de administração de sistema e mais. Eles ainda têm trechos de código frequentemente usados disponíveis para fácil cópia e colagem em Cartas do Guru.
Além dessas Cartas específicas de engenharia, o Guru também é um ótimo lugar para os engenheiros acessarem melhores práticas interfuncionais e diretrizes para processos entre equipes. Por exemplo, a equipe da RS21 realiza discussões assíncronas usando o Guru para dar aos membros da equipe mais tempo para responder de forma ponderada e para dar a todos uma plataforma igual e justa para contribuir. Instruções sobre como configurar e monitorar essas discussões são mantidas em um modelo do Guru, para que qualquer um possa iniciar uma com facilidade quando necessário.
No Guru, recrutamos equipes fora de nossa organização de desenvolvimento de produto para ajudar com nosso processo de garantia de qualidade (QA). Com opiniões mais diversas, conseguimos identificar melhor bugs, explorar potenciais desafios do cliente e nos proteger contra eles antes do lançamento. Mas um processo tão técnico quanto o QA exige instruções e procedimentos documentados ao envolver equipes interfuncionais. Antes de iniciar o QA para um novo recurso, um líder de equipe de engenharia usará nosso modelo de processo de QA para criar um local único para tudo que nossa equipe e as partes interessadas precisarão para o QA de ponta a ponta. Quando estivermos prontos para iniciar o QA, eles enviarão isso como um anúncio para a equipe e as partes interessadas e incluirão as datas ativas de QA na mensagem.
Planejamento de Projetos e Documentação de Desenvolvimento
Sempre que um novo projeto de desenvolvimento começar, há muita documentação que se segue para garantir que todos tenham o contexto completo que precisam para desempenhar seu papel. Após uma reunião de início, os engenheiros dependem de documentos de requisitos das equipes de produto, dos designs funcionais mais atualizados de sua equipe de UX, textos de sua equipe de marketing ou redação e mais.
E, claro, eles frequentemente precisarão consultar qualquer documentação técnica que impacte o recurso em que estão trabalhando ou que precisem atualizar mais tarde no desenvolvimento.
No Guru, acompanhamos os vários recursos necessários para o desenvolvimento de produtos em um Cartão de Recursos de Projetos Ativos, defendido por cada líder de engenharia de projeto. Essas Cartas são o recurso de referência da equipe de engenharia durante as etapas iniciais do ciclo de vida do desenvolvimento de produtos, e são mantidas atualizadas para refletir quaisquer alterações ao longo do tempo.
À medida que o processo de desenvolvimento avança, a colaboração entre engenharia e design deve ser mantida em harmonia. Mas devido à natureza frequentemente assíncrona e remota do trabalho, designers e engenheiros nem sempre podem se conectar em uma chamada pelo Zoom para discutir quaisquer questões ou feedback. Para garantir que estão seguindo nosso protocolo interno acordado para solicitar feedback sobre o design, nossa equipe de engenharia usa nosso fluxo de trabalho de Feedback sobre Design para Mudanças de UI documentado no Guru.
Documentação a prova de futuro
A documentação sempre foi e sempre será uma parte necessária do trabalho de um engenheiro. Mas o que antes provocava gemidos dolorosos e suspiros angustiados pode se tornar uma parte simples e natural do seu dia a dia quando é trazido diretamente para seu fluxo de trabalho. A extensão do navegador do Guru traz a documentação diretamente para os lugares de que os engenheiros precisam, em vez de forçá-los a mudar de contexto para acessá-la, e Cartas curtas, verificadas por especialistas, aliviam a pressão dos longos artigos de outrora que eram uma dor de cabeça para escrever e ainda mais difíceis de manter. Então, por que aumentar a dívida técnica com documentação desatualizada quando você pode facilmente torná-la a prova de futuro agora mesmo? Comece hoje gratuitamente.
Todas as equipes de engenharia dependem de algum tipo de ferramenta de documentação para comunicar informações importantes sobre o produto com seus colegas. Para pequenas equipes que estão começando, isso pode ser tão simples quanto um Google Doc, e para equipes maiores com produtos complexos, isso pode ser uma wiki hierárquica. Dependendo de como a empresa está estruturada, outras equipes (como RH ou marketing) também podem usar essa wiki, ou ter outras áreas onde armazenam as informações de suas equipes.
Ao se juntar a uma nova equipe de engenharia (internamente ou externamente), o processo de integração é crucial para determinar quão rapidamente um novo colega se sente pronto para contribuir. Desde configurar seu ambiente de codificação até examinar a documentação de recursos, há muito a ser feito para se atualizar e pronto para assumir novos trabalhos.
Para muitas equipes de engenharia, o processo de integração acaba sendo trabalhoso para outro colega, que é designado como o Mas ao fornecer à sua equipe Cartas verificadas por especialistas, atualizadas, no Guru, os líderes de engenharia da RS21 oferecem aos novos contratados a flexibilidade de se integrar no seu próprio ritmo. Isso permite que eles economizem tempo com seu “amigo” de integração para construir mais relacionamentos interpessoais ou responder perguntas pendentes.
Quando um novo engenheiro se junta à equipe da RS21, eles acessam o Guru para começar a trabalhar em seu material de integração. Eles irão olhar através de um “Painel de Informações da Equipe” onde podem conhecer um pouco sobre seus colegas, usar cartas de infraestrutura para configurar seus ambientes corretamente e ler os padrões de codificação da sua equipe para ter uma ideia de como colaborar melhor com seus novos colegas.
De forma semelhante, no Guru, quando um engenheiro ingressa ou se muda para uma nova equipe, sua integração é feita no Guru. Eles utilizarão Cartas de história da vida para conhecer seus colegas, ver guias sobre como devem esperar trabalhar juntos, e navegar pela Coleção de sua nova equipe no Guru para se familiarizar com as funcionalidades do produto e as áreas que agora são responsáveis.
Melhores Práticas e Padrões da Equipe
Uma vez que toda a equipe está integrada, recursos contínuos, como padrões de codificação e melhores práticas de documentação, também têm um lar no Guru. Quando documentados de uma forma que seja acessível em seus fluxos de trabalho, isso facilita para os engenheiros colaborar produtivamente com o restante da equipe e com o resto da empresa. Isso também os impede de precisar memorizar quaisquer políticas ou procedimentos ou, pior, marcar e depender de documentos desatualizados.
A Coleção de Engenharia da RS21 no Guru inclui um Painel dedicado a diretrizes de processos, incluindo Cartas com instruções para mesclar código, criar um script bash, solicitar uma revisão de código e mais. Eles também têm painéis dedicados ao estilo de sintaxe de codificação acordado pela sua equipe, instruções de configuração de AWS, informações de administração de sistema e mais. Eles ainda têm trechos de código frequentemente usados disponíveis para fácil cópia e colagem em Cartas do Guru.
Além dessas Cartas específicas de engenharia, o Guru também é um ótimo lugar para os engenheiros acessarem melhores práticas interfuncionais e diretrizes para processos entre equipes. Por exemplo, a equipe da RS21 realiza discussões assíncronas usando o Guru para dar aos membros da equipe mais tempo para responder de forma ponderada e para dar a todos uma plataforma igual e justa para contribuir. Instruções sobre como configurar e monitorar essas discussões são mantidas em um modelo do Guru, para que qualquer um possa iniciar uma com facilidade quando necessário.
No Guru, recrutamos equipes fora de nossa organização de desenvolvimento de produto para ajudar com nosso processo de garantia de qualidade (QA). Com opiniões mais diversas, conseguimos identificar melhor bugs, explorar potenciais desafios do cliente e nos proteger contra eles antes do lançamento. Mas um processo tão técnico quanto o QA exige instruções e procedimentos documentados ao envolver equipes interfuncionais. Antes de iniciar o QA para um novo recurso, um líder de equipe de engenharia usará nosso modelo de processo de QA para criar um local único para tudo que nossa equipe e as partes interessadas precisarão para o QA de ponta a ponta. Quando estivermos prontos para iniciar o QA, eles enviarão isso como um anúncio para a equipe e as partes interessadas e incluirão as datas ativas de QA na mensagem.
Planejamento de Projetos e Documentação de Desenvolvimento
Sempre que um novo projeto de desenvolvimento começar, há muita documentação que se segue para garantir que todos tenham o contexto completo que precisam para desempenhar seu papel. Após uma reunião de início, os engenheiros dependem de documentos de requisitos das equipes de produto, dos designs funcionais mais atualizados de sua equipe de UX, textos de sua equipe de marketing ou redação e mais.
E, claro, eles frequentemente precisarão consultar qualquer documentação técnica que impacte o recurso em que estão trabalhando ou que precisem atualizar mais tarde no desenvolvimento.
No Guru, acompanhamos os vários recursos necessários para o desenvolvimento de produtos em um Cartão de Recursos de Projetos Ativos, defendido por cada líder de engenharia de projeto. Essas Cartas são o recurso de referência da equipe de engenharia durante as etapas iniciais do ciclo de vida do desenvolvimento de produtos, e são mantidas atualizadas para refletir quaisquer alterações ao longo do tempo.
À medida que o processo de desenvolvimento avança, a colaboração entre engenharia e design deve ser mantida em harmonia. Mas devido à natureza frequentemente assíncrona e remota do trabalho, designers e engenheiros nem sempre podem se conectar em uma chamada pelo Zoom para discutir quaisquer questões ou feedback. Para garantir que estão seguindo nosso protocolo interno acordado para solicitar feedback sobre o design, nossa equipe de engenharia usa nosso fluxo de trabalho de Feedback sobre Design para Mudanças de UI documentado no Guru.
Documentação a prova de futuro
A documentação sempre foi e sempre será uma parte necessária do trabalho de um engenheiro. Mas o que antes provocava gemidos dolorosos e suspiros angustiados pode se tornar uma parte simples e natural do seu dia a dia quando é trazido diretamente para seu fluxo de trabalho. A extensão do navegador do Guru traz a documentação diretamente para os lugares de que os engenheiros precisam, em vez de forçá-los a mudar de contexto para acessá-la, e Cartas curtas, verificadas por especialistas, aliviam a pressão dos longos artigos de outrora que eram uma dor de cabeça para escrever e ainda mais difíceis de manter. Então, por que aumentar a dívida técnica com documentação desatualizada quando você pode facilmente torná-la a prova de futuro agora mesmo? Comece hoje gratuitamente.
Experimente o poder da plataforma Guru em primeira mão - faça nosso tour interativo pelo produto
.webp)
