Escrita técnica para estarrecida
Introdução
Às vezes pode ser além do orçamento das companhias ou dos indivíduos para empregar um escritor profissional para dirigir-se a sua documentação técnica. Embora em um mundo ideal toda a documentação técnica deva ser produzida por um perito altamente treinado, infelizmente nós não vivemos em um ideal. Na mesma maneira que muitos povos tentarão reparar seus próprios dispositivos home, muitos povos tentarão escrever a qualidade originais técnicos. Apenas como fiddling com um toaster pode resultar no electrocution, tentar escrever originais técnicos do risco sem conselho prévio resultará finalmente na falha. Como uma régua de polegar que áspera você deve sempre procurar empregar um specialist, mas se para o que razão você não possa e você são o infelizes pobres que tiveram os deveres da documentação impingidos neles, não despair. Esta guia do sumário esboça algumas das habilidades que do núcleo você necessitará trazer a sua escrita, de pacotes técnicos das convenções a estar cientes de, de software você pode considerar, e das coisas definitivas a evitar. Nivele esperançosamente se você nunca o escrever a uma sentença em sua vida sobre qualquer coisa vaga técnico tiver muito no menos, um retrato mais largo de o que a escrita técnica envolve.
Que é escrita técnica?
A escrita técnica unsurprisingly bastante, consulta à escrita que é técnica. Embora isto possa parecer como uma definição fallacious, é importante a recordar. Demasiado muitos autores técnicos fazem o erro de criar a documentação que é ou demasiado técnica, ou demasiado ' literário '. Um autor técnico bom deve poder ajustar o contrapeso entre os dois para servir o usuário da extremidade da documentação. A escrita técnica é muito como invisível pervasive no entanto bonito do ar fresco, muito. No mundo wired estranho em que nós nos encontramos, a escrita técnica está em toda parte. Os manuais do software, as guias do usuário para os dispositivos home, os leaflets instrutivos, os email, as letras, os relatórios, os relatórios de notícia técnicos, os statistics e as biografias em esportes da televisão mostram que todos são os exemplos da escrita técnica a que os povos são expostos sobre a uma base diária. Se você sempre tentasse programar os ajustes do tempo em um registrador video home e arremessasse o manual através do quarto na aversão, você jogou uma parte de escrita técnica (embora obviamente não muito boa!).
A literatura técnica de muitas vezes é produzida demasiado por escritores com não um aperto grande bastante da tecnologia, ou por technologists que faltam uma abilidade de escrever. Como um autor técnico em perspectiva você deve pisar a linha muito delicada de ser tècnica knowledgeable em seu field(s) do specialist as.well.as ser um escritor ' bom ' (ao contrário dos escritores ' maus ' que podem geralmente ser encontrados atacar senhoras velhas doces ou algo). A documentação técnica é produzida geralmente para dois grupos de usuário distintos, a saber usuários nivelados peritos, e usuários ingénuos. Porque um autor técnico um de suas primeiras tarefas deve classificar para fora de que audiências você está escrevendo para, a que me traz deftly:
Conheça o foe thy
Como o clichà velho© vai, todos um crítico. Isto é particularmente verdadeiro da reação de a maioria de pessoa são quando enfrentado com escrita técnica. Como foi destacado no exemplo do registrador video acima, a escrita técnica pode ser impenetrable ao usuário da extremidade. Se este for o caso, é porque quem quer que escreveu a documentação, não se incomodou identificar suas audiências e escrevê-las a seu nível. Parece um ponto óbvio a fazer, mas um que é negligenciado frequentemente, que o usuário dos originais seus está criando, não pode realmente ser um perito. Obviamente se você criasse um original em um produto particular do specialist para um grupo de usuário avançado particular (um exemplo bom poderia examinar o software para administradores do sistema computatorizado) então que você necessitará compôr este é uma maneira inteiramente diferente do que se você estiver criando para o exemplo, um manual técnico para o software de computador do mercado maciço visou o usuário home inexperienced. Uma das primeiras tarefas que você deve realizar antes que você puser mesmo a pena ao papel, do dedo ao teclado, deve identificar quem o usuário de seus originais será e construirá os originais visados que group(s) particular do alvo. Se você começar este estágio correto, deve evitar seus originais que estão sendo jogados através dos quartos no annoyance!
Planear para a perfeição
Uma vez que você identificou o mercado de alvo para os originais que você estará criando, você necessitará começar planear como os originais serão organizados. Este processo é pela maior parte dependente de que documentação está sendo produzida, mas você pode seguir algumas réguas de polegar ásperas. Firstly, se os originais deverem suportar um produto particularmente detalhado (tal como uma aplicação de computador) comece suas mãos grubby nela tão rapidamente como você pode. Examinando o produto em detalhe você pode formular uma planta do ataque e começar a compôr uma estrutura organisational. Whilst você está explorando o produto em detalhe, as notas copious da tomada, como fazer isto durante os estágios exploratory iniciais podem conservá-lo o tempo que pode ser absolutamente vital se você estiver trabalhando ao fim do prazo. Mesmo no estágio que de planeamento você deve se assegurar lá está uma consistência à disposição, e uma estrutura organisational para o original. Selecione convenções do numbering, paragrafe estilos, e gere idéias ásperas para finalidades da disposição agora, e excepto o tempo vital mais tarde.
Deixe um esboço dentro
Antes de mergulhar headfirst em criar a documentação, esboço para fora de cada seção primeiramente. Isto reservará para requisitar novamente se os originais que estão sendo criados não tiverem ' um fluxo lógico ' sem seriamente ter o impacto no projeto. Muitos originais técnicos (especial para produtos mais detalhados) são compostos (e em alguns casos praticamente incontáveis) de iterações numerosas. Isto é porque o produto desloca e muda o tempo excedente, e um dos deveres principais de um autor técnico deve manter-se lado a lado destas mudanças, e assegurar-se de que sejam tudo bons documentados. Os autores técnicos bons empurrarão sempre seus originais através de tantos como esboços como humana possível, refinando em cada esboço, até que alcancem uma posição por meio de que (e seu empregador) estão satisfeitos que a documentação é oportuna, exato e uma reflexão verdadeira do produto ou o processe documenta.
O diabo está no detalhe
Como a escrita já identificada, técnica é chamado isso porque é técnico na natureza. A peça de ser técnica deve ser precisa, e a parte da precisão deve ser tão detalhada como humana possível. Mesmo se os originais que você está criando são para um avançado e o grupo de usuário technologically sofisticado, sua documentação deve focalizar nos detalhes de um processo, ou em usar um produto. Este pode ser um feat difícil a realizar, mas não se você escreve a suas audiências. Nunca suponha que o leitor sabe que qualquer coisa sobre o produto ou o processo esteja documentado, mas no exemplo usuários avançados/peritos tenha ao menos o sentido comum reconhecer o fato que provavelmente não necessitam ser ditos como usar o equipamento que operam sobre uma base diária. Ao descrever como realizar uma atividade ou uma tarefa particular, identifique cada estágio envolvido (os numere se isto couber as convenções do tipo que do original você está criando) e assegurar a exatidão de o que você lhe escreveu teste você mesmo, ou melhorá-la mesmo, corda em um voluntário do mesmo nível de habilidades que o usuário da extremidade.
Escolha a ferramenta direita para o trabalho
Embora seja possível criar originais técnicos usando o parchment e o sangue, não é aconselhável. Muitas aplicações do software do specialist existem para ajudar-lhe criar a documentação poderosa, e a parte de seus deveres como um autor técnico, inclui selecionar a ferramenta direita para o trabalho. Pela maior parte isto depende da natureza dos originais que estão sendo produzidos, e da natureza de sua distribuição eventual. Se os originais puderem ser entregados usando o Internet, esta é certamente uma avenida a considerar. A essa extremidade empregue pacotes tais como o MX do flash e o Dreamweaver para conseguir este objetivo. Para a ajuda em linha integrada, você pode desejar criar originais crus do HTML, ou selecionar alternativamente um pacote do specialist tal como RoboHelp ou similar. Na caixa de originais baseados da cópia, você necessitará selecionar um pacote de software poderoso bastante para segurar o que você jogará nele.
Muitos autores técnicos inexperienced giram imediatamente para a palavra de Microsoft (porque é ubiquitous pode dentro ambientes comerciais e confidenciais). A menos que sua documentação estiver indo ser abaixo de 150 páginas, e de você saiba criar moldes e para fazer macros, evite o MS palavra. Porque todo o autor técnico o dirá tem hábitos nasty todos que deve possuir, e pode frequentemente ser um pacote instável a trabalhar com. Se você estiver criando a documentação pesada dos gráficos, você pode desejar considerar Quark Xpress, ou escolha potencial o líder de indústria no campo, adôbe Framemaker. O que software você seleciona, você deve assegurá-lo torna-se incredibly proficiente com ele, investing no treinamento, ou usando o dia após o dia após o dia!
Comunique-se que o que você é pagado para fazer!
Muitos povos dir-lhe-ão que criar a documentação técnica é tedious e repetitivo. Estes povos, são errados, e possivelmente morons demasiado. Embora você possa encontrar o processo de criar a documentação técnica ' que fura ' (se você faz você está no trabalho errado!) não é. Criar originais técnicos da qualidade é um estágio vital em permitir povos usa a adequadamente e corretamente a tecnologia. Embora nenhum usuário aproxime a documentação que você cría na mesma maneira que aproximam uma novela, você pode finalmente ajudar-lhes conseguir o que quer conseguir usando a tecnologia. Não importa como ' maçante ' o processo pode parecer ser, permitir que os usuários consigam seus objetivos lendo seus originais deve dar-lhe arremetidas do orgulho e certamente, felicidade. Tão por muito tempo como você recorda os efeitos positivos que a tecnologia pode ter em vidas do pessoa, quando você cría seus originais você pode comunicar-se mais eficazmente, porque você será mais feliz no processo communicative. Durante todo o ciclo de vida da documentação, você deve procurar liaise tão frequentemente com colegas como possível (se aplicável). Deixe-os ler seus originais, escutar seus criticisms, e ajustar seus originais (se você não pode discutir seu canto!). Um autor técnico é pagado para comunicar-se, certifica-se de que você , e para esquecer-se nunca de porque seu se estão comunicando, e a quem, nos originais eles mesmos.
Erros comuns para evitar de fazer
Ao criar originais técnicos lá seja um número de falhas que fatais você pode fazer. Embora de nenhuma maneira exhaustive, esta seção detalha alguns dos erros que mais comuns os autores novos fazem, nas esperanças que você evitará de as fazer demasiado:
Sendo Patronising - embora a documentação técnica deva estar desobstruída, deve nunca patronising. Você não está criando os originais a ser lidos por morons mas por consumidores e por clientes. Você deve sempre escrever ao nível de habilidades de suas audiências, mas não importa o que os povos nivelados técnicos são sobre, não são morons. Mesmo as crianças começam offended quando patronised, não fazem esse erro com alguém que está pagando seu salário, criança ou de outra maneira.
Overuse do humour - os povos não lêem os originais técnicos a entertained, lêem-nos nas esperanças com sucesso de terminar um processo, ou de extrair a informação. A menos que for relevante ao usuário da extremidade, evite o humour wherever possível. Se você estiver escrevendo um livro, uma multa e um bom. Se você estiver escrevendo um manual, evite o humour como o praga, como mais frequentemente do que não os usuários faltarão o gracejo e a extremidade justa que detestam acima o idiot patronising que escreveu a documentação.
Inconsistência - mesmo no estágio esboçando, você deve assegurar-se de que todos os elementos usados em seu original sejam consistentes. Isto aplica tanto quanto ' ao tom ' do original a respeito da disposição dele. Assegure-lhe o uso os sentidos consistentes (primeiros pessoa, etc..) as.well.as a disposição de página, os elementos dos pagination, os encabeçamentos e os footers, e todos elementos textual restantes.
Prova lida - para o fim de criar uma parte de documentação técnica, você será provavelmente doente da vista dela. Isso não importa. O que importa é o que saem de seu escritório ou home, é exato. A essa extremidade a prova leu o original durante todo tudo que é esboços, e antes que esteja distribuída a prova leu-a outra vez, e outra vez, e outra vez. Nunca confie em verificadores do período (eles nunca trabalho) e se você puder o evitar, nunca confie unicamente em seu próprio julgamento. Comece seu original lido por tantos como pares dos olhos como possível antes da distribuição, apesar de tudo, poderiam manchar a uma coisa que você faltou durante todo o processo da criação.
Conclusão/promotion shameless do self
A escrita técnica não é não obstante o que você pode pensar, um trabalho fácil. Requer a perícia, a paciência e uma mistura muito impar das habilidades. Justo como todo o outro trabalho, você pode aprender como a o faça, mas mesmo essa taxa de matrícula não lhe fará necessariamente nenhum bom nela. Para ser um autor técnico bom, você tem que ser anal contudo creativo, focalizado contudo communicative, e um perito flexível. Esta, como você pode provavelmente imaginar, não é nenhuma tarefa simples. Embora você possa pensar que criando originais técnicos é fácil, a documentação exata, consistente e oportuna criar a um padrão comercial elevado é um papel altamente challenging. Não obstante seu orçamento, a longo prazo fornecerá o ROI significativo se você empregar um specialist. Apesar de tudo, poderão fazer nos dias, o que você rasga seu cabelo nosso tentar realizar em meses das semanas if.not.
Sobre O Autor
Sobre o microfone dos anos Kemp foi empregado como um freelance ELE journalist (que trabalham para publicações tais como o registo, o Namesfacesplaces, o foco da segurança e o Packetstorm), um copywriter, um desenhador dos videogames, um revisor de contas da segurança, um desenhador da correia fotorreceptora, um desenhador gráfico e ELE instrutor. Trabalhou em uma variedade de posições freelance e permanentes para ambos os (por exemplo dois homens e companhias pequenos de um cão) às organizações multinacionais durante todo o Reino Unido e Europa. Ao não trabalhar em vários artigos, os livros, manuais, e assorted a outra cópia para clientes, microfone podem geralmente ser encontrados labutar em uma variedade de novelas unpublished. Teve diversos de seus screenplays curtos produzidos por companhias independentes da produção, e está trabalhando atualmente em diversos certificados do comprimento da característica.
O microfone vive na maior parte feliz em um suburb terrìvel un-un-bohemian de Londres com seu (e longo-sofrendo) sócio a longo prazo, e dois addled gatos. Para aprender mais sobre o microfone, a escala dos projetos foi envolvido dentro, e o outro material e absurdo assorted, visitam por favor seu homepage pessoal em www.clappymonkey.com.
Artigo Fonte: Messaggiamo.Com
Related:
» Credit Secrets Bible» Cash Making Power Sites
» Home Cash Course
» Automated Cash Formula
Webmaster começa O Código do HTML
Adicionar este artigo para o seu site agora!
Webmaster enviar seus artigos
Nenhum registro necessário! Preencha o formulário e seu artigo está no Messaggiamo.Com Diretório!
