Em geral, a tarefa de um redator técnico é única - preparar um texto que permita a um novo usuário usar o programa ou dispositivo corretamente.
Um redator técnico pode se conectar a um grupo de trabalho durante a fase de desenvolvimento de um produto futuro. O produto deve ser testado, os recursos e todas as funções possíveis devem ser estudados. O resultado do trabalho é uma instrução completa com uma descrição detalhada do uso do produto, acompanhada de ilustrações claras.
As principais ferramentas de um redator técnico são um editor de texto, um gravador de voz, bem como, dependendo das especificidades do projeto, MS Manual of Style, Apple Style Manual, Chicago Manual of Style, MS Word, Adobe FrameMaker (para a criação materiais offline), Adobe RoboHelp, MadCapFlare (para documentação online) e outros.
Conheça o seu escopo de trabalho
Todos estão bem cientes da frase: "Se tudo mais falhar, finalmente leia as instruções." Mas como você pode escrever instruções de forma que o desejo de lê-las surja antes mesmo de começar a trabalhar com o produto de software? Como torná-lo informativo para usuários experientes e novatos? Como redator técnico, você deve dominar o seguinte e um pouco mais
- determinar a composição e estrutura dos documentos incluídos no conjunto de documentação;
- determinar os requisitos de documentação e ser orientado por eles no trabalho;
- apresentar efetivamente o conteúdo dos documentos;
- redigir a documentação no estilo exigido;
- garanta a relevância da documentação, acompanhe suas alterações.
Algumas empresas de TI exigem um redator técnico para conhecer linguagens de marcação ou uma das linguagens de programação no nível de leitura de código, enquanto outras exigem habilidades para trabalhar com bancos de dados ou sistemas de gerenciamento de consultas.
Mostre interesse e mantenha-se engajado
O que certamente será útil é o interesse na área sobre a qual você está escrevendo: se um redator técnico não estiver interessado na área em que trabalha, será difícil para ele. Essa profissão não é adequada para aqueles que não estão prontos para melhorar seu nível de idioma - tanto nativos quanto estrangeiros. Se uma pessoa estiver interessada em tudo isso, ela se encontrará nesta profissão.
Mestre DITA
O formato DITA, em geral, revelou-se uma ferramenta muito conveniente para o desenvolvimento de documentação técnica com seu conteúdo específico. Por exemplo, podemos reutilizar qualquer bloco de texto ou uma seção inteira de um documento em outro documento. E este não será o usual “copiar e colar”, mas o uso de um bloco em diferentes documentos. Se algo mudar neste bloco, será suficiente para nós mudarmos o texto uma vez - a mudança irá automaticamente para todos os documentos. Também podemos aplicar filtros - escrever uma seção universal, inseri-la em vários documentos e, em seguida, filtrar seu conteúdo dependendo do tipo de documento, cliente, sistema e outros parâmetros. E também não pensamos em referências cruzadas entre seções - basta indicar no lugar certo a chave da seção a que queremos nos referir. Ao montar um documento, o Toolkit numerará as próprias seções e criará belos hiperlinks.
Revisão: ainda funciona
… Para redação técnica profissional também!
Quando um redator termina de trabalhar em um documento, ele deve enviá-lo para revisão. Analistas de negócios, desenvolvedores e testadores verificam a documentação. Este é um estágio muito importante porque um redator sempre pode cometer um erro - interpretar mal algo, não levar em consideração alguns recursos de implementação não documentados.
Não hesite em pedir ajuda
Se você é apenas um iniciante, ou se a redação técnica faz parte do programa da faculdade, ou se não tem tempo suficiente para terminar o dever técnico antes do prazo, considere delegá-lo a um serviço de ajuda profissional para tarefas, como Meu Laboratório de Tarefas. Em primeiro lugar, você definitivamente não é o primeiro aluno que precisa de ajuda especializada para fazer os deveres técnicos de casa, e os serviços estão totalmente prontos para ajudá-lo, mesmo que o projeto seja complexo e o prazo esteja assustadoramente próximo. É hora de admitir que é melhor delegar do que fracassar. Fazer um pedido por escrito técnico não vai demorar muito - você só vai listar os detalhes do pedido, anexar os materiais adicionais, indicar os requisitos e o prazo, escolher uma forma de pagamento. Quanto mais cedo você faz o pedido, menos você paga. Pedidos urgentes são os mais caros. No entanto, solicitar textos técnicos de autores experientes o ajuda a se tornar um escritor melhor. Estude os materiais recebidos e use-os como amostra para outras tarefas.
Participe de TW-Quests online
Você pode aprender muito competindo. Especialistas em TI têm hackathons e outras competições. As missões de redação técnica não são tão populares agora, mas você pode encontrar uma ou duas em qualquer temporada. É divertido participar de tais eventos e também ajuda a desenvolver seu estilo único, aprender com os melhores e mais brilhantes e aprimorar suas habilidades. A ideia principal é permanecer engajado e criativo, para fazer parte da comunidade de redação técnica.
A redação técnica é uma parte valiosa da tradução de um idioma para o mesmo - da linguagem técnica para a linguagem de uso. É um trabalho gratificante e interessante que exige aprendizado constante, foco, estudo de novos programas e participação na comunidade.