Obtendo seus braços em torno de um documento técnico

O propósito de escrever um documento técnico é explicar ou informar sobre um assunto técnico ou complexo. Portanto, a menos que você é o guru técnico de escrever sobre algo que você sabe intimamente, você deve pesquisar o assunto. Coleta de dados - aprender tudo o que puder sobre o produto ou serviço - é a alma do projeto.

pesquisa interna

Se sua pesquisa é interno, reunir suas informações através de entrevistas com as PME (especialistas no assunto) e outras pessoas envolvidas no projeto, observando as pessoas e em torno do local de trabalho, lendo folhas de especificações e literatura da companhia, e apenas bisbilhotando. Aqui estão algumas dicas para manter seu nariz à mó sem ficar cortado:

• Conheça o produto ou serviço intimamente.

• Teste-o. Use-o. Abraçá-lo. Saiba tudo o que puder.

• especificações do sistema Estudo e desenhos de engenharia.

• Entrevista do SME. Traga uma lista de perguntas que você preparou.

• Absorve a grande figura.

• Informe-se sobre a finalidade do produto ou serviço, que vai usá-lo, por que e quando.

• Saiba as siglas.

• Familiarize-se com as boas e más características do produto ou serviço.

• Aprenda sobre quaisquer possíveis falhas com o produto, como o que recursos podem quebrar, mau funcionamento ou causar problemas.

• Cozy até os departamentos de marketing e vendas.

• Conheça as vantagens e desvantagens do produto ou serviço.

• Compreender as características e benefícios que você precisa para destacar.

• Saber como o manual será distribuído e atualizado.

• Descubra se existem publicações ou manuais relacionados.

• Descubra se você precisa para preparar instruções desembalar ou um listas de peças.

• Pergunte o que está na caixa de transporte.

• Pergunte se o usuário precisa instruções para instalar ou montar o item.

• Coletar dados, tanto escritos ou gráficos que puder. Você sempre pode descartar o que você não precisa.

• Decidir que fotos ou gráficos que você precisa.

• Obter cópias de um manual de estilo ou de texto padrão que projetos semelhantes utilizados.

É importante que você não apenas confiar em sua memória. Tome notas copiosas ao fazer sua pesquisa.

pesquisa externa

Você faz pesquisa externa através de entrevistas com pessoas fora da sua organização, visitar a biblioteca, ou a navegar na Web. Aqui estão alguns conselhos para tornar seu trabalho mais fácil:

• Entrevistar pessoas fora da empresa. Você pode visitar as pessoas pessoalmente ou enviar um questionário. Que fazer, é claro, depende da natureza de sua pesquisa. Se você precisa de recolher informações de um monte de gente, você pode encontrar um questionário é apropriado. Se você precisa de encontrar cara a cara com uma ou mais pessoas, siga estas orientações:

• Prepare uma lista de objetivos e perguntas de antemão.

• Deixe o entrevistado fazer mais do que falar. Afinal, você está lá para aprender.

• Agarre toda a literatura que o entrevistado está disposto a compartilhar.

• Tome notas copiosas ou usar um gravador, se for o caso.

• Faça uma pesquisa na biblioteca. Há uma variedade de maneiras de usar a biblioteca para pesquisa. Se você precisar de ajuda para usar qualquer um dos seguintes serviços de biblioteca, pedir ao bibliotecário:

• Catálogo de cartão: catálogos de cartão são organizados em ordem alfabética por autor, título e assunto para refletir todos os livros e recursos da biblioteca possui.

• Bibliografia periódicos e os índices: Bibliografias listar periódicos, livros e outras pesquisas publicadas em uma ampla variedade de áreas. índices periódicos lista de revistas, jornais e artigos de jornal. Bibliotecas, por vezes, bibliografias casa e periódicos em uma sala separada. índices mais recentes podem estar na prateleira, enquanto índices mais velhos podem estar em outra parte da biblioteca ou no microform.

• Obras de referência: Estes incluem enciclopédias, dicionários, manuais, manuais, fontes estatísticas, atlas e muito mais.

• Navegar na internet. Se você não sabe o URL do site que você deseja, acessar um dos motores de busca populares. A seguir estão alguns destaques:

• Digite uma palavra-chave ou frase. O motor de busca procura por documentos que tenham a palavra-chave (s). Em seguida, ele classifica os sites com base em quantas vezes a palavra-chave aparece no documento, se a palavra-chave aparece no título, como cedo a palavra-chave aparece no texto, e assim por diante.

• Tente fazer sua pesquisa tão estreita quanto possível. Caso contrário, você pode ter milhares de acessos. Por exemplo, se você procurar cão, você tem sites para mais cães do que você quer latindo para você. Se você procurar poodle, você recebe todos os tipos de poodles. Se você procurar poodle toy, você restringir a pesquisa a apenas a variedade de brinquedos.