1,180 leituras

Desenvolvedores de software, por que vocês ainda não começaram a escrever técnicas?

por Ankur Tyagi12m2023/10/20

Muito longo; Para ler

Ensinar e escrever sobre qualquer coisa é a melhor maneira de aprender sobre isso, e é um fruto fácil para você começar um novo estilo de vida.

featured image - Desenvolvedores de software, por que vocês ainda não começaram a escrever técnicas?

‘a programmer typing on his keyboard’ Image created by HackerNoon AI Image Generator

Um blog é uma peça útil por vários motivos, não apenas para você, mas para outros desenvolvedores de software de tecnologia.

A redação técnica ajuda um desenvolvedor de software a compartilhar seus conhecimentos/experiências técnicas com outros desenvolvedores de software em engenharia de software.

A redação técnica é uma disciplina de redação que envolve a comunicação de informações complexas a quem precisa delas para realizar uma determinada tarefa ou atingir um determinado objetivo. Por causa disso, a redação técnica é frequentemente definida como “ simplificar o complexo ”.

Também aumenta sua compreensão do tópico sobre o qual você está escrevendo e mostra claramente seu conhecimento técnico.

A coisa mais única sobre redação técnica é que você não apenas foi capaz de gerar excelentes oportunidades futuras (um trabalho remoto em tecnologia, um contrato de redação freelance ou uma oportunidade de guest post em um site de uma grande empresa de tecnologia, etc.), mas também pode ajudá-lo a construir uma presença online que eventualmente o ajudará em sua carreira como desenvolvedor de software.

Às vezes, volto e leio as postagens do meu blog quando procuro informações sobre um tópico específico.

Se você fez algo interessante em sua carreira de engenheiro de software, mas guarda isso para si mesmo, está perdendo um grande gerador de oportunidades.
Comece a escrever e é uma forma eficaz de divulgar suas ideias na internet.
“Escreva o blog que você gostaria de encontrar quando… https://t.co/PcXR0fL9QF
-Ankur💻🎧💪 (@TheAnkurTyagi) 3 de outubro de 2023

Além disso, se você gosta de ajudar outras pessoas a aprender, gosta de fazer parte de projetos de código aberto e mostrar aos outros como participar, ou encontra satisfação em explicar ideias complexas de maneiras fáceis de entender por meio de sua escrita, então a redação técnica é uma ótima opção para você.

Neste artigo, pretendo explicar como a programação e a escrita podem se fundir para elevar nossas habilidades de desenvolvedor. Sim, escrevendo! Eu realmente acho que todos nós possuímos algum nível de habilidade de escrita. Estou aqui para fornecer dicas de redação, conselhos e exemplos para ajudá-lo a se tornar um desenvolvedor e comunicador mais proficiente.

O que é redação técnica

A redação técnica consiste em fornecer instruções claras e detalhadas para ajudar os usuários, colegas desenvolvedores ou gerentes a ajudá-los a compreender um produto técnico, uma habilidade ou ideia técnica.

Um redator técnico é alguém que cria esses tutoriais e documentação técnica.

A redação técnica pode ser:

Guias de usuário ou integração entre dois SaaS técnicos
Artigos de suporte on-line
Relatórios Técnicos que apresentam informações sobre um tema específico, muitas vezes após a realização de pesquisas ou experimentos. Eles são comuns nas áreas científicas e de engenharia.
Propostas Técnicas , Esses documentos descrevem um plano, ideia ou projeto de forma clara e persuasiva. Eles são usados para buscar aprovação, financiamento ou colaboração.
Metamateriais internos para programadores e documentação de API para desenvolvedores.

Em essência, um redator técnico transmite detalhes técnicos de uma maneira que permite ao leitor aplicar efetivamente essas informações para um propósito específico.

Se você está começando na redação técnica e tentando escrever sobre desenvolvimento/programação de software ou o que aprendeu em tecnologia, mas ainda não escreveu seu primeiro blog, encontrará o maior valor nas duas primeiras seções de esta postagem do blog onde falo sobre como começar como redator técnico ou blogueiro e como dimensionar seu blog.

O restante do blog será útil para preencher quaisquer lacunas de conhecimento necessárias para ter sucesso como escritor desenvolvedor de software, prosperar no local de trabalho e avançar em sua carreira.

“Se você tem um sonho, pode passar a vida inteira estudando, planejando e se preparando para ele. O que você deveria fazer é começar.
—Drew Houston

Escrever está em toda parte?

Os dois principais recursos online que as pessoas usam para aprender a codificar são a documentação técnica e o Stack Overflow, com blogs completando os três primeiros.

A tríade de permitir que as pessoas aprendam sobre tecnologia inclui documentação clara, uma comunidade vibrante que oferece soluções e postagens frequentes.

Os desenvolvedores valorizam uma ampla variedade de fontes adicionais, incluindo vídeos de instruções, tutoriais escritos, livros e fóruns – eles reúnem as fontes e formatos que melhor se adaptam ao seu estilo de aprendizagem.

Ser capaz de expressar suas ideias claramente dentro da equipe e online é uma habilidade valiosa, pois muitos desenvolvedores consideram isso um desafio. Pense em quanto você escreve todos os dias que não envolve escrever código. Essa habilidade é um superpoder.

Você se envolve em várias formas de escrita, como bate-papos do Slack, e-mails, documentos internos de desenvolvedores, rascunhos de RCA, leia-me, comentários de código, mensagens de commit do Git, solicitações pull, comentários de revisão de código, feedback de desempenho anual, notas de reuniões e muito mais.

Dominar a escrita é crucial para desenvolvedores de software. Habilidades de escrita inadequadas podem impedir o avanço na carreira além de um certo ponto. Muitos engenheiros percebem mais tarde em suas carreiras que “habilidades interpessoais são tão importantes quanto o código”.

Jovens: Sua carreira de engenheiro de software melhorará significativamente e você obterá melhores oportunidades futuras em tecnologia se começar a escrever 30 minutos por dia e postar de 2 a 3 blogs on-line por mês, mas poucos desenvolvedores são realmente capazes de fazer isso ao longo do tempo. longo prazo. https://t.co/damIJ5gXys
-Ankur💻🎧💪 (@TheAnkurTyagi) 4 de outubro de 2023

Por que escrever é crucial para desenvolvedores

JavaScript, TypeScript, PHP, Go, Java — existem tantas linguagens de programação diferentes por aí e você pode até ser fluente em muitas delas.

À medida que nos esforçamos para produzir códigos de maior qualidade nas nossas carreiras tecnológicas, a capacidade de escrever e comunicar eficazmente na linguagem quotidiana torna-se uma competência crucial, que pode ser subestimada no campo da engenharia de software.

A engenharia de software não envolve apenas código. É sobre pessoas + código.
Como me torno um escritor melhor como engenheiro de software

A forma como os engenheiros articulam seus pensamentos sobre o código pode ser tão crítica quanto o próprio código. Independentemente da sua posição sobre este assunto, podemos reconhecer unanimemente que as nossas palavras têm o poder de aumentar ou dificultar a eficácia do código.

Escrever pode ajudá-lo a aumentar sua área de sorte.

L = D * T, onde L é sorte, D está fazendo e T está contando.
-Jason C.Roberts

6 principais benefícios da redação técnica

Ajuda você a compreender os conceitos em um nível mais profundo.

Você precisa pesquisar os conceitos que está explicando, o que o expõe a diferentes ideias, aplicações e pegadinhas.
Os conceitos aderem melhor ao seu cérebro quando você os explica a outras pessoas.
Ao estruturar e apresentar informações para outras pessoas, muitas vezes você descobre lacunas em seu conhecimento. Como resultado, também ajuda você a progredir mais rapidamente em sua carreira de desenvolvedor.
Os redatores técnicos aprendem ao longo da vida porque, a cada novo blog técnico, você pesquisa e escreve, você se tornará um especialista no assunto.
Escrever também promove uma compreensão mais profunda da empatia do usuário. Ele solicita que você se concentre mais nas perspectivas e sentimentos dos leitores ou usuários do produto, em vez de confiar apenas no seu ponto de vista.
Aqui estão alguns benefícios adicionais:

Além disso, você pode gerar renda como redator técnico contribuindo para diversas organizações. Confira esses redatores técnicos incríveis de empresas que pagam .

Na faculdade, estudei dando aulas particulares em um albergue

Explicar algo, ou mesmo fingir, obriga você a organizar seu conhecimento de forma coerente, expondo lacunas em seu conhecimento e reforçando as partes que você conhece.

A melhor maneira de aprender é ensinando e escrever é um grande trunfo para todo desenvolvedor.

Em vez de apenas prestar atenção, as pessoas e as empresas retribuem isso a você. Ao escrever uma postagem técnica no blog, você recebe feedback instantâneo. Sua redação técnica também auxilia na divulgação, abrindo portas para oportunidades ainda mais intrigantes.

Há também uma carreira lucrativa em redação técnica, se você achar que gosta e praticamente tudo que escrevo em meu blog atualmente são conceitos que estou tentando entender melhor. Se não consigo explicar por escrito, não tenho uma compreensão adequada do assunto.

Quais são os exemplos de redação técnica?

Como redator técnico, sua função envolve traduzir informações técnicas complexas em uma linguagem acessível e fácil de usar. A redação técnica abrange várias formas, incluindo a criação de tutoriais passo a passo e guias abrangentes.

O objetivo principal é facilitar a compreensão de quaisquer aspectos técnicos de um produto ou serviço, seja entre os membros da equipe interna ou entre os usuários finais.

Com isso em mente, os exemplos de redação técnica a seguir devem fornecer uma compreensão clara.

Revisão de SuperTokens – uma alternativa de código aberto para Auth0, Firebase Auth e AWS Cognito.

Este é um exemplo muito simples de revisão de supertokens e é por isso que “supertokens” é uma boa autenticação do usuário.

Como usar Medusa para criar loja de comércio eletrônico Next.js

Este é um bom exemplo de como você pode construir um tutorial junto com a construção de um aplicativo. Neste blog, compartilhei um guia passo a passo para construir uma loja de comércio eletrônico da Medusa, que é uma alternativa de código aberto ao Shopify.

Como implantar LLMs com MindsDB e OpenAI

Neste guia, compartilhei como você pode implantar LLMs com MindDB e OpenAI

Como migrar seu banco de dados do Supabase para o HarperDB

Um tutorial completo sobre como você pode migrar seu banco de dados do Supabase para o HarperDB

5- Documentação do Produto

A documentação do produto inclui instruções sobre como usar e integrar de forma eficaz com outras ferramentas de desenvolvedor.

Escrever documentos de um produto requer boas habilidades de redação técnica e conhecimento organizacional. Esses são apenas alguns exemplos de redação técnica que exigem altos níveis de habilidade em pesquisa, visualização e capacidade de se conectar com uma ampla variedade de públicos.

Dica- “Pergunte a si mesmo: 'O título capta o interesse do leitor?' Se isso acontecer, eles provavelmente irão se aprofundar na introdução e então decidir: 'Vale a pena investir meu tempo nesta peça inteira?' Um erro comum que observo com frequência em postagens técnicas é o excesso de introdução ou, inversamente, pouca introdução.

Um parágrafo elaborado com precisão pode efetivamente preparar o terreno para uma postagem técnica no blog.

Como começo como redator técnico

De longe, a pergunta mais comum que recebo sobre “redação técnica ou blog” é sobre como começar.

Na vida, parece que o maior obstáculo para fazer algo e se tornar o que você deseja é começar.

O pior inimigo é a “dúvida”. pic.twitter.com/fw1691QRSY
-Ankur💻🎧💪 (@TheAnkurTyagi) 10 de agosto de 2023

Seja começando um novo regime de exercícios, treinando para uma maratona, começando um negócio, escrevendo um livro ou, mais especificamente, neste caso, escrevendo, a parte mais difícil é sempre começar.

É fácil – e tentador – perder inúmeras horas debatendo o que você deve fazer.

É muito mais fácil “ler”, “ler” e “estudar” do que começar a “escrever”.

Mas o segredo é que você só precisa dar um passo de cada vez.

Construa pelo menos um ativo composto em sua carreira de engenharia de software

– Comece um blog – Comece um boletim informativo – Comece a gravar vídeos do YT – Comece um podcast – Comece a construir redes
Construa, publique e repita
Oportunidades futuras estão esperando por você na internet
CC @TheAnkurTyagi
-Kap.ts (@Kaperskyguru) 17 de fevereiro de 2023

E olhe ao redor; a maioria dos desenvolvedores em engenharia de software não escreve código 24 horas por dia, 7 dias por semana; a maioria de nós passa muito tempo fazendo outras coisas todos os dias.

Isso inclui:

Demonstração de uma nova funcionalidade para toda a equipe de uma empresa ou clientes.
Documentar um recurso novo ou antigo em seu produto.
Atualizando um ticket JIRA relacionado.
Criando trabalho de backlog para oferecer suporte a esse novo recurso.

Claro, sempre há tempo para ir ao banheiro/almoço e navegar no Twitter também 😉

então não pense demais - apenas comece

“Escrever é como aprender a jogar basquete.”
–David Perell

Para ser um escritor de sucesso e encontrar oportunidades, você deve ter 3 habilidades.

Codificação
Escrita
Inglês

Sim, antes mesmo de começar a escrever, você deve primeiro entender o inglês, incluindo seus tempos verbais, grafia e gramática básica.

Seus leitores não querem ler um artigo repleto de erros gramaticais e escolhas inadequadas de palavras.

Na indústria tecnológica, o inglês tornou-se a língua de facto para comunicação entre desenvolvedores de software, engenheiros e outros profissionais de tecnologia em todo o mundo. É a linguagem usada para documentação, linguagens de programação e ferramentas usadas para desenvolvimento.

Aprenda a comunicar ideias de forma simples e clara

Saber como implementar um recurso técnico não implica necessariamente que você possa explicar o processo a outras pessoas.

Ser um bom professor requer empatia e habilidade para transmitir informações de maneira adequada ao seu público-alvo

Você não entende algo se não consegue explicar para uma criança de seis anos.
Einstein, Alberto

Não existe uma estratégia perfeita para se tornar um escritor excepcional. Você pode se perguntar, então, por que estou discutindo esse assunto. É porque é crucial abordar isso desde o início.

“Não procure uma estratégia; procure sua voz única ao escrever e construa seu estilo.

O único truque de escrita que você deve conhecer.

Menos tecnologia é mais, trabalho com React 90% do tempo.
Se você estiver escrevendo pela primeira vez, reserve mais tempo para descobrir.
Permita-se escrever mal.
Pare de se preparar e comece a agir.

Como se tornar um escritor de destaque na era da IA:
Antes de escrever seu próximo post no blog, peça ao ChatGPT para escrever um sobre o tema e mostrar quais coisas genéricas já estão disponíveis na internet para que você evite dizer isso e escreva o que é importante e exclusivo para o público.
-Ankur💻🎧💪 (@TheAnkurTyagi) 16 de fevereiro de 2023

Para entender o seu público, faça estas perguntas antes de começar a escrever.

Quem são seus leitores?
O que eles procuram no Google ou que problema estão enfrentando?
Quais blogs eles estão lendo atualmente?
Como eles estarão lendo?

Como ter ideias para postagens em blogs

Escreva o artigo que teria impedido você de passar horas pesquisando no Google e coçando a cabeça.
Sempre que você aprender algo novo, escreva sobre como aprendeu e o que aprendeu.
Escreva uma história sobre sua área, interesse ou profissão.
Selecione uma postagem do seu blogueiro favorito que você achou agradável e explore o mesmo tópico de uma nova perspectiva ou aborde um assunto diferente de um ângulo semelhante.

Escreva a postagem do blog que você gostaria de ter encontrado quando pesquisou algo no Google.
-Ankur💻🎧💪 (@TheAnkurTyagi) 20 de março de 2023

Observação: se você fez algo interessante em sua carreira de engenheiro de software, mas está guardando isso para si mesmo, está perdendo um grande gerador de oportunidades.

É melhor navegar na Internet por meio da escrita quando se trata de promover suas ideias de maneira eficaz.

Existe um local ideal para escrever postagens técnicas e tutoriais. Escreva para o profissional que ainda não teve tempo de aprender isso e vincule-o a coisas que ele já sabe. Por exemplo, explicar uma técnica JS moderna para alguém que conhece jQuery.
- Rachel Andrew (@rachelandrew) 20 de fevereiro de 2019

Conclusão

Escrever é uma tarefa fácil para a maioria dos desenvolvedores qualificados.

Se você acha que pode aprender muito sobre tecnologia lendo uma postagem no blog; tente escrever um esta semana.
-Ankur💻🎧💪 (@TheAnkurTyagi) 2 de outubro de 2023

A razão pela qual todo desenvolvedor deveria escrever uma postagem no blog sobre o que aprende em engenharia de software é que escrever os faz descobrir que talvez não entendam algo tão bem quanto pensavam.

Ensinar e escrever sobre qualquer coisa é a melhor maneira de aprender sobre isso, e é um fruto fácil para você começar um novo estilo de vida porque você já tem experiência em primeira mão, então tudo que você precisa fazer é aparecer, escrever uma postagem no blog 12 este ano e avalie os resultados e planeje seu próximo passo!

“Leia para juntar os pontos, escreva para conectá-los.” - David Perell

O resultado final é que aprimorar suas habilidades de escrita e colocar um pouco mais de esforço em sua escrita pode realmente aprimorar suas habilidades como desenvolvedor. Essas dicas podem ser úteis para colaborar com outros desenvolvedores, manter seu trabalho, criar seu conteúdo quando necessário ou até mesmo redigir propostas de projetos, entre outras tarefas.