por Volta de fevereiro de 2012, eu estava indo para uma entrevista final para uma técnica de escrita papel de uma empresa de energia. Eu não tinha experiência anterior de trabalhar na indústria de energia, então achei que isso seria mencionado em algum momento da entrevista.

Surpreendentemente, a entrevista correu muito bem e no final da entrevista, quando o entrevistador pediu para ver amostras do meu trabalho, me entregou um CD, onde eu tinha meticulosamente com curadoria de alguns de meus trabalhos anteriores amostras, com editada em partes, para proteger o cliente de informações confidenciais. As amostras cobriram 2-3 dos meus projetos anteriores, apenas para dar uma compreensão suficiente da Gama de trabalho que eu tinha feito fora da indústria de energia.

24 horas depois, recebi uma ligação que eu tinha conseguido o papel, e uma grande parte dessa decisão se resumiu às amostras de trabalho apresentadas no CD. O feedback foi que eles ficaram impressionados com a qualidade do trabalho apresentado e a ideia do próprio CD!

o ponto é que só acrescentou credibilidade ao fato de que um portfólio de redação de tecnologia vale seu peso em ouro. Um bom portfólio adiciona um floreio final à sua experiência de redação técnica.

esta postagem do blog cobre algumas idéias sobre a construção de um portfólio de redação tecnológica, junto com minha experiência pessoal recente de construir um portfólio usando uma combinação de Markdown, Git e um gerador de Site estático.

construindo um portfólio

existem algumas maneiras de abordar a construção de um portfólio.

  • você pode optar por imprimir alguns dos seus melhores trabalhos e levar uma pasta para entrevistas para acompanhar os entrevistadores por meio dessas amostras.
    • a vantagem disso é que você pode transportar amostras de trabalho que não estão disponíveis publicamente, mas diretamente relevantes para a função para a qual está se candidatando.
    • uma palavra de cautela: para proteger o cliente sensível e qualquer material protegido por direitos autorais/IP, você deve redigir partes relevantes dessas amostras.
  • você pode optar por ter um documento compartilhável que curadoria parte do trabalho que você pode ter feito e é mais geralmente disponível publicamente on-line.
    • uma vantagem disso é que ele permite que você adapte ou modifique suas amostras aos requisitos de função.
    • você também pode apontar entrevistadores para algo disponível on-line para fácil acesso.
  • você pode ter um site dedicado que destaca sua escrita, juntamente com uma série de outras habilidades diretamente, como arquitetura de informação, navegação, organização de Conteúdo e compreensão do design.
    • a vantagem disso é que ele fornece uma estrutura coerente de sua experiência de escrita e fornece um vislumbre de suas habilidades de design.
    • uma das desvantagens disso é que você precisa investir tempo para criar, curar e manter este site de forma consistente, para acompanhar sua experiência crescente.

o Que deve ir em um portfólio

Existem muito poucos recursos já na internet, que aborda isso em grande detalhe:

Como criar uma redação técnica carteira

(https://clickhelp.com/clickhelp-technical-writing-blog/how-to-build-a-technical-writing-portfolio/)

montar uma carteira

(https://idratherbewriting.com/2009/12/21/get-a-job-in-technical-writing-step-4-put-together-a-portfolio/)

Como um escritor técnico, eu estaria interessada em colocar em melhor pé para a frente, de modo que essas coisas definitivamente seria topo da minha lista para incluir:

  • 5-6 uma das minhas melhores amostras de trabalho, através de uma gama de tipos de documentação, tais como guias de usuário, ajuda on-line, processo/instruções de trabalho, API e a documentação do desenvolvedor etc.
  • Background, context and your approach in creating the documentation and the tools used to create the docs
  • resumo de qualquer projeto de código aberto ou freelancer trabalhado em
  • quaisquer apresentações, artigos ou postagens de blog entregues e acessíveis ao público.

Meu portfólio atual

em Algum momento do ano passado, comecei a trabalhar na atualização do meu portfolio (https://swapnilogale.github.io) a partir de um compartilhável documento com uma lista de links para um site específico. O objetivo disso foi duplo:

  • em Primeiro lugar, permitiu-me aplicar a estrutura de uma crescente lista de amostras de trabalho
  • em Segundo lugar, deu-me uma oportunidade para aprender, levantar e polonês minhas habilidades em um novo conjunto de ferramentas de documentação – Hugo site estático gerador (usar Markdown para a criação de conteúdo), Git acordos de recompra (para armazenar o código e saídas) e o GitHub para a publicação do meu portfólio.

quando comecei a construir meu portfólio, também percebi que essa era uma excelente oportunidade de usar alguns conceitos de estratégia de conteúdo, como arquitetura de informação, navegação, substância e estrutura, para demonstrar minhas habilidades.

usando Hugo, Git e Github

eu tive experiência anterior trabalhando com Markdown em alguns dos meus projetos anteriores, mas eu estava interessado em experimentar um gerador de site estático para este exercício. Eu me estabeleci em Hugo (https://gohugo.io) como minha escolha. Seguindo a documentação de Hugo, escolhi o tema Hugo Resume (https://themes.gohugo.io/hugo-resume/) e brinquei com ele.

Alguns inicial girava em torno de obstáculos:

  • Configuração do Markdown editor (eu geralmente trabalho com Atom)
  • Fazer a minha cabeça em torno do conceito de arquétipos (essencialmente, modelos), e
  • Crescente confortável com a auto-execução de natureza de Hugo motor de como criar conteúdo para o site.

também criei repositórios separados no GitHub; um para armazenar meu código e documentos e o outro para armazenar os arquivos de saída.

uma Vez que o ambiente foi configurado, eu elaborou um plano de conteúdo que eu queria ser incluídos e reuniu os recursos relevantes (imagens, links, etc) para o site.

trabalhando com a documentação de Hugo (https://gohugo.io / documentation/), consegui criar um rascunho do portfólio com o qual fiquei relativamente feliz. O próximo passo foi enviar essas alterações para os repositórios do GitHub e hospedá-las nas páginas do GitHub.

(para ser honesto, inicialmente planejei hospedar isso no Netlify, mas me senti seguro no ambiente GitHub, então decidi ir com isso).

enviei um rascunho para as páginas do GitHub e o portfólio estava efetivamente pronto.

revisões e ajustes finos

nenhuma documentação técnica está pronta sem uma revisão. Indo com este ditado, decidi testar este portfólio, obtendo alguns colegas escritores técnicos da minha rede para revisar isso. Eu deliberadamente escolhi pedir a uma seção transversal de escritores de tecnologia, incluindo gerentes de redação técnica para revisar isso de diferentes perspectivas.

uma vez que eles revisaram isso e forneceram algum feedback realmente construtivo, consegui ajustar o conteúdo do portfólio e compartilhá-lo com confiança com um público maior.

as revisões, muitas vezes as úteis, são frequentemente negligenciadas no espaço de documentação técnica. Ter outro conjunto de olhos olhando para o portfólio através de lentes diferentes tornou o portfólio mais consistente e menos propenso a erros.

manutenção contínua

como muita documentação técnica por aí, um portfólio nunca está 100% completo. Haverá vários casos em que você adicionará ou atualizará este site. A manutenção contínua também deve figurar em seus planos se você deseja manter uma versão on-line do seu portfólio.

observações finais

trabalhar no portfólio foi uma ótima experiência, especialmente tentar aprender os mecanismos internos de ferramentas doc e configurar um fluxo de trabalho doc que funciona.

  • um portfólio é uma ótima maneira de mostrar não apenas suas habilidades, experiência e o melhor do seu trabalho, mas também uma oportunidade para demonstrar seu processo de pensamento e resultados da experiência.
  • mantenha-o simples. A ideia de um portfólio de redação tecnológica é demonstrar suas habilidades de redação e como você aborda diferentes projetos de documentação.
  • não subestime a importância de mostrar suas conquistas de código aberto. Eles possuem uma moeda considerável em projetos de software do que você imagina.

Sobre o autor

Swapnil Ogale
Swapnil é um Escritor Técnico com cerca de 14 anos de experiência em uma variedade de indústrias, na Austrália e no mundo. Ele iniciou a comunidade Write the Docs na Austrália em 2016 e tem organizado encontros locais, bem como a Conferência Nacional Anual. Swapnil adora viajar, ler, escrever (sim, ele escreve fora de seu trabalho diário também), e é um foodie.
quando ele não está fazendo nada disso, ele apresenta em encontros técnicos e conferências sobre vários tópicos em torno da redação técnica. Você pode descobrir mais sobre suas paixões no LinkedIn e no Twitter.

Deixe uma resposta

O seu endereço de email não será publicado.