Otimização de guias para o desenvolvimento de software

Olá! Espero que esteja bem. Nesta ocasião gostaria de compartilhar um pouco sobre a otimização de guias para desenvolvimento de software.

Os guias são necessários tanto para o programador experiente quanto para o programador iniciante. Eles poderiam ser considerados uma das maiores fontes de educação e inspiração para programadores.

Porém, entre essa educação e inspiração encontraremos vários guias elaborados e, na minha opinião, desnecessariamente extensos. Neste post exploraremos um pouco sobre guias de desenvolvimento de software e como otimizá-los.

Como sabemos, preparar o ambiente é a base para iniciar o desenvolvimento, e essa base envolve muitas tarefas mundanas.

Da forma como estão as ferramentas atuais, é muito improvável que nos livremos dessas tarefas... pelo menos por muito tempo. O melhor que podemos fazer é aceitar o cotidiano e buscar como otimizar esses processos para facilitar nossa vida e aproveitar mais daquilo que gostamos: programar.

Esse é o objetivo deste post: um guia sobre como transformar grandes guias de desenvolvimento de software em guias eficientes e objetivos, especificamente na preparação do ambiente de desenvolvimento.

Otimização de guias para o desenvolvimento de software

O primeiro passo para otimizar os guias é identificar quais tarefas precisam ser simplificadas.

Este primeiro passo é simples: basta saber quais são as tarefas mais repetitivas no seu ambiente de desenvolvimento.

A maioria dessas tarefas será naturalmente encontrada na preparação do seu ambiente de desenvolvimento. Por exemplo, etapas para criar o ambiente do seu serviço web, etapas para publicar seu serviço web ou site, etapas para criar seu banco de dados.

Os citados são um dos diversos processos de preparação de ambiente que encontramos no desenvolvimento de software. Sem contar que cada um desses exemplos deve ser preparado de forma independente para cada linguagem, ferramenta e sistema operacional.

Ou seja, caso você utilize diversas tecnologias para preparar o ambiente de seus serviços web. Você poderia facilmente obter dois ou três guias.

Mas não estou dizendo isso para assustar você. A otimização o ajudará muito a acelerar o processo e o tempo de desenvolvimento. Além disso, não é uma tarefa muito complicada.

Uma vez identificadas as tarefas mais repetitivas em seu ambiente de desenvolvimento, procedemos à criação do documento.

Criar documento

Criar o documento é uma tarefa relativamente simples. Como se diz coloquialmente “Keep it super simple”. E faremos isso com o nosso guia, usando o mínimo de palavras possível para torná-lo simples e fácil de seguir. E também, use “ordered lists” ou “bullet points” para a sua preparação. Também é uma boa prática adicionar a referência oficial da fonte do processo que você está otimizando.

Além do documento, é importante manter uma boa ordem hierárquica no arquivo onde ele ficará hospedado.

Dessa forma, você pode encontrá-lo facilmente quando precisar. Um arquivo no “Desktop” do seu computador chamado “Otimização” é suficiente. No entanto, se você leva organização a sério e usa ferramentas como o Notion em seu diário, não faria mal nenhum usá-lo para essa finalidade.

Já temos nosso guia otimizado. Agora resta testá-lo para medir sua eficácia e confirmar se realmente nos ajuda a otimizar o tempo de desenvolvimento.

Teste a eficácia do guia

Testar a eficácia do guia é uma tarefa simples de comparação entre a fonte original e o seu guia otimizado.

Se você utilizou as orientações de como preparar o documento, é de senso comum que você terá um melhor tempo de implementação.

“But let's not get over ourselves”

Para oferecer um exemplo, usarei um de meus próprios guias para fazer essa comparação. Utilizo o guia que vou compartilhar abaixo para criar os certificados para as “notificações push” dos aplicativos móveis dos meus clientes.

Para contextualizar um pouco, os aplicativos da Apple exigem uma série de certificados que devem ser renovados a cada 6 meses. Um deles é o serviço de “notificações push” que implementamos em nosso desenvolvimento utilizando OneSignal.

OneSignal é uma excelente empresa e um ótimo provedor de serviços para gerenciamento de notificações push.

No entanto, o seu guia para renovar estes certificados parece um labirinto.

Mas não tome minha palavra como um fato. Visite o guia OneSignal para renovar certificados de notificações push aqui: https://documentation.onesignal.com/docs/generate-an-ios-push-certificate

Agora compartilho com vocês meu guia otimizado para realizar esse mesmo processo:

1. Abra o aplicativo keychain Access.
2. Clique Keychain Access no menu ao lado da maçã 🍎.
3. Certificate Assistant > Request certificate from authority > Checkbox save on disk > Continue.
4. Baixe cerificateRequest
5. Visite a seção de certificates no Apple Developer: https://developer.apple.com/account/resources/certificates/list
6. Pressione o sinal + em certificates.
7. Selecione o checkbox: Apple Push Notification service SSL (Sandbox & Production).
8. Seleccione App ID no menu suspenso.
9. Carregar certificateRequest do passo 4.
10. Clique Descargar e abra o arquivo aps.cer (vai abrir no KeyChain).
11. Identifique o arquivo, faz clic direito e seleccione export.
12. Abra as configurações no OneSignal: https://dashboard.onesignal.com/apps/5ceb25ff-cfca-46c1-8aeb-5fdfee621f70/settings
13. Selecione checkbox: Atualizar autenticação.
14. Selecione .p12.
15. Carregar arquivo .p12 (do passo 11) e inserte a senha.

Você pode ver claramente a diferença entre clareza e facilidade de visualização de cada etapa que deve ser realizada.

Meu guia otimizado tem um tempo de implantação de 3 a 4 minutos. É potencialmente necessário que você entenda e leia o guia da fonte original.

Espero que esta comparação tenha permitido que você veja o valor da otimização de guias para desenvolvimento de software. Como programadores, não podemos nos livrar de tarefas mundanas. Mas podemos implementar técnicas para reduzir o tempo que investimos nelas.

Conclusão

Neste post nos aprofundamos um pouco na parte não tão divertida do desenvolvimento de software. Preparar documentação certamente pode ser uma das tarefas mais tediosas no desenvolvimento de software. Porém, quando mudamos nossa perspectiva e os vemos como um investimento no futuro do qual teremos mais tempo de retorno. Torna-se sem dúvida um investimento atrativo.

Recomendo que você pratique a documentação preparando guias otimizados. Com tempo e consistência você desenvolverá um ótimo hábito e uma vantagem para qualquer programador.