Um curso rápido em como escrever documentos técnicos
Contents
1. tem suas se es e subse es d lhes t tulos com verbos fortes ativos e substantivos espec ficos D particular aten o adi o de verbos fortes a seus t tulos Isto transforma a apar ncia e a sensa o do documento e ir incentiv lo a escrever em um estilo mais direto e mais interessante Por exemplo T tulos Padr o T tulos com verbos fortes e substantivos espec ficos A mecaniza o da montagem de Mecanizando a montagem de autos autos 1 M todo Atual 1 Como funciona a linha de 2 Necessidade de uma mudan a montagem 3 M todo Proposto 4 Dep sito 2 Adotando uma linha de 5 F brica montagem mecanizada 6 Dep sito de expedi o 3 Escolhendo o princ pio just 7 Escrit rio in Time 8 Compara es de Custo 4 Armaz m Mantendo 9 Recomenda o Estoque Suficiente 5 F brica atualizando a malha de montagem 6 Dep sito De Expedi o Fins do prazo Da Ordem Da Reuni o 7 Escrit rio verificando a economia de papeis 8 Custos e tempos de rota o melhorados 9 Adotando uma montagem mecanizada de autos Os t tulos ajudam a mant lo organizado e focalizado no t pico Eles dividem a informa o em itens pequenos f ceis de manejar e mant m no perto do seu objetivo original e das necessidades de seus leitores 6 Combine seu conte do com o conhecimento dos seus leitores Como sempre seus leitores s o todo importantes Escrever para o p blico ou escreve2. Muitas pessoas n o reconheceriam estes dois Quanto para a CRA C mera Ready Artwork seria melhor O SC para Spot Color um formul rio encurtado desnecess rio e UGD para a User Guide Documentation prolixo para o manual do usu rio Est o aqui as regras para manter acr nimos e abreviaturas sob controle e Use a abreviatura sem explana o se todos a conhecem IBM USA Washington DC BMW PhD SP Dr etc e Nota evite usar uma abreviatura se ela comumente entendida como um termo e voc quer que ela tenha outro significado Para o exemplo n o use PC para Politicamente Correto ou para o Conselho de Privy porque a maioria das pessoas pensa nele como o Personnal Computer computador pessoal e Use de dez a vinte dos mais comuns e entendidos acr nimos em sua organiza o sem explana o ao escrever internamente para a empresa Prefira a forma completo e a forma encurtada da palavra ao escrever para outras audi ncias e especialmente se escrever para o p blico e Use aforma encurtada da palavra para evitar a maioria de abreviaturas Kennedy Space Center torna se Center n o KSC e Use o bom senso Se a abreviatura for melhor na forma encurtada e n o causar nenhum problema para alguns de seus leitores use a livremente Por exemplo se voc est escrevendo um panfleto sobre Planos Pessoais de Igualdade e a palavra plano poderia confundir ou se tornar cansativa melhor usar a forma encurtada PPI e Limite
3. rios podem ir do come o de cada instru o ao fim sem vacilar Tal teste com os leitores mostrar maneiras de melhorar os documentos que mesmo os melhores escritores t cnicos n o teriam descoberto Texto em ingl s original http www technical writing course com Texto em portugu s traduzido pelo Google http translate google com translate hl pt BR amp sl en amp u http www technical writing course com amp prev search 3Fq 3Dtechnical writing course 26hl 3Dpt BR 26Ir 3D 26ie 3DUTF 8 PEM 25 08 04 VER 00 VER 01 08 10 04
4. muitas senten as curtas claras que dizem ao usu rio o que fazer Entretanto se voc come ar a reduzir abaixo de 10 palavras voc provavelmente estar levando longe demais a t cnica de senten as curtas Compare estes exemplos Senten a Longa Um destaque de um Web site o desenvolvimento de dois tipos de sistemas consultivos eletr nicos peritos e t cnicos onde ambos os sistemas informam o usu rio sobre padr es fazendo uma s rie de perguntas que determinam onde e que partes espec ficas do padr o se aplicam s atividades do usu rio ou se dirigindo a padr es complexos colocando em um local uma grande quantidade de informa o sobre o padr o uma senten a 67 palavras Senten as Mais curtas O Web site oferece ambas as se es consultivas para peritos e t cnicos Estes explicam os padr es fazendo perguntas para encontrar se e como os padr es se aplicam ao usu rio Dirigem se tamb m a padr es complexos colocando toda a informa o relevante em um lugar tr s senten as total 42 palavras s vezes ajuda se voc quebrar senten as longas em uma lista Senten a Longa Os registros de invent rio f sico podem precisamente ser mantido para transa es de substitui o pela redu o do invent rio do relat rio de recep o e de requerido servi o de cliente para preparar um relat rio dos artigos reparados que voltam ao invent rio como uma recoloca o par
5. Cada uma destas profiss es necessita destes termos especializados Eles descrevem especificamente algo mesmo se a palavra n o est no vocabul rio da pessoa m dia Muitas das palavras est o em um bom dicion rio e todos est o em seu CORRETOR DE ORTOGRAFIA no Word ou similar Assim sendo use tais termos livremente oferecendo explana es se voc esperar que seus leitores possam ter problemas de compreens o Por exemplo um m dico p de explicar a necessidade para uma tonsiloctomia a um paciente dizendo Voc necessitar entrar no hospital para que uma opera o que remova suas am dalas Mas para usar tal explana o em um relat rio aos seus ou ao de seus colegas seria desnecess rio 13 Evite acr nimos e abreviaturas A forma mais comum e a mais irritante do jarg o o uso excessivo dos acr nimos e das abreviaturas Pergunte a leitores o que eles n o gostam em todo texto t cnico e dir o o jarg o Pe a que lhe d em um exemplo e dir o todas aquelas abreviaturas Eis aqui algumas abreviaturas de um manual de computador Quanto delas voc conhece Abreviatura Significado CRA Camera ready Artwork DPI Dots per inch Pontos Por Polegada Dtp Desktop Publishing PMS Paint Matching System Sc Spot Color UGD User Guide Documentation Quantos voc acertou Dois de seis Provavelmente DPI para Dots Per Inch pontos por a polegada e o DTP para o Desktop Publishing porque s o termos em uso na ind stria
6. Localizar deixa o encontrar o texto e substitu lo com o novo texto Voc pode encontrar e mudar todas as ocorr ncias do texto automaticamente ou voc pode decidir se se mudar cada ocorr ncia conforme o programa encontra as Para encontrar e selecionar o texto 1 Coloque o cursor onde voc quer come ar sua busca Se voc quiser fazer mudan as somente em parte do documento selecione essa parte primeiramente 2 Escolha Replace do menu Find O Replace with tomorrow Replace V Match whole word only r Match case mea 3 Digite o texto que voc quer encontrar na caixa Find what 4 Digite o texto que voc quer substituir na caixa Replace with e Selecione Match whole Word only somente se voc quer encontrar palavras inteiras somente e Selecione Match case se voc quiser procurar por palavras com capitaliza o exata 5 Click sobre Find next Replace ou Replace All para come ar a busca 6 Click a tecla Cancel ou OK para terminar Datasearch Q 18 Teste seus documentos com os leitores pretendidos Para muitos documentos t cnicos voc necessita test los no p blico alvo Mostre aos usu rios as instru es e pe a para eles aplicarem Retrabalhe qualquer rea do documento aonde os usu rios demonstraram demora em execut la Repense redesenhe e reescreva qualquer rea que confunda os usu rios Certifique se que todos os usu
7. Um curso r pido em como escrever documentos t cnicos Nancy Halligan Dicas preciosas para quem gera documentos t cnicos N o h nenhuma raz o porque a escrita o texto t cnica usada em manuais de produto manuais de treinamento relat rios etc n o deve ser v vida e interessante O desafio real que o autor ou instrutor tem expressar id ias complexas de uma maneira simples Frequentemente a escrita t cnica tem um flat style tornando os documentos dif ceis e tediosos de ler N o h nenhuma raz o porque a escrita t cnica n o deve ser v vida e interessante Como em todo texto bem escrito voc deve colocar sua mensagem em portugu s claro e evitar palavras complexas acr nimos jarg o e verbos passivos Voc deve tamb m manter curto o comprimento m dio das senten as usadas O desafio real na escrita t cnica expressar id ias complexas Siga minhas dicas abaixo para ajudar a melhorar seus relat rios manuais etc 1 Entendendo o tipo de texto t cnico que voc est escrevendo Relat rios t cnicos costumam ser apresentados em v rias formas e tamanhos mas todos t m o mesmo objetivo de passar claramente uma informa o Decidir que tipo de documento voc necessita escrever uma primeira etapa importante porque influencia sua abordagem do assunto Por exemplo os seguintes documentos precisam de abordagens diferentes Relat rios com Resultados de Pesquisa Estes documentos descrevem o trabalho feito para reco
8. a os artigos que foram emitidos ao cliente na substitui o uma senten a 51 palavras 11 Edite frases prolixas Senten as Mais curtas Para manter registros precisos de invent rio para transa es de substitui o 1 Reduza o invent rio do relat rio de recep o 2 Pe a aos Servi os de Clientes para preparar um relat rio de produ o em artigos reparados e liste no invent rio os artigos substitu dos enviados ao cliente tr s senten as totalize 43 palavras Muito mais claro O palavreado desnecess rio o inimigo da boa escrita Palavras e frases desnecess rias desordenam as senten as e obscurecem o significado Pela compara o a economia das palavras a marca da boa escrita Voc tem que aprender fazer cada contagem da palavra em originais t cnicos Voc deve editar impiedosamente cortando toda a palavra Tenha como objetivo um corte de 10 a 20 por cento das palavras em seu original Para compreender e interpretar um applet o browser deve ter uma m quina virtual de Java a sua disposi o Este o caso em particular com o Netscape Navigator e Internet Explorer bem como com o HotJava da Sun Entretanto n s mencionamos j diversas vezes que muitos surfers navegadores ainda tem browsers mais velhos com os quais eles se sentem confort veis Sendo este o caso se voc usar Java voc limitar o n mero dos visitantes que poder o ficar maravilhados com o que seus a
9. a p gina da direita recto e a p gina da esquerda verso s o mais f ceis para o leitor entender 15 Use exemplos e ilustra es Quando voc escreve sua informa o t cnica lembre se de usar exemplos ilustra es e analogias para explicar informa es complicadas ou id ias novas Por exemplo e O sistema operacional de seu computador como a ponte de comando de um navio o centro de controle para tudo que acontece em sua m quina Um exemplo ou uma ilustra o simples pode ajudar muito a fazer compreens vel a escrita t cnica 16 Use diagramas fluxogramas e gr ficos O ditado de que um retrato vale por mil palavras verdadeiro Um bom diagrama fluxograma ou gr fico podem apresentar a informa o rapidamente o que provavelmente usaria dez senten as para explicar Click para ver um diagrama mostrar a embreagem do carro Tal diagrama faz toda a explana o ou descri o t cnica distante mais f cil de compreender 17 Use um bom layout de p gina disposi o do texto figuras etc para atrair a aten o informa o t cnica chave Uma boa disposi o pode ajudar a guiar os leitores informa o chave Por exemplo quando voc escrever instru es do que o leitor deve fazer use afirma es numeradas destacadas em negrito Eis aqui um exemplo da boa disposi o e dos diagramas que fazem a f cil de encontrar seu caminho em um conjunto de instru es Mudando Texto Substituir no Menu
10. ale corretamente 13 Evite o jarg o especialmente e acr nimos e abreviaturas e n o palavras inven es e palavras e frases abstratas Os leitores odeiam jarg o e os escritores t cnicos t m uma reputa o pobre para o jarg o o problema mais mencionado em documentos t cnicos e para o qual voc tem que estar contra em defesa constante Jarg o montado Jarg o livre A maioria de revestimentos O g s de exaust o refrat rios at hoje apresenta eventualmente corroe o uma falta de confiabilidade revestimento das cer micas quando submetidos invas o existente de part culas de mat ria no fluxo do propelente sob dura es prolongadas de fogo Mais do que todo o outro problema de escrita o uso de jarg o depende das suas audi ncias Escreva um manual para Visual Basic para usu rios dessa linguagem e seu jarg o t cnico um atalho informa o O mesmo jarg o t cnico para algu m aprendendo Visual Basic faz o entendimento do assunto mais dif cil Aqueles com nenhuma experi ncia de Visual Basic o jarg o t cnico transforma se uma floresta impenetr vel de termos abstratos ou desconhecidos Entretanto o jarg o mais do que um termo especial Por exemplo Profiss o Exemplo Computadores Batch processing JPEG e macros Direito affidavit easement e surety Matem tica desvios duodecimal romb ide e padr o Medicina angina paralisia cerebral e tonsiloctomia
11. entar a informa o essencial Por exemplo Abertura Convencional Relate no software FIREWALL Antecedente O Grupo de Avalia o IT criou este relat rio junto para examinar as maneiras alternativas de proteger os dados da empresa Em particular o conceito do software FIREWALL definido como o software que pode ser usado para proteger uma organiza o dos v rus e de acesso n o autorizado em bancos de dados e o seu uso dentro da empresa avaliado A fim avaliar as alternativas dispon veis seis avaliadores t cnicos independentes foram instru dos sobre os bancos de dados da empresa procedimentos existentes Este relat rio tira as conclus es dos seis avaliadores Informa o Essencial Software FIREWALL Protegendo os dados da empresa O software FIREWALL essencial para proteger as bancos de dados da empresa de v rus ou de acesso n o autorizado Investindo 20 000 na ltima vers o do software a empresa proteger seus 30 000 registros e contas de clientes e estar protegido contra fraudes com cart o de cr ditos estimados em custar ind stria 2 5 bilh es por ano Uma vez que voc escreveu suas se es e subse es reveja as Retire aquelas que n o s o essenciais Trabalhe ent o na melhor ordem das se es e subse es para deixar os leitores escolherem a informa o que necessitam 5 Escreva seus t tulos usando verbos fortes e substantivos espec ficos Quando voc
12. iria as etapas necess rias e indicaria todos os problemas O relat rio n o recomenda se a empresa deve implantar sua pr pria Intranet Relat rios T cnicos De Recomenda o Estes relat rios conduzem recomenda es espec ficas Ele montado sobre o relat rio de avalia o e chega a recomenda es espec ficas para ajudar ao respons vel pelas decis es a adotar a melhor solu o Naturalmente alguns relat rios t m frequentemente ambos os relat rios de avalia o e recomenda o englobados num s Manuais t cnicos e instru es Aqui a nfase est em como usar dispositivos aparelhos equipamento ou programas de computador A tarefa aqui escrever procedimentos passo a passo que qualquer um pode compreender e seguir 2 Escreva seu objetivo espec fico Pergunte se porque eu estou escrevendo e o que eu estou tentando conseguir Se voc n o souber as possibilidades de escrever boas especifica es t cnicas s o remotas Se voc definir seu objetivo voc pode ent o comparar toda a informa o argumentos e recomenda es com esse objetivo Por exemplo voc p de escrever um relat rio sobre o software FIREWALL mas seu objetivo diferente se voc necessitar escrever um sum rio de uma p gina ou uma especifica o t cnica de 100 p ginas Se voc definir seu objetivo como Objetivo Explicar como o software FIREWALL protege os dados da empresa Com este objetivo em primei
13. ivo Tome o seguinte exemplo depois compare ent o o esbo o no portugu s claro compreens vel Esbo o em portugu s claro De toda a p gina de um site links podem ser encontrados direcionando para outras p ginas no mesmo site ou para outros sites onde quer que eles estejam Especificamente estes links s o endere os que s o chamados URL Entretanto o que interessante para o visitante n o o pr prio endere o e geralmente o endere o n o mostrado Ao inv s disso o que voc encontra destacado no texto sublinhando o e indicando o em uma outra cor frequentemente azul Voc pode ligar toda a p gina a outras p ginas no mesmo site ou sites diferentes Estes endere os de URL geralmente escondidos da vista guiam o usu rio p gina correta O usu rio pode ent o clicar em qualquer texto sublinhado mostrado frequentemente em azul e mais informa o aparece Somente uma pequena porcentagem de documentos t cnicos est no portugu s claro Estes s o frequentemente esbo ados pelos experts escritores profissionais geralmente com treinamento jornal stico ou treinamento e experi ncia em edi o Quase cada escritor t cnico necessita de ajuda para quebrar h bitos pobres de estilo A maneira a mais r pida de aprender escrever no ingl s claro usar o StyleWriter que edita o software Este programa encontra os problemas da l ngua inglesa em sua escrita destaca os em seu rela
14. lher a informa o no laborat rio ou no campo Podem ser simples registros ou dados ou podem ser mais completos e incluir o problema ou o assunto examinado o m todo ou o equipamento usado os dados coletados e as implica es resultantes Relat rios De Informa o T cnica Simples Este documento explica um assunto t cnico N o tem nenhum objetivo a n o ser certificar se que os leitores compreenderam claramente o t pico Por exemplo um relat rio t cnico sobre um investimento no mercado de futuros explicaria provavelmente como o mercado evoluiu como funciona os termos especializados e assim por diante Um relat rio t cnico simples para informa o n o expressa um ponto de vista sobre os m ritos de investir no mercado nem tem recomenda es Especifica es T cnicas As especifica es consistem tipicamente nas descri es das caracter sticas dos materiais dos usos e dos funcionamentos de um novo produto As boas especifica es devem se concentrar em gr ficos dados e ilustra es em vez de descri es escritas Pense em um pedido de patente como um bom exemplo Relat rios T cnicos De Avalia o Relat rios da avalia o chamados s vezes relat rios de praticabilidade apresentam a informa o t cnica de uma maneira pr tica e l gica para decidir se se algo poss vel Por exemplo um relat rio t cnico de avalia o sobre implantar uma Intranet para uma empresa examinaria se isso seria poss vel defin
15. lo se voc estivesse tentando identificar a raz o pela qual a correia parou para que um gerente t cnico necessitasse agir para parar a falha voc necessitaria entrar em detalhes t cnicos da falha espec fica Se voc estiver escrevendo para o gerente n o t cnico que quer saber porque h um problema e como voc o reparou a informa o espec fica mostrada acima o bastante Escolher o quanto espec fica sua informa o deve ser um problema constante para o escritor t cnico Recorde se voc est tentando lan ar a informa o exatamente para suprir as necessidades do leitor Foque na escrita e descreva a informa o concreta sem vaguear em informa o irrelevante 8 Escreva em portugu s compreens vel direto O bom texto se t cnico ou geral apresenta a informa o relevante em um estilo claro O texto t cnico tem uma reputa o t o pobre pergunte aos usu rios o que pensam de manuais de computadores porque os escritores falham em usar um portugu s claro direto compreens vel O portugu s compreens vel um estilo simples que qualquer um pode compreender Voc tem que controlar o comprimento da senten a usar os verbos ativos reduzir jarg es desnecess rios fazer sua escrita espec fica e firme Esta n o a maneira que n s aprendemos a escrever na faculdade ou no local de trabalho A cultura da escrita acad mica e de neg cios e da escrita cient fica s o os estilos ma ante prolixo e pass
16. m atolamento na correia transportadora Para manter a correia em funcionamento um engenheiro mec nico teve que restaurar o temporizador e os rolos na correia transportadora substitui o refrigerante e diminuiu a velocidade da correia em 25 para 200 p s por hora Detalhe Excessivo Monitorando se a temperatura viu se uma eleva o de 80 5 graus Fahrenheit a 124 5 graus Fahrenheit causando problemas na temperatura do refrigerante Como a temperatura ideal do refrigerante de 80 graus Fahrenheit o resultado foi uma expans o do refrigerante al m de seu m ximo n vel de temperatura de 105 graus Fahrenheit Isto por sua vez causou uma falha da correia transportadora que foi retificada pelo engenheiro mec nico avaliando os exatos coeficientes de refrigera o necess rios com uma poss vel temperatura ambiental acima dos n veis recomendados do fabricante Tr s ajustes reduzidos foram considerados a saber reduzindo a velocidade da correia por 10 por 20 e por 25 Estes conduziriam a uma redu o na velocidade in line da linha de montagem de 80 p s de 160 p s e de 200 p s por hora respectivamente O ajuste timo foi de 25 32 da taxa precedente de 800 p s por hora Entretanto antes que este ajuste fosse feito o engenheiro teve que substituir os 3 5 gal es do refrigerante usado e restaurar 42 ou os 360 rolos na correia O quanto espec fico seu texto deve ser depende do leitor e de sua raz o para a escrever Em nosso exemp
17. o encontrar facilmente a informa o que os interessa e absorver rapidamente a informa o crucial que eles necessitam saber Se voc n o organizar bem seu documento os leitores podem perder informa o importante sua responsabilidade apresentar sua informa o em uma maneira leg vel e bem organizada Voc deve fornecer sum rios informativos instru es claras e uma organiza o l gica para deixar seus leitores escolher as partes que eles querem ler Por o exemplo pense numa boa p gina que voc viu na Internet N o f cil de navegar e conseguir a informa o que voc quer rapidamente Como os leitores n o ir o ler da p gina de abertura ltima p gina uma boa organiza o aqui essencial Isto tamb m verdade para um manual onde os leitores necessitem encontrar como reparar um problema ou um relat rio onde o leitor queira encontrar a raz o para uma decis o t cnica Assim uma id ia boa escrever as se es e as subse es que voc necessita para planejar seu documento Isto ir ajud lo a pensar sobre seu objetivo e a necessidades dos seus leitores descartar informa o desnecess ria refor ar a informa o importante e assim por diante 4 Evite come ar com antecedentes introdu o ou metodologia Estes t tulos incentivam no a aquecer se at a tarefa da escrita e a desperdi ar a parte a mais valiosa do original a primeira p gina Ao inv s disso use a p gina da abertura para apres
18. o ter ultrapassado a 600 graus Fahrenheit Lembre se leitores podem geralmente usar alguns palavras ou termos do espec fico se o estilo do texto for conciso e f cil de ler 7 Mantenha a informa o espec fica ao inv s de geral Voc j viu leitores procurar num documento usando uma caneta marcadora para procurar as palavras chaves os fatos e as figuras Eles n o destacam frases como Como voc est ciente a finalidade deste documento a fim de Os leitores querem obter informa o espec fica dos documentos t cnicos Por exemplo e precipita o pesada e quatro polegadas da durante o per odo chuva em 48 horas calor excessivo e 120 graus e Fahrenheit selecione a tecla e clique Alt B apropriada Ao mesmo tempo em que voc se previne de entrar em detalhes excessivos substituir a informa o geral pela informa o espec fica melhorar seus documentos t cnicos Por exemplo se um gerente quiser saber porque a produ o parou por uma hora na linha de montagem o autor tem que decidir apenas quanto a mensagem deve ser espec fica Demasiado Geral Os problemas apareceram em um n mero de reas do dispositivo de transporte de estoque que requereu a interven o por um membro apropriadamente qualificado da equipe de funcion rios de maneira que a a o corretiva pode ser tomada Conforme a temperatura se elevou a 120 graus de Fahrenheit o refrigerante para os rolos met licos superaqueceu causando u
19. pplet fazem Al m disso os browsers t m uma op o da configura o que permita que por raz es da seguran a por exemplo a m quina virtual de Java seja desligada pessoas cautelosas fazem o uso frequente desta op o 116 palavras Conciso Os browsers tais como o Netscape Navigator Internet Explorer e HotJava da Sun podem somente usar applet com as m quinas virtuais de Java Se os Web surfers usarem browsers mais antigos que n o compreendam Java ou desliguem a op o de Java por raz es da seguran a voc ter poucos visitantes em seu site 52 palavras 12 Use palavras simples ao inv s de complexas Muitos escritores t m a dificuldade em manter sua mensagem simples e clara Em vez de usar palavras do dia a dia usam palavras complexas ou estranhas Palavras simples do dia a dia ajudar lhe o a entregar sua mensagem Frequentemente os escritores t cnicos usam palavras tais como adicional indicar iniciar e proliferar em vez das palavras simples acr scimo mostrar come ar e espalhar Palavras Complexas Palavras Simples Como n s notamos na se o precedente se voc adquirir op es adicionais da impressora tais como uma segunda bandeja uma exig ncia que voc verifique sua correta instala o Como n s notamos na se o precedente se voc comprar o equipamento extra da impressora tal como uma segunda bandeja da impressora deve certificar se de que voc a inst
20. que n o existem quando voc escrever Se seu Corretor Ortogr fico destacar uma palavra como rotacionar autoized groupware ou o helpware em seu original a possibilidade de que voc est vagueando no mundo do jarg o do escritor Mantenha as palavras que as pessoas compreendem ou ao menos podem consultar num dicion rio padr o seus leitores agradec lo o pelo esfor o Evite palavras e frases abstratas Um h bito que voc deve evitar comum maioria dos escritores t cnicos o uso abusivo de palavras abstratas Aqui est uma lista das mais comuns a evitar em sua escrita Palavras abstratas a evitar na escrita t cnica atividades dispositivos entradas setores amenidades elementos opera es estruturas amenity facilidades sa das sistemas aspectos fatores processos vari veis conceitos fun es recursos Por exemplo o que um dispositivo uma sa da ou uma facilidade Tais palavras s o t o abstratas que elas se tornam sem sentido para o leitor Junte as como dispositivo de sa da e voc tem o jarg o imediato para a palavra impressora 14 Mantenha os termos t cnicos a um m nimo Embora um vocabul rio t cnico de especialista seja necess rio n o deixe isto ser uma desculpa para usar a palavra t cnica impensadamente Por exemplo em um manual usado para editora o eletr nica voc poderia usar termos como f lio o recto e verso Mas por que Pode ser usado simplesmente p gina ou o n mero de p gina
21. r para especialistas ir alterar a quantidade de informa o t cnica que voc pode incluir Se voc estiver na d vida siga a abordagem mais simples muito melhor usar um pouco mais de tempo para explicar algo de maneira que todos possam compreender do que usar um jarg o que um atalho que aliena ou confunde alguns de seus leitores Entretanto voc ainda tem que incluir uma linha em algum lugar Por exemplo voc pode ter que escrever para leitores t cnicos e n o t cnicos Suponha que voc tem que explicar como funciona o mecanismo de refrigera o de um armaz m Voc pode ter que assumir que ambas audi ncias o perito e n o perito compreendem termos comuns tais como o selo do anel valor do batente termostato Mas voc pode necessitar explicar uns termos mais complexos tais como a matriz da temperatura do refrigerador mesmo se os leitores peritos conhe am os termos Escrita T cnica Pobre Os interruptores de alavanca da s rie 15ATS em um lote de 200 no total eram sujeitos ao extremo das temperaturas causadas pela proximidade ao forno Esta por sua vez causou a falha t rmica porque a expans o do metal causou uma falha por meio de qual a conex o do metal fundiu O calor do forno tem que estar acima de 600 graus Fahrenheit antes que este efeito ocorra Conciso e f cil de ler Acima de 200 interruptores autom ticos de alavanca fundiram quando o teclado fundiu devido a temperatura do forn
22. rais e s o 29 palavras mais curtas Verbos Passivos A experi ncia foi conduzida de modo que o relacionamento entre as duas teorias pudesse ser examinado Primeiramente as culturas foram preparadas e ent o examinadas sob o microsc pio para ver se alguma impureza poderia ser encontrada Uma vez que a pureza das amostras podia ser estabelecida elas foram usadas em seis testes independentes 54 palavras Verbos Ativos A experi ncia examinou o relacionamento entre as duas teorias Primeiro o exame microsc pico para impurezas isolou os exemplos puros usados posteriormente em seis testes independentes 25 palavras Trocando seu estilo de verbos passivos para verbos ativos durante toda sua escrita voc enfrenta diversos problemas e Voc deve assinal los precisamente Frequentemente os escritores perdem verbos passivos ou tentam mudar os verbos que s o j ativos e Voc necessita medir seu uso de verbos passivos Um ou dois verbos passivos por p gina n o arruinar o seu estilo nove ou dez ir o e Voc necessita saber trocar verbos passivos para verbos ativos 10 Mantenha o comprimento m dio de sua senten a entre 10 a 20 palavras As senten as longas fazem todo o documento dif cil de ler Em documentos t cnicos mantenha o comprimento m dio de sua senten a entre 10 a 20 palavras Voc pode reduzir para t o baixo quanto 10 ou 11 palavras se voc estiver escrevendo instru es com
23. ro plano na sua mente voc pode decidir se na informa o mais relevante Voc p de decidir se por Excluir alternativas ao software FIREWALL Excluir uma revis o de diferentes pacotes fabricantes de software FIREWALL Refor ar a informa o espec fica da companhia que tem mais risco Verificar o custo de introduzir o software comparado ao custo de perder dados Descrever o resultado do worst case o que de pior pode acontecer Examinar as informa es t cnicas a superar para usar o software FIREWALL Estabelecer seu objetivo deve ser a primeira etapa em qualquer texto Focalizando seus pensamentos voc come ou a pensar claramente sobre o que seus leitores necessitam saber Quando trabalhar seu objetivo voc poder necessitar esclarecer a tarefa perguntando seu supervisor ou colegas informa es sobre a tarefa Continue fazendo perguntas at que voc tenha uma clara id ia de porque voc est escrevendo e do que voc quer conseguir porque isso ajudar a coletar a informa o certa e se decidir como apresent la a seus leitores Se voc tiver mais de um objetivo classifique os na ordem da prioridade 3 Planeje as se es e as subse es que voc necessita Com textos t cnicos voc deve apresentar sua informa o aos leitores de maneira que eles possam usar o relat rio ou manual para a finalidade para qual ele foi solicitado extrair os pontos principais sem necessariamente ler todo text
24. seu uso de formas encurtadas a um ou a dois em todo o documento n o importa o qual seu comprimento e As abreviaturas a evitar s o aquelas que voc pensa que necess rio explicar entre par ntesis a primeira vez que voc as usa Cada vez que voc faz isto voc faz um teste de mem ria para seu leitor N s testamos isto pedindo que dez gerentes leiam um memorando de duas p ginas com as duas abreviaturas explicadas na primeira p gina Quando viraram a p gina e leram as abreviaturas n s perguntamos lhes o que eles entenderam das abreviaturas Somente uma pessoa indicou corretamente o que entendeu uma taxa de falhas de 95 e Use seu SPELLING CHECKER para encontrar acr nimos e abreviaturas um lembrete constante que voc pode usar excessivamente Se voc quiser encontrar os acr nimos e abreviaturas usadas em sua organiza o olhe os dicion rios que fazerm parte do seu processador de palavra Word e similares e Lembre se que usar abreviaturas e acr nimos pode ser entendido horrivelmente errado na mente do leitor No Inglaterra h um acr nimo no uso comum chamado PMT para a pre menstrual tension tens o pr menstrual o equivalente nos Estados Unidos pre menstrual syndrome Um coordenador escreveu uma vez para uma cliente afirmando eu pretendo visit la e inspecionar seu PMT no m s seguinte Na realidade ele estava se referindo a Pole Mounted Transformer Evite n o palavras Evite as palavras
25. t rio t cnico e explica o como edit los Eu uso StyleWriter para todos meus relat rios e recomendo o altamente gt gt Propaganda do software 9 Use verbos ativos ao inv s de verbos passivos Usar verbos ativos a primeira regra da boa escrita Todas as autoridades numa boa escrita incluindo grupos cient ficos e t cnicos recomendam verbos ativos ao inv s de verbos passivos Por que Os verbos passivos s o prolixos amb guos e ma antes Os verbos ativos fazem sua escrita mais simples mais menos in bil clara e mais precisa Eis aqui um exemplo Verbos Passivos Verbos Ativos A impressora QMS Magicolor 2 equipada com duas interfaces uma conhecida como interface paralela a outra conhecida como a interface Ethernet Qualquer que seja a conex o de interface necess ria voc ver que o MS WINDOWS 98 j estar preinstalado e suas aplica es de software s o baseadas nesta plataforma 51 palavras A impressora QMS Magicolor 2 tem interfaces paralela e Ethernet Qualquer que seja a conex o de interface necess ria as suas aplica es de software ir o trabalhar no MS WINDOWS 98 j preinstalado 31 palavras A escrita t cnica est cheia de verbos passivos porque a maioria das pessoas aprende na terceira pessoa porque ela supostamente mais objetiva Esta uma falsa no o No exemplo seguinte os passivos e os ativos s o ambos objetivos mas as senten as ativas soam mais natu
Download Pdf Manuals
Related Search