Pular para o conteúdo principal

A revisão de texto para manuais de instrução e procedimentos

Aqui vamos tratar da revisão no campo específico dos textos procedimentais (guias operacionais, modos de usar, manuais de equipamentos, receitas – inclusive culinárias.

Manuais costumam ter textos confusos e inadequados.
Todos nos já nos deparamos com
problemas na leitura de manuais
de equipamentos que adquirimos.
Por se tratar de um tipo de texto particularmente carente de revisão, o texto de manuais e guias é também adequado para exemplificar alguns aspectos da atividade de revisão. Estamos preparando uma série de postagens abordando este tipo de texto como atividade geral da revisão, por um lado, e apresentando modelos de abordagem para textos técnicos. Nosso é objetivo apresentar a atividade de revisão para melhorar a eficácia desses tipos de documentos.

O texto procedimental: um tipo de texto, particularmente adequado para o estudo da atividade de revisão

Texto procedimental compreende todo tipo de texto que descreve procedimentos que deverão ser observados e seguidos pelo leitor. Comparado a outros tipos de textos (por exemplo, textos descritivos, explicativos, argumentativos ou narrativos), o texto procedimental é caracterizado primeiramente por sua função pragmática. Para o usuário, que deve ler as instruções nele contidas e aplicar o que ele entendeu, não é ler para aprender ou ler para entreter, mas ler para fazer. A leitura de um texto procedimental é realizada ao serviço da ação, seu papel imediato e explícito, portanto, é orientar o usuário na realização de uma tarefa, ou porque ele não a conhece, ou porque é considerada demasiado complexa. Com efeito, o texto procedimental deve permitir uma operação eficaz e livre de erros. Assim, precisa apresentar garantia de cumprimento das metas, geralmente estabelecidos nas instruções. Por exemplo, seguir uma receita deve levar à realização de um prato consistente e, portanto, comestível. Por exemplo, seguir uma lista de checagem durante um voo deve permitir ao piloto proporcionar segurança a si e aos passageiros. Essa restrição à eficácia requer que o texto procedimental possua características que o torna particularmente propício e carente de revisão.

Texto procedimentais: eficiência e pragmatismo

A obrigação de eficiência e a má qualidade em relação à finalidade pragmática, em textos procedimentais, são geralmente antagônicos. Comumente, esses textos são a principal – ou mesmo a única – fonte de assistência para o usuário aprender ou de instruções na resolução de dificuldades disponibilizados, quando adquire um produto, por exemplo, ou quando se depara com uma situação de emergência. No entanto, os manuais de equipamentos ou instruções de socorro têm a reputação de serem de má qualidade e seu uso costuma ser ineficaz, as razões para essa falta de qualidade é que os textos costumam ser abstratos, frenquentemente contêm grande quantidade de implícitos, vocabulário e estruturas sintáticas pouco adaptadas aos usuários, sejam conhecedores ou não do assunto. Comparados a outros tipos de texto, como o narrativo, onde o leitor tem ampla margem de interpretação, os textos processuais devem ser redigidos e revisados para que a margem de interpretação seja extremamente reduzida (ou nula – na maioria das circunstâncias). Com efeito, a má interpretação das instruções apresentadas em alguns textos procedimentais (tais como procedimentos de emergência ou socorro, instruções de segurança, manuais de manutenção ou outras listas usadas na aeronáutica e mesmo na indústria) podem vir a ocasionar consequências imediatas ou de longo alcance muito mais graves que erros de interpretação da narrativa ou descritiva. Como resultado, a melhoria dos textos procedimentais e sua adaptação aos usuários deve constituir uma das principais preocupações dos escritores técnicos (e revisores).
Nessa perspectiva, a natureza pragmática desses documentos pode ser útil em dois aspectos. Por um lado, faz deles particularmente adequados para o estudo do efeito das revisões sobre os comportamentos e processos cognitivos implementados por uso de texto escrito (leitura, compreensão, memória, aplicação das instruções). Por outro lado, é precisamente o caráter pragmático que deverá permitir a avaliação da eficácia das diferentes versões produzidas entre autores e revisores.

A observação do comportamento: fonte de revisão e indicador de eficácia

No uso dos textos procedimentais, a atividade de compreensão de leitura é apenas uma maneira para o usuário alcançar um objetivo. Portanto, a compreensão de leitura deve ser apenas uma atividade primária quanto à execução, mas secundária quanto a importância, a principal meta do usuário é aprender como usar, manipular, montar ou resolver um problema. Uma das consequências induzidas é que textos processuais devem ser redigidos para facilitar a atividade de compreensão, a fim de permitir ao usuário mobilizar seus recursos cognitivos e atenção em benefício a realização da tarefa. No entanto, esta perspectiva parece muitas vezes ausente desde a concepção de tais documentos.
Mais de dez anos de experiência em revisar e formatar trabalhos.
Leia também:
Revisão de manuais...
Para evitar esses problemas, alguns autores propõem avaliar a usabilidade dos documentos técnicos por sua apropriação pelo usuário. Essa avaliação utilizando métodos baseados no nível de envolvimento de usuários destina-se a verificar se as características do texto são suficientemente adaptadas às habilidades perceptivas e cognitivas. Muito diversificados, esses métodos podem confiar no gabarito também quantitativo do público alvo para coletar dados relativos a um ou outro dos aspectos estudados (adaptação da informação para as atividades de investigação, leitura, compreensão, memorização ou aplicativo). Aqui, a função pragmática dos textos procedimentais desempenha papel importante. Com efeito, a observação do comportamento pode identificar determinados defeitos de concepção do documento, e deve ser possível encontrar soluções que se prestem à melhoria do texto. Ela também pode avaliar a eficácia da revisão (por exemplo, em um esforço para comparar a versão original e o documento revisado versão). A abordagem centrada nos usuários corrige falhas de redação importantes antes do lançamento do documento para o público em geral e, assim, reduz o risco de incompreensão das informações apresentadas.
Adaptado de Ganier.

Postagens mais visitadas deste blog

Como escrever o resumo de sua tese ou dissertação

O resumo é parte necessária da apresentação final de uma tese, dissertação ou mesmo de um artigo. A versão final do resumo terá de ser escrita depois que você terminar de ler a sua tese para enviar ao revisor do texto. Um resumo prévio, escrito nas diferentes fases do seu trabalho vai ajudar você a ter uma versão curta de sua tese a cabeça. Isso vai conduzir seu pensamento sobre o que é que você está realmente sendo feito, vai ajudá-lo a ver a relevância do que você está trabalhando no momento dentro do quadro maior, e ajudar a manter os vínculos que acabarão por conferir unidade à tese (dissertação, TCC, artigo). Resumo é uma apresentação concisa dos pontos relevantes de um documento (NBR 6028:2003).  O que é um resumo? O resumo é um componente importante da tese. Apresentado no início da tese, é provável que seja a primeira descrição substantiva do trabalho a ser lida por um examinador ou qualquer outro leitor externo. Você deve vê-lo como oportunidade de definir as expectativas p…

Principais estilos de citações bibliográficas e referências

Os estilos de citações são muitos, cada revista científica, cada programa de pós-graduação decide qual estilo vai adotar, como fazer as citações.Primeiramente, vale informar que "estilos científicos" não são estilos "literárias", mas a edição de estilos, ou seja, modos de apresentação de conteúdo estruturados, formas de escrever artigos científicos, apresentação, organização de conteúdo, formas fazer abreviações, anexos e fotos presentes nos textos e, além disso, formas de citações bibliográficas e de referências. Por isso as formas de citações dependem de cada estilo científico.
Para trabalhar com estilos de citações, é melhor usar um gerenciador de bibliografias como Refworks, Zotero, EndNote, Reference Manager, BibText e outros similares. Mesmo o Word que todo mundo tem faz esse serviço. O que impressiona muito é que a quase totalidade dos autores brasileiros não faz uso de nenhum desses programas e nem sequer sabe que o próprio editor de textos mais comum faz o …

Como escrever um texto acadêmico – aspectos gerais e específicos

Um texto científico ou acadêmico é um complexo trabalho dissertativo ou narrativo que tem características próprias sobre sua concepção, criação e apresentação. Bons textos científicos acrescentam conhecimento mesmo quando levantam novas dúvidas, novos problemas ou novas abordagens sobre uma questão, permitindo que leitores encontrem realidade e humanidade em palavras que foram completamente estruturadas para apresentar ou discutir um enfoque específico de um tema. Não importa qual tipo de texto você queira ou necessite escrever – pode ser uma tese de livre-docência, de doutorado, uma dissertação, monografia, um artigo científico, relatório – você precisará de disciplina, energia criativa e de dedicação para a pesquisa, criação, revisão e edição do texto. Apresentamos algumas sugestões para contribuir na redação.
Antes de começar a escrever um texto acadêmico, considere: problema, tema, abordagem Tenha claro para si o tipo de texto que vai escrever e o público a que ele se destina. Ne…

A tese: material e métodos, resultados e conclusão, estilo e referências

A escrita da tese segue parâmetros distintos nas seções específicas do texto, guardando unidade de estilo e coerência entre todos os segmentos do trabalho. Material e métodos Nesta seção o autor deve explicar claramente como o experimento foi realizado, e como foi realizada a análise estatística dos dados, podendo também utilizar as sugestões indicadas para escrever a introdução e buscando garantir que: a.Os leitores possam compreender e avaliar o experimento do trabalho e o tema da tese;
b.Outros pesquisadores possam utilizar o estudo independente para verificar os resultados do mesmo ou de outros contextos e produções. Algumas dicas úteis para escrita da fase “material e métodos” são descritas a seguir:
1)Mencionar a data e o local onde foi realizada a prova experimental, especificando as coordenadas geográficas e/ou as características físicas e biológicas relevantes.
2)Descrever o plano experimental, incluindo os tratamentos aplicados, o número de repetições, a unidade experimenta…

Quatorze dicas para a hora de defender a tese

Depois de ter concluído a tese, é essencial que o aluno se prepare para a apresentação oral do trabalho. Um excelente texto não garante que a exposição na etapa final seja boa e, se o aluno não apresentar a tese de forma satisfatória, os examinadores podem subestimá-la ou até mesmo duvidar da preparação científica do candidato. Geralmente a apresentação oral da tese é geralmente é feita por meio de slides em Powerpoint ® (ou software similar) contendo texto, figuras, tabelas, desenhos e fotografias. Bons slides não são tudo. O aluno deve estar preparado e conhecer ponta a ponta o conteúdo, coordenando bem a apresentação conforme explica os slides e se comportando de forma adequada durante essa etapa do trabalho. Abaixo apresentamos algumas dicas, tanto referentes à formatação e estilo da apresentação de slides, como à discussão da tese – aplicáveis a muitos contextos, como um concurso, entrevista de emprego ou uma apresentação de negócios. 1) Conheça antecipadamente o material disponí…