comunicação técnica ou documentação é o processo de transporte "amigo do usuário" informações através de escrever sobre um tópico em particular a um público-alvo. documentação técnica varia de um e-mail de negócios para relatórios de negócios a um guia do usuário ou a ajuda do sistema. Muitos só se voltam para documentação &# X201C-quando tudo mais falhar.&# X201D- Nenhuma documentação maravilha é muitas vezes de má qualidade no melhor inexistente na pior. Empresas de informática pode sentir que o seu software é tão fácil, eles não&# X2019-t precisam de documentação. Mas a documentação técnica é menos caro do que as chamadas de suporte técnico. Antes de poder desenvolver uma boa documentação técnica, você precisa saber que a documentação técnica eficaz é uma missão bem planejado e executado.
Coisas que você precisa
- Computador
- ferramenta de criação
- especialista no assunto
instruções
Determinar propósito e audiência. Você precisa saber por que você está criando esta documentação e que será lê-lo. O tipo de documentação que você criar será diferente se o seu público é um mecânico de automóveis que se sua audiência é um engenheiro de software.
Juntar informação. A pessoa que cria a documentação é muitas vezes um escritor e não o especialista no assunto. É importante para reunir as informações para que você possa documentá-lo. A recolha de informação pode significar fazer a pesquisa, entrevistando um especialista no assunto, ou experimentar o produto em si, como no caso de um programa de software.
Organizar e delinear informações. Você pode começar com um documento existente ou um modelo. isto&# X2019-s importante inserir as informações que você tem e deixar as áreas em branco onde você precisa coletar mais informações. Este será o seu documento de trabalho, e você vai construir sobre ela. Anotar o que você tem, mesmo se você tem grandes áreas de espaço vazio vai aumentar sua confiança de que você está avançando no projeto.
Escrever o primeiro rascunho. Isto é, quando você começar a preencher os espaços em branco e permitindo um fluxo de ideias para transmitir a partir de sua consciência. Não pare de que o fluxo através da revisão nesta fase.
Rever e editar. Você pode querer colocar o documento afastado por um período de tempo para que você possa dar-lhe um olhar fresco. Em seguida, concentrar-se em temas que precisam de mais atenção- encurtar, expandir ou eliminar seções- ou reorganizar parágrafos, frases ou temas inteiros. Você também vai querer editar para o estilo, gramática e contexto.
dicas & avisos
- Uma lista de verificação edição é útil para que você pode editar para diferentes pontos durante passagens separadas.
- Desenvolver boas habilidades jogador da equipe e uma compreensão de como cada especialista no assunto prefere trabalhar para manter este relacionamento se torne contraditório.
Iso 9000 códigos de documentos: como rotular seus documentos
Como construir um programa de cad
Como desenhar um erp
Como preencher um documento de contrato aia
Como escrever uma proposta tópico de exemplo
Como obter uma transferência de segurança da escola