Categoria: Top » Internet » Web-design

Planeando seu projeto técnico da escrita

Tags: administração virtual, escritores técnicos, projeto da correia fotorreceptora de Clackmannanshire, autor técnico

É útil seguir um processo do jogo ao produzir a documentação. Tendo um processo em ajudas do lugar certifique-se de que você compreende completamente as exigências do projeto da escrita antes que você comece. Isto ajudará reduzir a necessidade para reescrever e adicionar a informação mais tarde no processo. A primeira etapa no processo da escrita é criar uma planta para a documentação que você está a ponto de escrever. Para fazer este você deve responder às seguintes perguntas no original:

Que tipo de original é ele?
Que é a finalidade do original?
Que informação chave deve você cobrir?
Quem lerá o original?
Quanto os leitores sabem sobre o assunto?
Que estilo deve se usar ao escrever o original?

Que tipo de original é ele?

Há uma variedade larga de originais técnicos e cada tipo do original terá um formato específico. Para o exemplo, uma guia do usuário fornece instruções para usar um produto. Este tipo de original é escrito assim em torno das tarefas que você quereria o usuário poder executar. Onde como um relatório ou um estudo de caso mande também seu próprio específico formatar.

Que é a finalidade do original?

A resposta a esta pergunta ajuda à guia sua escrita. Tendo uma finalidade desobstruída na mente pode ajudar fazer sua escrita alvejada mais para o tópico e para significá-lo seja mais menos provável adicionar a informação redundante que não ajuda para a realização da finalidade.

Que informação chave deve você cobrir?

A resposta a esta pergunta guiará seu dentro o índice a incluir ao escrever o original. Para o exemplo, criar uma guia do usuário envolve produzir uma lista das tarefas que você quereria o usuário poder executar após ter lido a guia. Quando escrever a um relatório isto será as partes de informação chaves que seu relatório cobrirá. Neste estágio que você quer ser breve ao esboçar a informação chave, não comece pena bogged pondo em demasiado detalhe.

Quem lerá o original?


Isto é onde você olhar em quem lerá sua documentação. Se sua documentação tiver audiências múltiplas esta pode afetar como você escreve e como você estrutura a documentação. Para o exemplo, uma guia do usuário pode ter dois audiências, administradores e usuários. Cada audiência pode necessitar poder executar tarefas diferentes, assim que uma maneira boa estruturar a guia pôde dever ter uma seção separada para cada audiência ou separar mesmo originais.

Quanto os leitores sabem sobre o assunto?

Avalie quanto seus leitores sabem sobre o assunto. Isto ajudará guiá-lo em quanto informação você necessita incluir. Para o exemplo, se você estiver escrevendo uma guia para administradores de sistema para se usar instalar uma parte nova de software você pode supor que têm um conhecimento bom de sistemas computando e você necessitará somente entrar no detalhe onde a informação é específica ao produto que você está escrevendo aproximadamente. É importante lançar seu original no nível direito para as audiências assim que começarão o a maioria fora dele.
Que formato

Que estilo deve se usar ao escrever o original?

O estilo que você se usa quando escrevendo a documentação tem um efeito immense em como fácil a documentação deve compreender. É importante encontrar para fora se houver uma guia do estilo que você deva ser seguinte. Isto ajudará assegurar-se de que você use termos consistentemente através de uma organização. Além, é importante fazer seu original fácil de compreender. Isto pode ser feito usando a palavra com um meaning desobstruído e evitando a ambigüidade. Mantenha sua escrita concisa e evite o wordiness. Para o exemplo, em vez do due da escrita ao fato que usa o because.. Segmente a informação em tabelas e em listas onde apropriado. Fure a inglês liso e use somente os termos técnicos onde você tem que. A voz ativa do uso como esta fará sua escrita mais apertada e melhorará a legibilidade do original. Para o exemplo,

Passivo - uma recomendação foi feita por inspectors que a consideração deve ser dada pela companhia a instalar um sistema backup em todos os computadores para impedir os usuários que perdem seu trabalho.

Ativo - os inspectors recomendaram que a companhia considera instalar um sistema backup em todos os computadores para impedir os usuários que perdem seu trabalho.

Seed Newsvine


Planeando seu projeto técnico da escrita by vikram kuamr is licensed under a Creative Commons Atribuição-Uso Não-Comercial-Vedada a Criação de Obras Derivadas 2.5 Brasil License.