Free Press

Tomando de onde paramos na Parte 1 da série de ferramentas técnicas de escrita. (Verifique se você não leu)
Nesta parte, nós lidamos com as ferramentas técnicas de escrita usadas na fase “Document Information”.
Esta é a fase de escrita, edição, desenho, revisão e reescrita. Esta é a fase em que a equipe de documentação da informação está em sua força total produzindo guias, manuais, blogs, demonstrações em vídeo, páginas de ajuda online, e o que não estiver. Dada a variedade das tarefas nesta fase, as ferramentas técnicas de escrita utilizadas são também bastante diversas e inumeráveis.

Top 17 Ferramentas de software de escrita técnica para documentação em 2020

• • Whatfix
  • MediaWiki
  • Adobe Robohelp

• Notepad++
• WordPress
• Adobe Photoshop
• Adobe Illustrator
• Microsoft Visio
• Windows Snipping Tool
• Windows Movie Maker
• Powtoon
• Prezi
• Microsoft Word
• Kingsoft WPS Office
• Google Docs
• Adobe Framemaker
• oXygen XML Author

1. Whatfix

Whatfix significa uma mudança de paradigma na forma como a documentação de ajuda é apresentada online. Páginas de ajuda estáticas e longas não captam a atenção do usuário tão efetivamente quanto os guias interativos e pictóricos apresentados por Whatfix, popularmente chamados de ‘balões’.
Mais, a ajuda online no mundo de hoje precisa de se espalhar por vários gadgets – sejam eles PCs, tablets ou smartphones. Whatfix adapta automaticamente o conteúdo da ajuda para se adequar ao gadget. E o mesmo conteúdo de ajuda pode ser acessado de diferentes formas – como um slideshow, PDF ou um vídeo.
Dica do Autor: Whatfix suporta uma funcionalidade única – o walkthrough interactivo em tempo real – onde você coloca os seus trechos de ajuda directamente na página do produto ao vivo! O usuário lê o trecho no balão Whatfix e executa a ação de acordo na página. Esta é uma ferramenta de escrita técnica popular entre as empresas que procuram uma mudança das metodologias tradicionais.

MediaWiki

Exibir a ajuda online do seu produto como páginas wiki é uma ideia simples e eficaz. Suas páginas podem ser integradas diretamente na Wikipedia se você não tiver um site separado para o seu produto online. Alternativamente, você pode hospedar Wiki como páginas de ajuda no site do seu produto. A alta familiaridade deste formato entre usuários online é uma vantagem chave, e a ferramenta gratuita de edição do wiki MediaWiki Visual Editor torna a criação de ajuda bastante simples.
MediaWiki é uma ferramenta de edição web baseada em PHP, que a Wikipedia usa. No entanto, mesmo grandes corporações de software, sendo a Intel um exemplo chave, usam esta ferramenta para apresentar suas informações de vendas e marketing, How To’s, e páginas de ajuda sobre políticas e procedimentos.
Author’s Tip: Esta ferramenta de escrita técnica vem com bom suporte para extensões – para conteúdo multilíngue, revisão colaborativa, edições de rastreamento, busca integrada etc.

Adobe RoboHelp

Ferramenta de autoria padrão da indústria usada para criar sistemas de ajuda para aplicações desktop ou baseadas na web. Nenhum usuário de computador é um estranho para o RoboHelp! Toda vez que você pressiona F1 em qualquer uma de suas aplicações de software padrão, a janela de ajuda que aparece é quase sempre criada usando o RoboHelp. No entanto, ela também pode ser usada para gerar a documentação técnica convencional para impressão, tais como guias e manuais.
O sofisticado RoboHelp IDE permite que escritores técnicos desenvolvam projetos de ajuda em larga escala e os renderizem em múltiplos dispositivos de hardware/sistemas operacionais, e em múltiplos formatos (PDF, HTML, DOC, etc). A versão mais antiga do RoboHelp pode ser comprada como uma edição de baixo custo se o orçamento for uma restrição. No entanto, pequenas empresas podem aderir a alternativas simples e gratuitas, como blogs WordPress ou Wikis. O bom e velho MS Word também pode gerar arquivos de ajuda HTML básicos para você.
Author’s Tip: Gerenciar grandes produtos de software com versões de atualização regulares pode ser um grande desafio para os escritores técnicos, pois eles têm que estar em sincronia com o histórico de mudanças de produtos. Os arquivos de ajuda frequentemente mostram variáveis configuráveis definidas pelo usuário que são repetidas várias vezes ao longo da documentação de ajuda. (Por exemplo, uma variável como “Sleep time after inactivity” é definida para 30 seg na versão anterior, para ser definida para 1 min na actualização). O projeto RoboHelp se encarregaria de atualizar o valor da variável ao longo dos arquivos de ajuda!

Notepad++

Um editor de HTML para iniciantes muito eficaz. A maioria das pessoas aprende noções básicas de programação HTML nesta ferramenta técnica de escrita. Se o seu software não requer documentação de ajuda online muito pesada, para fazer arquivos de ajuda de tamanho médio, esta ferramenta é mais do que suficiente.
Its GUI personalizável permite edição fácil, suporta WYSIWYG para impressão e também tem opções de suporte em vários idiomas.
Dica do Autor: Notepad+++ vem com um rico conjunto de plug-ins. Multi-clipboard, Comparação de códigos, Auto-Save são alguns dos mais populares. Os escritores técnicos precisam escolher o conjunto certo de plug-ins, que pode transformar um editor iniciante comum em uma opção viável para edição de ajuda online.

WordPress

The GoTo place se você quiser ter documentação técnica para o seu produto na forma de blogs. O WordPress é uma plataforma de gerenciamento de conteúdo online, gratuita e de código aberto. Blogs escritos no WordPress podem ser acessados diretamente da URL do blog WordPress ou podem ser integrados ao site de sua empresa.
Este artigo em si é hospedado no blog do WordPress chamado Whatfix Academy. Se o objetivo é publicar regularmente conteúdo online sobre sua empresa/ tecnologias associadas, então crie uma conta no blog WordPress. Blogs também podem capturar respostas de usuários na forma de comentários e gostos, o que facilita o envolvimento com seu público-alvo e sentir a apreciação deles pelo seu produto.
Dica do Autor: Blogs isoladamente podem não reunir o suficiente globo ocular. Então, escreva seu blog primeiro, promova seu blog em plataformas de mídia social em seguida e finalmente meça a audiência/respeitos antes de continuar com o próximo conjunto de blogs!
Também Leia: Como a escrita técnica está mudando com o Times

Adobe Photoshop

Uma ferramenta pela qual a maioria dos escritores técnicos da indústria juram. É a ferramenta de edição de imagem mais popular do mundo para criar e editar fotos e trabalhos de arte baseados em raster (pixel). Pode ser usada para criar desenhos de Interface do usuário, páginas da Web, anúncios em banners, gráficos de vídeo, edição de imagens para impressão. Manipular uma imagem, sobrepor uma imagem a outra, refinar uma fotografia para eliminar imperfeições, corrigir problemas de iluminação são os seus usos mais populares. O processo de edição de imagem é reversível e incremental para que as alterações possam ser revertidas facilmente.
Dica do Autor: Para designers profissionais, que precisam constantemente de uma ferramenta de edição de imagem, quase não há substituição para o Adobe Photoshop. No entanto, se você é um usuário ocasional, tente o GIMP que é de código aberto. Ele suporta apenas esquemas de cor RGB enquanto o Photoshop também suporta o modo de cor CMYK (CYAN YELLOW MAGENTA BLACK). E a curva de aprendizagem é maior para o GIMP, mas é grátis enquanto o Photoshop custa uma bomba!

Adobe Illustrator

Ferramenta para criar e editar ilustrações vetoriais, como logotipos e marcas ou outros elementos de design. Os designers gráficos cometem frequentemente o erro de desenhar os logótipos dos seus produtos no Photoshop. Mas o mesmo logotipo precisa ser impresso em cartões de visita, assim como em placas de anúncios massivos. Portanto, a escala da imagem sem perder a clareza é a chave aqui, que as ferramentas de imagem baseadas em gráficos vetoriais conseguem. Adobe Illustrator e Corel Draw são as principais ferramentas técnicas de escrita neste espaço.
Author’s Tip: Esta ferramenta é parte da solução Adobe Creative Cloud com aluguéis mensais caros. Ferramentas de escrita técnica alternativas gratuitas como Inkscape ou Affinity Designer podem fazer o trabalho igualmente bem com formatos SVG. A menos que você precise de todas as principais ferramentas técnicas de escrita que fazem parte desta solução (Photoshop, InDesign, etc), esta ferramenta não é obrigatória.

Microsoft Visio

Uma ferramenta de diagramação popular utilizada no design de aplicações de engenharia. Os escritores técnicos muitas vezes precisam projetar fluxogramas, diagramas arquitetônicos, diagramas de circuitos elétricos, design de produtos de software e assim por diante. Visio é uma ajuda conveniente para isto.
É uma ferramenta de escrita técnica compatível com IEEE que está em conformidade com os padrões da indústria de software, como UML (Unified Modeling Language) e BPMN (Business Process Model and Notation).
Dica dos Autores: Visio não faz parte da suite tradicional do Microsoft Office, sempre foi vendido separadamente, semelhante ao MS Project. Mas um anúncio muito recente da Microsoft diz que os assinantes online do Office 365 agora também podem acessar Visio.

Windows Snipping Tool

Se você está procurando opções de captura de tela que são mais sofisticadas que o PrntScr no seu teclado, Snipping Tool é uma boa escolha. Além da captura de tela completa, você também pode capturar plantações à mão livre, ou plantações de área de tela parcial. Para capturar imagens fixas de vídeos, use a opção de atraso para que o quadro exato possa ser salvo como uma imagem.
Dica dos autores: Faz parte do conjunto de softwares do Windows, mas pode não ser habilitado por padrão em algumas edições do Windows.

Windows Movie Maker

Uma ferramenta simples de editor de vídeo que os escritores técnicos podem usar para fazer seus vídeos de demonstração do produto. É parte da suíte Windows Essentials. Entretanto, desde janeiro de 2017, este software foi descontinuado, sem o anúncio de uma substituição adequada. Portanto, todos aqueles usuários com versões mais antigas do Windows, agradeçam suas estrelas da sorte!
Authors’ Tip: Vídeos e recortes de áudio podem ser organizados e editados em uma visualização de storyboard, quadro a quadro. Ou uma série de imagens estáticas pode ser esticada em uma linha do tempo. Audio voiceovers em malha com sons de fundo podem dar aos seus vídeos uma borda sofisticada.

Powtoon

A escrita técnica está se tornando cada vez mais visual. Os vídeos animados são uma excelente forma de captar a atenção do usuário e passar a mensagem de uma forma cativante. Powtoon é uma boa ferramenta de animação baseada na web, vendida como um produto SaaS. Apresentações animadas e vídeos explicativos podem ser criados usando esta ferramenta de graça. No entanto, os vídeos criados com a versão gratuita teriam uma marca de água ‘Powtoon’.
Authors’ Dica: Se a escrita técnica não for para fins oficiais, é perfeitamente aceitável usar a versão gratuita desta ferramenta. No entanto, um aluguer nominal, você poderia obter a versão premium que permite criar vídeos sem a marca de água e vários outros recursos.

Prezi

Um take não convencional de fazer demonstrações na forma de uma apresentação de vídeo. Ao contrário do Powerpoint, onde o conteúdo é rigidamente dividido em slides, Prezi dá-lhe apenas uma enorme tela em branco. Você pode escrever, desenhando sobre ela como quiser. Aumentar ou diminuir o conteúdo em foco e mudar o foco de um quadro para outro na mesma tela – é como você faz uma apresentação de vídeo contínua.
Authors’ Tip: Além da versão gratuita, há uma versão de teste para estudantes que também é gratuita e tem quase todas as características da versão paga. Escolha essa.
Lê Também – 14 Conceitos Técnicos de Escrita Errados que Você Deve Saber!

Microsoft Word

É uma tolice escrever sobre o omnipresente MS Word. Mas por mais comum que seja em nossa vida digital diária, ele ainda é o melhor amigo de um escritor técnico! Com fácil conversão entre os formatos PDF e DOC, a simples combinação do Word e Adobe Acrobat Reader não deve ser tomada de ânimo leve. Este artigo pode ser sobre todas as ferramentas técnicas de escrita chiques do mundo, mas está sendo escrito usando – o humilde MS Word!
Authors’ Tip: Experimente os vários modelos de documentos que o Word tem à sua disposição. Eles ajudam a fazer seu documento parecer apropriado para o propósito pretendido – como folhetos de marketing, whitepapers técnicos, guias de solução de problemas, e assim por diante.

Kingsoft WPS Office

MS Word, PowerPoint, e Excel são conhecidos por serem as ferramentas técnicas de escrita mais utilizadas, muito à frente das alternativas disponíveis. Apenas a revolução do Android desacelerou um pouco o juggernaut do MS Office. E dada uma posição de destaque ao Kingsoft Office, uma alternativa razoável e gratuita ao MS Office.
Authors’ Tip: Há algumas características nuances que o WPS Writer não suporta – sendo o Thesaurus uma delas. Thesaurus é um recurso importante para escritores técnicos, pois estamos constantemente procurando melhores palavras para expressar os mesmos pontos em diferentes documentos técnicos!

Google Docs

Num mundo que está cada vez mais se voltando para um telefone celular prático para ler documentos, ao invés de se dar ao trabalho de ligar o computador, google docs em lentamente ganhar destaque. Criar documentos do zero não seria conveniente no Google Docs, mas a revisão e edição colaborativa pode ser feita de forma eficiente através desta alternativa baseada na nuvem ao MS Office.
Author’s Tip: A sua integração perfeita com o Gmail e o Google Drive torna-o ainda mais atraente. Como redator técnico, você se ateria às sofisticadas ferramentas de processamento de texto. Mas o seu gestor de produto, que pode estar em movimento o tempo todo, tem a certeza de pôr em dia as suas críticas no seu telefone, com toda a probabilidade!

Adobe Framemaker

Um processador de documentos sofisticado para documentos grandes, padrão industrial. Pode ser usado para gerar documentos estruturados com um framework XML, com 100% de conformidade DITA. Pode ser usado também para documentos não estruturados, como um substituto para editores de documentos como MS Word.
Framemaker é uma boa escolha para gerar documentos estruturados com templates pré-definidos para cumprir com vários formatos padrão industrial – como acordos legais e demonstrações financeiras. Ele suporta TOC ou criação de índices através de múltiplos documentos, tem opções ricas de formatação. Não perde em desempenho quando os gráficos são inseridos.
Author’s Tip: Framemaker é um bom investimento para empresas estabelecidas com equipes formais de redação técnica que precisam produzir grandes documentos de mais de 100 páginas. No entanto, empresas de produtos únicos e startups não precisam fazer esse investimento. Existem ferramentas gratuitas de autoria de documentos baseadas em XML, disponíveis gratuitamente. E você sempre pode se apoiar no bom e velho MS Word!

oXygen XML Autor

Este é um editor XML gratuito e de código aberto, compatível com DITA, com vários utilizadores leais e boas críticas. DITA (Document Information Typing Architecture) é um padrão aberto para autoria e publicação de documentos que aos poucos foi se tornando um padrão técnico de gerenciamento de documentos. Simplesmente porque remove a dependência da edição de conteúdo em uma determinada ferramenta. Você produz documentação online compatível com DITA (um conjunto de arquivos XML), então editar e manter no futuro seria possível através de qualquer outra ferramenta compatível com DITA!
Dica do Autor: Basta dizer que o conjunto de ferramentas oXygen é uma alternativa viável ao extremamente popular mas proibitivamente caro Adobe Framemaker. oXygen Author é geralmente usado em combinação com oXygen Developer.
Então, esse é todo o software técnico de escrita que você precisará na fase “Document Information”. A próxima e a última parte terá a fase “Publishing the Information”.
Para aprender algumas dicas técnicas de escrita e ter certeza de que você não vai perder as nossas atualizações de ferramentas técnicas de escrita, assine o nosso blog.
Like it? Marque o artigo ou compartilhe-o com seus amigos e colegas!

We at Whatfix, estamos inovando o espaço das ferramentas técnicas de escrita, perturbando a própria idéia de conteúdo escrito longo e contínuo. Nossos guias interativos o ajudarão a se tornar mais produtivo, fornecendo a você uma maneira rápida e eficaz de criar Documentação Técnica. Leia mais sobre como o Whatfix ajuda na escrita técnica neste artigo.