paint-brush
Redação técnica para startups é importante: aqui está o porquêpor@theankurtyagi
740 leituras
740 leituras

Redação técnica para startups é importante: aqui está o porquê

por Ankur Tyagi9m2023/10/29
Read on Terminal Reader

Muito longo; Para ler

A redação técnica desempenha um papel importante no sucesso de uma startup. Envolve a criação de documentação clara, concisa e focada no usuário que explica como funciona um produto ou serviço.
featured image - Redação técnica para startups é importante: aqui está o porquê
Ankur Tyagi HackerNoon profile picture
0-item


Bem-vindo à primeira postagem de nossa nova série, “ Como a redação técnica pode turbinar sua startup ”.


Nesta série, mostrarei como a redação técnica pode beneficiar startups, desde ganhar visibilidade até construir confiança com seu público. Como fornecedor de serviços de redação para startups, tenho visto o impacto positivo que um conteúdo bem elaborado pode ter.


Hoje, começarei com uma visão geral de como a redação técnica pode impulsionar o crescimento da sua startup. Fique ligado para mais postagens sobre por que escrever é uma ferramenta vital para startups.


A redação técnica desempenha um papel importante no sucesso de uma startup. Envolve a criação de documentação clara, concisa e focada no usuário que explica como funciona um produto ou serviço. “ Opiniões fortes, defendidas fracamente. ” Exponha-se, mas continue em busca de opiniões divergentes de pessoas inteligentes e respeitosas.


Escrever software está a meio caminho entre escrever um romance e construir uma ponte.


A redação técnica tolera e até incentiva idiossincrasias estilísticas que a publicação tradicional não acomodaria. Apoie-se neles.


O conteúdo técnico é oportuno ou atemporal, sem quase nada entre eles.


estado das relações com o desenvolvimento - 2023


Crédito da imagem – “Estado das relações com o desenvolvedor” – você pode acessar o relatório completo aqui.


A pessoa que escreve o plano em uma organização/startup tem um poder tremendo. Se você quiser encontrar os novatos em uma empresa de tecnologia, veja quem está redigindo o plano. Embora eles possam não ter todas as ideias, você saberá que eles têm energia, motivação e habilidades para organizar e comunicar ideias por escrito.


Cerque você e sua startup de “pensadores laterais” que não conseguem evitar de apresentar perspectivas variantes sobre tudo o que veem em seu produto ou serviço. Eles nem sempre estarão certos, mas sempre desafiam seu pensamento e sua escrita.


Investir em redação técnica pode ter um impacto substancial no sucesso da sua startup. Não só beneficia seus usuários, mas também contribui para a eficiência e eficácia de suas operações internas. Lembre-se de que o objetivo é produzir documentação clara, concisa e compreensível para o público-alvo. Como resultado, a satisfação do usuário, a fidelidade e o crescimento dos negócios aumentarão.


Lembre-se: os formatos de mídia são cíclicos. Nietzsche escreveu em aforismos e o Twitter é aforismos como serviço. O hip-hop trouxe de volta a poesia. Montaigne foi o pioneiro no formato de ensaio e os blogs o trouxeram de volta à moda.


As startups deveriam escrever mais manifestos, blogs, documentos limpos e guias de integração.



contrate pessoas que escrevam bom conteúdo técnico


O que é redação técnica?

Nos últimos 3 anos, trabalhei em documentação, guias de integração e postagens técnicas em blogs para mais de 20 startups. Comecei a contribuir durante minha função como defensor do desenvolvedor no SuperTokens – uma alternativa ao Auth0, Firebase Auth em 2021 e ajudei os desenvolvedores na transição para a nova autenticação de usuário de código aberto.


Descobri que gosto de escrever blogs e documentação técnica . É gratificante produzir textos técnicos de alta qualidade que beneficiem outras pessoas.

Eu li muitos recursos de redação técnica e documentação ao longo dos anos. Escrevi sobre por que todo engenheiro deveria escrever e juntei minhas anotações para me ajudar a lembrar de pontos-chave mais tarde em minha carreira, mas também como uma ferramenta para me ajudar a pensar sobre como escrever agora.


GPT revelou o quanto escrever é pura confusão. Sem graça, sem vida, pouco perspicaz, pouco ofensivo e não vale o preço da tinta com a qual foi impresso. portanto, bons escritores se tornarão mais importantes para suas startups, pois podem construir e escrever excelentes blogs técnicos e o plágio do ChatGPT é um problema completo. Se você não consegue escrever melhor que uma máquina, o que está fazendo escrevendo?


Se você é um desenvolvedor interessado em escrever blogs técnicos, escrevi um blog completo e dedicado sobre o que é redação técnica e como escrever bons blogs técnicos .


Meus princípios de escrita

Ao fazer redação técnica, sempre tento manter os seguintes princípios em mente.

  • O objetivo da escrita é tornar as tarefas o mais simples e eficientes possível para os usuários.
  • Os desenvolvedores preferem ser mostrados em vez de informados e preferem aprender fazendo.
  • Ajude seus usuários a alcançar o primeiro sucesso o mais rápido possível.
  • Mantenha a simplicidade e escreva em linguagem simples.

Por que a redação técnica é importante para startups?

Tenho escrito conteúdo técnico nos últimos 3 anos. Aqui está o que aprendi:

  • Blogs e documentação técnica claros ajudam os usuários finais a entender seu produto de forma rápida e eficiente, reduzindo a frustração e aumentando a satisfação.

  • A redação técnica completa mostra que você leva seu produto e seus usuários a sério. Isso aumenta a confiança e a confiança da sua marca.

  • Novos usuários finais podem rapidamente se tornar proficientes em seu produto se tiverem acesso a guias, integração e documentos bem organizados e fáceis de seguir.

  • Blogs técnicos e documentação bem estruturados melhoram o SEO do seu site, ajudando clientes em potencial a encontrá-lo com mais facilidade.

  • À medida que sua startup cresce, você precisará contratar mais funcionários. Uma boa redação e documentação técnica são essenciais para treinar novos contratados com eficiência.

  • Aqui estão alguns exemplos de excelentes blogs de engenharia:

  • O blog da Cloudflare

  • Blog de engenharia do DoorDash

  • O blog de tecnologia da Netflix


Redação técnica - blog de tecnologia da Netflix


  • Blogs técnicos detalhados e documentação demonstram que você tem um produto e uma estratégia de negócios bem pensados, que podem ser atraentes para potenciais investidores e parceiros.

  • O feedback do usuário final em blogs técnicos e documentação costuma ser inestimável para melhorar seu produto e identificar áreas de confusão.

  • Blogs e documentação bem escritos podem ser facilmente traduzidos para outros idiomas locais, permitindo que você alcance um público global mais amplo.

  • Ter blogs e documentação técnica de qualidade superior pode ser um diferencial significativo, dando a você uma vantagem sobre os concorrentes.



Boa redação técnica = marketing orgânico para desenvolvedores

Os desenvolvedores têm a reputação de serem avessos ao marketing, mas isso não é necessariamente verdade.


Na realidade, os desenvolvedores estão ganhando poder de compra e respeito em empresas de todos os tamanhos. Os empregadores reconhecem a importância de investir em ferramentas para ajudar os desenvolvedores a permanecerem produtivos e felizes, porque é difícil encontrar e reter bons desenvolvedores.


A variedade de ferramentas para desenvolvedores aumentou dramaticamente, desde IDEs até abstrações de nível superior e serviços pagos como GPT, incluindo ferramentas de baixo código.


A redação técnica é uma estratégia de marketing de desenvolvedor bem-sucedida, baseada na autenticidade e na compreensão do público. As startups devem passar tempo com os desenvolvedores, tanto online quanto pessoalmente, para compreender suas necessidades e preferências.


Por que o conteúdo técnico é importante para startups


O conteúdo técnico deve ser genuinamente útil e educativo, e muitas vezes é mais eficaz quando criado por um colega desenvolvedor. As opções incluem engenheiros internos, defensores de desenvolvedores, programas de redação comunitária, redatores freelance, engenheiros de software independentes e redatores como eu .


Os desenvolvedores estão presentes em plataformas como X (anteriormente Twitter), Hacker News, Reddit e LinkedIn e adoram ler postagens técnicas bem escritas em blogs.


Por que a estratégia de redação técnica se destaca?

Embora eu admita que grandes empresas de tecnologia e startups estão cada vez melhores em alcançar desenvolvedores. Passei 13 anos como engenheiro de software prático e líder técnico antes de iniciar meu blog como desenvolvedor de marketing, então aqui estão minhas idéias sobre por que a redação técnica é um grande trunfo para startups.


O marketing business-to-developer (“marketing B2D”) descreve iniciativas de marketing projetadas para alcançar desenvolvedores e a redação técnica é uma das melhores maneiras de fazer isso ao mesmo tempo que é genuína, autêntica e interessante.


Muitas startups lutam com o marketing técnico B2D porque os desenvolvedores são mais difíceis de alcançar do que o consumidor médio. Truques como brindes, cupons de alimentação grátis, camisetas grátis ou eventos de exclusão centrados no álcool não são a melhor opção.


Seja interessante - Escrever é de longe a maneira mais rápida de obter feedback de desenvolvedores em engenharia de software.

Crie um projeto legal com seu produto, escreva sobre ele e compartilhe-o em público para obter feedback e iterar.


Todos nós, desenvolvedores, apreciamos a honestidade. Nos últimos tempos, gostei pessoalmente da página do blog do Supabase . Eles escreveram alguns blogs muito legais e alcançaram um crescimento muito bom com seu conteúdo escrito.


Supabase-Blog


Como uma startup, isso significa que você deve ser honesto sobre seu produto na comunidade.


theankurtyagi-blog


Muitos grandes defensores dos desenvolvedores de contratação de tecnologia – alguém com formação técnica que defenderá seu produto em eventos ao vivo.


Grandes empresas de tecnologia como Google/Amazon/Meta/Netflix têm equipes dessas pessoas para dar palestras em conferências, fazer sessões de treinamento e escrever conteúdo técnico sobre os produtos de suas empresas, mas o papel de defensor do desenvolvedor não é adequado para a maioria das startups- porque eles agiram rapidamente e, infelizmente, muitos defensores dos desenvolvedores são preguiçosos e pessoas abaixo da média.


As startups precisam de engenheiros altamente qualificados em tecnologia que possam escrever e construir para seu blog de engenharia uma plataforma onde as pessoas queiram visitar todas as semanas, se não todos os dias.


Relatório devrel 2023


As startups devem aproveitar a redação técnica e a documentação como ferramentas de marketing .


Crédito da imagem – “Estado das relações com o desenvolvedor” – você pode acessar o relatório completo aqui.

Papel da redação técnica na comunicação eficaz

Podemos escrever muitos tipos diferentes de conteúdo técnico para desenvolvedores de software.

  • A documentação é importante, mas muito poucas startups utilizam a documentação como canal de marketing.
  • Tutoriais e guias de procedimentos podem ajudar os usuários finais a ver como usar seu produto no mundo real.
  • O conteúdo de conscientização é criado com o objetivo de aumentar o topo do seu funil e pode ser publicado em sites de parceiros externos para aumentar o alcance. Hashnode, DevTo, HackerNoon e DZone são locais gratuitos para publicar conteúdo de desenvolvedor.
  • As postagens de blog em seu site permitem que você envolva os leitores e aumente as inscrições.
  • Patrocine escritores independentes ou engenheiros seniores que escrevem um blog técnico em seu site ou boletins informativos.

Como a redação técnica garante clareza e compreensão

Sempre escreva bons exemplos começando com código real. Isso constrói a confiança de clientes e investidores ao escrever em público.


Minhas táticas para escrever em público:


Alguém recentemente em meu DM do Twitter me perguntou – “Olá Ankur, sou um grande fã do seu blog, mas tenho uma pergunta: como você lida com a escrita em público? As pessoas na internet são tão idiotas, às vezes.”


Muitas vezes ouvi o conselho “ Desligue ou não leia os comentários ”, mas ganhei muito conhecimento lendo comentários da Internet em minhas postagens e nas postagens de outras pessoas de estranhos ao longo dos anos, mesmo que às vezes as pessoas são idiotas.

Sempre fale sobre fatos reais e seja honesto

Falo principalmente sobre fatos – sejam fatos sobre startups ou defensores de desenvolvedores sobre minhas experiências como escritor. Em geral, eu diria que os comentários das pessoas sobre os fatos tendem a permanecer bastante normais. Os principais tipos de comentários negativos que recebo sobre fatos sobre meus erros. Eu principalmente tento evitar isso tentando ter autoconsciência sobre meu nível de conhecimento sobre um tópico e dizendo “Não tenho certeza…” quando não tenho certeza sobre alguma coisa.

Erros de edição e refatoração

Cometo muitos erros nas postagens do meu blog porque escrevo sobre muitas coisas que estão no limite do meu conhecimento. Quando as pessoas apontam erros, eu edito a postagem do blog e corrijo. Geralmente, fico perto de um computador por algumas horas depois de postar uma postagem no meu blog no Twitter ou na linha do tempo do LinkedIn, para poder corrigir os erros rapidamente à medida que eles surgem.

Preenchendo a lacuna de conhecimento técnico: o principal desafio no programa de relações com desenvolvedores de startups

O relatório da pesquisa menciona que o Desenvolvimento de Conteúdo foi uma atividade importante para profissionais de Relações com Desenvolvedores em 2023, com uma distinção entre Desenvolvimento de Conteúdo relacionado à Educação (55%) e Desenvolvimento de Conteúdo Técnico, como documentação (50%). Isso destaca a importância da redação técnica e da criação de conteúdo no envolvimento e na educação das comunidades de desenvolvedores.


Relatório devrel 2023


As três principais perguntas que toda startup deve fazer antes de iniciar um blog técnico

Começar um blog técnico pode ser um passo significativo para uma startup, pois requer uma abordagem cuidadosa para garantir que atenda eficazmente ao propósito pretendido.

Faça estas perguntas se estiver iniciando um novo blog para sua startup.


  • o propósito de escrever

  • o público alvo

  • o tipo de conteúdo a ser criado


Identificar o objetivo do blog é crucial, seja aumentando o reconhecimento da marca, complementando a documentação, construindo um público ou estabelecendo uma liderança inovadora. Em segundo lugar, compreender e restringir o público ajuda a adaptar o conteúdo de acordo. Por último, decidir sobre o formato do conteúdo, sejam tutoriais, resumos, estudos de caso, recursos, perguntas e respostas, comparações ou artigos de opinião, ajuda a manter um blog consistente e envolvente.


É isso neste blog. Continuarei escrevendo sobre este tópico e compartilharei mais informações sobre recursos mais específicos no próximo blog.


Fique ligado Até então, aqui estão alguns dos meus blogs mais populares que você gostaria de ler.


Estou ansioso para compartilhar mais sobre o poder da redação técnica na próxima postagem.


Também publicado aqui .