Cinco dicas para escrever documentação Grande Técnica

A criação de documentação técnica é parte do que faz o trabalho no setor de TI. Manuais técnicos, instruções de especificações técnicas, guias, manuais de apoio de implementação - cada um são tipos de documentação técnica e são uma parte do trabalho. Um monte de funções técnicas na indústria de TI tomar parte no processo de documentação. Ela só poderia parecer simples para apenas colocar algumas palavras e diagramas em conjunto, uma tabela de conteúdos e pensar nele como um documento técnico, mas &'; s um pouco mais do que isso. I &'; ve listados abaixo cinco dicas sobre como escrever excelentes documentos técnicos

Table Use um bem-estruturado de Conteúdos

A tabela de conteúdo é entre a parte mais importante de um documento.. A tabela de conteúdo lista o que é, de facto, no documento e como ele é organizado. Ele é usado para ajudar os usuários a entender que o documento fornece as informações que eles estão procurando. Examinando a tabela de conteúdo, eles são capazes de ver facilmente se ele tem o que eles precisam, ou se eles precisam ler outro documento.

Um benefício adicional de ter uma tabela bem estruturado de conteúdos é que permite que o leitor para encontrar a informação que necessitam rapidamente. Microsoft Word, Adobe PDF e também outros aplicativos de documentos permitir links clicáveis ​​da tabela de conteúdos. Isso permite que você clique no item ou o número da página e ele irá levá-lo para essa página. . Muito útil para encontrar tópicos rápidos

Seja
sucinta, mas completa

Ser um autor do documento técnico, it &'; s difícil saber realmente o que quantidade e que tipo de informação para colocar a este documento. Para escrever um grande documento, tentar ser breve, mas completa. O que isto significa é não ir sobre e sobre e em todos os tipos de detalhes sobre determinadas áreas que não são necessários pelo leitor. Não é fácil dizer o que &'; s relevante eo que isn &'; t - mas fazer uma tentativa de considerar o público leitor e alvo quando você &'; re escrevendo o documento. Se você é demasiado “ prolixo &"; ou usar demasiada informação em que &'; s desnecessário, ele vai se transformar os leitores off e ganhou &';. t ser um documento eficaz

Seja consistente em todo o documento

A consistência é um grande caminho para melhorar um documento. Ele vai fazer com que pareça mais profissional, e, na realidade, mais legível para o usuário. Quando eu digo consistência, quero dizer regularidade tanto na linguagem que você usa ea formatação está aplicando. Alguns indivíduos won &'; t perceber isso. No entanto, se você &'; re compor um documento técnico, it &'; s mais do que provável para outros usuários técnicos, que são geralmente as pessoas com foco no detalhe. Garantir o seu documento usa a mesma formatação todo. Tente quebrar os dados e torná-lo compreensível para os usuários, fazendo uso de espaço em branco de forma eficaz.

Usando as mesmas expressões também é recomendado. Isso provavelmente vai garantir que o usuário sabe que você &'; re escrevendo sobre a mesma coisa, usando as mesmas palavras. Se você utilizar palavras como sinônimos, por exemplo, “ &" ;, de desktop “ &" ;, PC “ &" ;, computador que poderia confundir o usuário, quando você realmente quer dizer a mesma coisa. Que &'; sa exemplo rápido, mas a idéia é que você deve escolher aquele prazo e ficar com ele

Mantenha-
preciso e livre de erros

É quase desnecessário dizer que a documentação técnica realmente. deve ser livre de erros. Como afirmei acima, muito poucos leitores do documento estará outros usuários técnicos, e não &'; sa possibilidade muito boa os erros estarão para fora para eles. Além disso, se os erros don &'; t saltar, então dá-lhes a informação errada sobre o sistema ou área que você &';! Re documentação - o que frustra o objetivo do documento

Evite Grande Tela Captura

Fazendo uso de capturas de tela ou imagens dentro de sua documentação é definitivamente uma maneira eficaz de explicar o seu ponto para o leitor. It &'; s principalmente útil para processos de documentação de software ou de apoio, que são fáceis de tirar screenshots de. No entanto, os ecrãs de computador têm obtido maior ao longo dos anos, mas folhas A4 têm sido sempre o mesmo tamanho.

Isso deixa uma inclinação para incorporar grandes telas em um documento, o que torna as telas pequenas e ineficazes. Incluindo screenshots é uma ótima idéia - don &'; t me interpretem mal - mas fazer um esforço para incluir apenas as áreas que estão relacionadas com a seção que você &'; re explicar. Isso tende a levar a mais screenshots, no entanto eles vão ser mais eficaz e tornar o documento mais legível Restaurant  .;