Artigos técnicos: O guia definitivo (ou não)

Estar presente e participar ativamente de uma comunidade, sempre ajuda no crescimento das pessoas, seja ele profissional, pessoal, religioso ou quaisquer outros âmbitos. Para quem trabalha na área de TI particularmente, esta participação pode culminar em uma curva de aprendizado e crescimento profissional muito mais acentuada do que se o profissional se isolar e caminhar sozinho na carreira.

Basicamente é possível participar de comunidades consumindo informações compartilhadas e compartilhando informações e conhecimentos. Algumas das principais formas de compartilhar conhecimento e informações são: Palestras (presenciais e online), Redes Socais em geral, vídeos, Wiki e Blogs com postagens técnicas.

Para aqueles que se aventuraram, ou desejam se aventurar com a redação e compartilhamento de textos técnicos, a seguir existe uma serie de pontos importantes que devem ser observados na intenção de que erros sejam evitados e uma melhor qualidade seja alcançada.

 Motivação

Existem diversos motivos que podem e levam profissionais à iniciarem uma efetiva participação em comunidades técnicas e criarem seus próprios blogs pessoais, ou mesmo escreverem para canais já bem conhecidos. Com motivações diferentes, geralmente os objetivos são comuns: exposição profissional, compartilhamento de conhecimento, networking e reconhecimento. Abaixo, alguns pontos que são relevantes e que podem influenciar direta ou indiretamente os resultados desta decisão de tornar-se público através principalmente de artigos técnicos.

Riscos e oportunidades

  • A “Exposição Profissional” proveniente da decisão de escrever artigos técnicos é ambígua, ou seja, pode ser uma excelente oportunidade de se criar um ótimo círculo de contatos profissionais, networking de alto nível e gerar grandes benefícios nos âmbitos profissional e pessoal, porém esta mesma “Exposição Profissional” pode ser extremamente perigosa e prejudicial à carreira do profissional, caso este não tome alguns cuidados básicos na hora de expor-se através de seus textos, por exemplo: Textos não fidedignos, com erros de português, dentre outros graves erros que estão melhor detalhados adiante, neste artigo.

Quando começar?

Tendo-se conhecimentos dos riscos e oportunidades, e considerando-se apto a dar início ao trabalho de compartilhamento de informações via textos técnicos (ou não), existem alguns importantes pré-requisitos a serem seguidos, para aumentar a probabilidade de que o texto a ser publicado seja bem recebido e faça “sucesso”.

  • Pesquise
    • Há um grande equívoco por parte de muitos autores de blogs, que é o conhecimento relacionado a um determinado assunto. Muitas pessoas, quando propõe-se a escrever um artigo técnico, enganam-se e pensam já saber o suficiente para não ser necessário fazer nenhuma pesquisa adicional. Mero engano, todo e qualquer conteúdo técnico, fica muito melhor apresentado, se expor pontos de vistas diferentes, ou mesmo conteúdo de fontes variadas, para defender um ponto de vista, ou mesmo descrever algo.
  • Leia e estude muito
    • Leitura e estudo, nunca é demais. E quanto mais conhecimento sobre o assunto a ser dissertado, melhor e mais rico ficará o artigo técnico. É sempre muito importante estudar, ler e fazer tantos testes quantos possíveis antes de publicar o artigo, visto que uma vez publicado, seu texto estará exposto para o mundo inteiro a qualquer momento para visualização de qualquer pessoa que quiser visualizá-lo, e conforme já citado anteriormente, pode ser muito bom ou muito ruim esta exposição.
  • Faça menções e referências
    • Um ponto não menos importante que os anteriores é a existência de citações e referências no artigo técnico dos textos que foram escritos por outros autores. É frustrante para um autor, ver que todo trabalho de pesquisa e estudo que ele teve para escrever determinado trecho de artigo, ou mesmo um artigo completo, e repentinamente ver este “roubado” e publicado sem referência em outro local, que até então era desconhecido. É até mesmo uma questão de respeito e demonstração de maturidade e bom senso, que ficarão explícitos aos leitores do artigo em questão.

Revisão periódica (não obrigatória)?

  • Releia seus próprios artigos
    • Esta não é uma necessidade extremamente importante, mas esporadicamente é interessante ler alguns de seus posts / artigos técnicos para que se por algum acaso houver algum erro (digitação, português ou conceitual), este possa ser corrigido.
  • Revise sua estratégia / metodologia
    • Um Blog baseado no dia a dia, ou na carreira de um profissional, deve acompanhar as mudanças que naturalmente ocorrem na carreira. Um bom exemplo é a tendência de migração de vários serviços de tecnologia para a nuvem. Se você fala sobre infraestrutura de servidores (Windows ou Linux), por exemplo, considere começar a estudar sobre computação na nuvem, e à medida que sentir-se confortável, os artigos naturalmente devem acompanhar esta mudança, isto fará com que os leitores, acompanhem as mudanças e talvez até se consiga mais leitores assíduos dos artigos técnicos publicados.

O artigo técnico

Abaixo, listo algumas características e especificidades referentes aos tipos mais comuns de artigos técnicos, detalhes do mesmo e alguns pontos de observação no que se refere à gramática na redação destes.

Tipos de artigos técnicos

  • Documentação
    • Este tipo de artigo técnico visa dissertar sobre algum produto, feature ou atividade, demonstrando sua finalidade sem se preocupar na apresentação dos métodos ou passo a passo para implementação. Este tipo de artigo técnico, geralmente é escrito quando são lançadas versões novas ou um produto totalmente novo, com a finalidade principal de demonstrar tal produto ou feature.
  • How to(s)
    • Artigos técnicos deste tipo, são como tutoriais onde normalmente é descrito um passo a passo com detalhes de implementação, ativação ou quaisquer alterações que objetivem o autor do artigo a criá-lo.
  • Benchmarks e Experiências
    • Este é um outro tipo de artigo bastante interessante, onde o autor do artigo, por necessidade ou ocasionalidade, passou por algum problema ou fez alguns testes que posteriormente demonstra em seu artigo técnico. Geralmente estes artigos são bem interessantes e demonstram situações do dia a dia e podem agregar bastante conhecimento à quem atua ou possui ambiente similar ao descrito no artigo.

O artigo técnico em si

  • Estrutura
    • Um artigo técnico (ou não) bem estruturado é muito importante, pois facilita e contribui para que a leitura fique mais agradável e entendível. Se  ideia é escrever muito, este tópico é especialmente importante, pois quanto maior o texto, mais cansativa e desestimulante fica a leitura, caso a mesma não esteja bem estruturada, sendo o inverso igualmente verdadeiro, quando mais bem estruturado, melhor e mais agradável se torna a leitura do mesmo.
    • Por um texto bem estruturado, entende-se a divisão do mesmo (introdução, desenvolvimento e conclusão), estruturação utilizando-se marcadores,  definição de fontes tradicionais de tamanhos proporcionais e principalmente a divisão em tópicos e subtítulos, determinando exatamente o assunto que determinado ponto do artigo trata.
  • Linguagem
    • Não se pode dizer que é correto ou incorreto escrever de uma forma completamente informal ou de forma muito formal. O ideal é definir o público alvo que se deseja atingir, e escrever da forma correta para este público alvo. Por exemplo, talvez escrever de forma extremamente formal, um artigo onde os principais leitores serão jovens universitários em início de carreira, pode tornar a leitura um tanto quanto chata e cansativa. Da mesma forma, não é aconselhado um texto muito informal, quando o público alvo são diretores e presidentes de empresas de Tecnologia, ou outras. Sendo seu artigo formal ou não, o importante é o correto direcionamento do artigo ao seu respectivo público alvo.
  • Público alvo
    • Conforme mencionado anteriormente, além de escrever da maneira correta para o público alvo correto, é preciso conhecer e saber para quem se está escrevendo, com isto é possível adequar a linguagem, estrutura e conteúdo do seu artigo.

Gramática

  • Evite erros mais comuns (digitação, gírias, concordância, etc)
    • Um dos pontos mais importantes em um artigo técnico é a clareza e assertividade com que se escreve um texto, relacionado à gramática do idioma no qual este texto é escrito. Se o texto está em português por exemplo, é imprescindível tomar todos os cuidados com erros de concordância, gírias, neologismos e até mesmo com erros de digitação, que naturalmente podem aparecer durante a redação do mesmo. Um texto bem escrito e gramaticalmente correto corrobora muito para que ao final da leitura, o leitor tenha prestado atenção ao conteúdo e tenha tido bom entendimento do que pretendia-se ter passado, do que ficar em mente os “assassinatos” ao idioma encontrados durante a leitura.
  • Solicite revisões (Amigos, Comunidade, Parentes, Sr. Joaquim)
    • Uma ferramenta gratuita e muito útil é a revisão antes da publicação. É bem provável que uma pessoa que possui um local onde publicar seus artigos (técnicos ou não), conheça outras pessoas do meio, que podem ler e avaliar o texto antes de o mesmo ser publicado. Ainda assim, caso não seja possível encontrar alguém que possa revisar o texto, é possível solicitar que uma ou mais pessoas o façam (mesmo não sendo do meio relacionado ao conteúdo do artigo).
    • Se possível, é aconselhável que sejam feitas revisões técnicas e gramaticais, assim mitiga-se o risco de incorreções tanto na parte técnica proposta no artigo, como também a parte gramatical que é tão importante quanto.

Abaixo, listo alguns pontos importantes com relação à algumas principais preocupações e com a publicidade quando se está desenvolvendo um artigo técnico.

Principais preocupações

  • SEMPRE
    • Solicite que alguém revise seus textos antes de publicá-los
    • Cite as fontes das informações
    • Pesquise em fontes fidedignas
    • Não assassine o idioma
    • Deixe claro que o texto é sua opinião, não uma verdade absoluta
  • NUNCA
    • Escreva com pressa de publicar
    • Publique um artigo sem pelo menos uma revisão
    • Copie ou reblogue algo, sem autorização do autor do texto original
    • Diga que sua forma é a única maneira existente
  • Publicidade
    • Canais disponíveis
      • Blog Pessoal
      • Technet Wiki
      • Facebook (Pages and Profile)
      • Twitter
    • Faça barulho
      • Divulgue sempre seus artigos técnicos.
      • Cuidado para não se tornar um spammer ou um chato bloqueado

Conclusão

Em resumo, um blog ou canal de textos técnicos quando bem escrito pode alavancar uma carreira, tornar seu autor conhecido por seus ótimos artigos e consequentemente rendendo bons resultados (convites, empregos, propostas, networking, etc). Em contrapartida, se o texto não é bem escrito e não toma-se diversos cuidados (alguns mencionados no texto supracitado) esta exposição pode ter o efeito contrário e fazer as oportunidades, a “fama” e propostas sumirem, visto que você pode estar mostrando a todos em seu texto seus pontos fracos (gramática, conhecimento técnico, etc).

Eu gostaria ainda de esclarecer que tudo o que foi escrito foi baseado em minhas preocupações e minha opinião. De forma alguma é a representação absoluta da verdade. Se você concorda, discorda ou tem algo a acrescer, será muito bem vindo nos comentários….

Obrigado por chegar até aqui,

Edvaldo Castro

20 thoughts on “Artigos técnicos: O guia definitivo (ou não)

  1. Muito bom, Edvaldo!

    Acredito que no Brasil nós temos um déficit muito grande de bons profissionais. Eles existem sim, mas em geral são poucos. Isso faz com que mesmo pessoas que estejam escrevendo e divulgando coisas absolutamente sem sentido ainda assim atraiam muita atenção — pelo simples fato de que estão lá, aparecendo — e às vezes até acabam se tornando “ícones”. Isso dá ainda mais importância para os pontos acima como um guia a ser seguido para quem se aventura a escrever.

    Espero que com o tempo a comunidade no Brasil amadureça, e sua contribuição é um passo importante nessa direção.

    Abraços.

    1. Olá Ivan,

      Obrigado pelo comentário, concordo com seu ponto de vista. Infelizmente a desejo de ser notado faz com que abram mão da qualidade em prol de quantidade. Aos poucos, acredito que a qualidade do que lemos paulatinamente vai sendo melhorada.

      Muito obrigado, volte sempre.

  2. Ótimo post!
    Achei todos os pontos muito bem colocados principalmente no que se refere às revisões: dá pra evitar muita gafe (experiência própria, rs) e melhorar ainda mais o artigo e/ou post quando se tem uma segunda opinião.
    []’s

    1. Olá Demétrio,

      Obrigado pela visita. Realmente não se vê muito destes posts em nossa área. Espero que possa ser útil aos blogueiros, como você mencionou.

      Obrigado e volte sempre…

      Abraços,

  3. Parabéns Edvaldo!!
    Conteúdo muito bom e que de fato pode ajudar muitas pessoas que estão começando ou as que já escrevem com frequência .. Faço minhas as palavras do Ivan ..”..Espero que com o tempo a comunidade no Brasil amadureça, e sua contribuição é um passo importante nessa direção…”

    Abraços

  4. Boa tarde Edvaldo.

    Queria deixar aqui meus parabéns pelo artigo. Já está favoritado para ler com mais calma depois. Com certeza é um conteúdo que vai me fazer revisar todo o meu blog.

    Abraço e continue compartilhando conhecimentos!

    1. Olá Marcelo,

      Muito obrigado pelos parabéns, fico feliz que tenha gostado do artigo e do blog.

      Espero poder de alguma forma, ajudar tanto as pessoas que escrevem, quanto aquelas pessoas que consomem as informações disponíveis em nossos blogs…

      Abraços…

    1. Muito obrigado Fabrício,

      Excelente prática e ideia… pena que não posso copiá-la, já que minha esposa também é DBA SQL Server, não seria uma revisão parecida com a que você faz… (risos)

      Abraços….

  5. Edvaldo,
    Muito obrigado por esse post. Tem muitas Informações valiosas que pouca gente presta atenção. Dificil encontrar alguém com a sua preocupação, além de escrever artigos com qualidade, “ensinar” como escrê-los.

    Abraço e nos vemos em algum SQLSAT!

    1. Adade,

      Vindo de um profissional como você, estes são grandes elogios… Eu que agradeço pelo prestígio da leitura de meus artigos, e fico muito feliz que estejam sendo úteis.
      Brasília (21/11/2015) é o próximo SAT… Nos vemos lá..

      Grande abraço

  6. Muito bom este artigo , realmente achei muito interessante, principalmente na parte de linguagem , eu escrevia um pouco sem pensar agora graças a você eu ja tenho uma base.

    Obrgada!

  7. Cara, parabéns! Muito bom o artigo, não havia lido ainda e o fiz agora! É sempre bom obter conhecimento de quem está há mais tempo presente na comunidade, compartilhando conteúdo técnico de qualidade e principalmente experiências do cotidiano! Escrever artigos não é uma tarefa fácil e as dicas que você expôs são extremamente valiosas para qualquer um, mesmo que não seja um blogger, pois ajuda até na elaboração de e-mails, uma das coisas mais básicas atualmente!

    1. Legal Felipe, que bom que gostou…
      É claro que todos são passíveis de erros, mas infelizmente vários autores não se preocupam muito em seguir algumas boas práticas na hora de publicar seu conteúdo.
      Fico feliz em ter ajudado

      Abraço

Leave a Reply