Quais são os diferentes tipos de documentação técnica?


Melhor resposta

Existem tantos tipos diferentes de documentos técnicos que é quase impossível listar todos aqui.

Durante minha longa carreira como redator técnico, pessoalmente devo ter escrito mais de 15 tipos diferentes de documentos técnicos, variando de um projeto para outro.

No nível mais abstrato, os documentos técnicos podem ser categorizados em aqueles escritos para os usuários internos e usuários finais externos .

Por exemplo, um Guia de configuração do sistema é um exemplo de documento “interno”, enquanto um Guia de instalação é um exemplo de documento de “usuário final externo”.

Um Guia de API pode ser interno e usuários externos. Um Guia de início rápido , por outro lado, quase sempre é destinado a usuários finais externos.

Eu escrevi Guias do usuário , Guias de solução de problemas , Folhas de referência , Notas de versão , (editado) Documentos de requisitos de marketing (MRD), Documentos de arquitetura e engenharia (A&E Doc), Arquivos de ajuda , Manuais de procedimento de operação padrão (SOP) e muito mais.

Você é bem-vindo para visitar o Centro de comunicação técnica para obter mais informações gratuitas sobre todos esses diferentes tipos de documentos técnicos.

Resposta

Existem diferentes maneiras de categorizar os tipos de documentação técnica existentes. Não pretendo conhecer todos eles, mas as duas categorias principais que você pode usar para categorizar qualquer documentação técnica são o usuário e o caso de uso.

Por “o usuário”, quero dizer o que tipo de usuário vai usar o documento? É um guia do administrador, ou um tutorial, ou um guia do usuário? Esses níveis de conhecimento são levados em consideração ao projetar um documento. Um guia do administrador pressupõe que a pessoa que lê o documento sabe um pouco mais do que o leitor do tutorial.

Por “caso de uso”, quero dizer para que o documento é usado? Isso pode variar desde a documentação militar sobre como lançar um míssil até a documentação do desenvolvedor sobre como usar uma API gráfica para desenvolver um videogame.

Se você puder limitar sua pergunta, talvez eu consiga para lhe dar mais do que você procura.

Deixe uma resposta

O seu endereço de email não será publicado. Campos obrigatórios marcados com *