Este livro online de redação técnica agora usa documento técnico (documentação técnica para abreviar) para referir-se a qualquer documento que contenha informações técnicas—em vez de usar relatório. O relatório é uma subcategoria juntamente com os outros tipos de documentos técnicos discutidos neste livro.
Nota: Este livro didático de redação técnica concentra-se em habilidades de redação técnica. O conteúdo técnico aqui não é garantido como preciso ou atualizado.
Relatórios contextuais/informativos
Esse tipo é o mais difícil de definir, mas é o que a maioria das pessoas escreve. Ele foca em um tópico técnico, fornece contexto sobre esse tópico para um conjunto específico de leitores que têm necessidades específicas em relação a ele. Este relatório não fornece instruções, nem fornece recomendações de maneira sistemática, nem relata dados novos e originais.
Para um capítulo completo sobre este tipo de documentação técnica, consulte relatórios de contexto/informativos
Planos de negócios
Um plano de negócios é um documento usado para iniciar um novo negócio ou obter financiamento para um negócio que está mudando de alguma forma significativa. Planos de negócios são documentos importantes para sócios comerciais que precisam concordar com seus planos, autoridades governamentais que precisam aprovar esse plano, e, claro, potenciais investidores tais como bancos ou indivíduos privados que podem financiar o negócio.
Veja o capítulo completo sobre este tipo de documento técnico.
Guias de usuário orientados para tecnologia
Brevemente definido, um guia do usuário de computador fornece informações técnicas sobre como usar hardware ou software de computador, incluindo instruções sobre tarefas como instalação, configuração e tarefas essenciais.
Veja o capítulo completo sobre este tipo de documento técnico.
Relatórios de dados
Um relatório de dados é um documento técnico contendo muitos dados na forma de tabelas. Também pode conter gráficos e diagramas que representam de forma mais vívida os dados nessas tabelas e referências cruzadas explicativas que indicam as principais tendências e conclusões nos dados tabulares.
Veja o capítulo completo sobre este tipo de documentação técnica.
Relatórios de projeto de engenharia
Um relatório de projeto de engenharia apresenta e documenta um projeto de engenharia para que outros possam entender como o projeto pode ser aplicado e comercializado. Estudantes de engenharia, por exemplo, escreveram sobre o projeto de um sistema de medição e exibição de temperatura usando um microcontrolador.
Veja o capítulo completo sobre este tipo de documentação técnica.
Guias e documentos de orientação
De forma sucinta, um guia é uma publicação que fornece instruções passo-a-passo, dicas, conceitos relacionados. Também pode conter informações para solução de problemas, links para comunidades relacionadas, e links para pesquisas relacionadas.
Um documento de orientação É um documento governamental destinado a fornecer informações úteis ao público, como esclarecer as obrigações previstas em uma lei ou regulamento existente. Procura traduzir a linguagem jurídica complexa das normas administrativas para permitir que o público cumpra essas regras.
Veja o capítulo completo sobre esses tipos de documentação técnica.
Manuais
Definido brevemente, um manual é uma fonte ??? contendo informação conceitual (teorias básicas, princípios, fundamentos), informação instrucional (instruções passo a passo) e informação de referência (informação para consulta rápida).
Veja o capítulo completo neste tipo de documentação técnica.
Instruções
Brevemente definidas, instruções dizem como construir coisas, operar coisas, consertar coisas—o clássico "como-fazer." Para estudantes de redação técnica, prefira "Guias de usuário orientados à tecnologia."
Veja o capítulo completo sobre este tipo de documento técnico.
Revisões de literatura
Definida brevemente, uma revisão da literatura resume o que se sabe sobre um tema de pesquisa específico, narra os marcos da história da pesquisa, indica onde o conhecimento atual é contraditório e discute áreas em que ainda há lacunas no conhecimento.
Veja o capítulo completo neste tipo de documento técnico.
Relatórios de pesquisa primária (relatórios de laboratório)
Definido brevemente, um relatório de pesquisa primária apresenta resultados e interpretação de pesquisas de laboratório ou de campo. Você pode pensar nele como um relatório de laboratório, mas é muito mais do que isso.
Veja o capítulo completo sobre este tipo de documento técnico.
Relatórios de progresso
Definido brevemente, um relatório de progresso informa um supervisor, colega, ou cliente sobre o andamento de um projeto ao longo de um determinado período de tempo. O projeto pode ser o desenho, a construção, ou o reparo de algo, o estudo ou a pesquisa de um problema ou questão, ou a coleta de informações sobre um assunto técnico.
Veja o capítulo completo sobre este tipo de documento técnico.
Propostas
Brevemente definida, uma proposta é uma oferta ou um lance para realizar um determinado projeto para alguém. O que faz de uma proposta uma proposta é que ela pede ao público que aprove, financie ou conceda permissão para realizar o projeto proposto.
Veja o Por favor, cole aqui o capítulo em inglês que você quer que eu traduza. Se for muito longo, envie em partes. sobre este tipo de documentação técnica.
Recomendação, viabilidade, relatórios de avaliação
Este grupo de relatórios semelhantes faz coisas como comparar várias opções com um conjunto de requisitos e recomendar uma; considera uma ideia (plano, projeto) em termos de sua "feasibility," por exemplo, alguma combinação de sua praticidade ou possibilidade técnica, econômica, social; julga o mérito ou o valor de algo comparando-o a um conjunto de requisitos (critérios).
Veja o capítulo completo sobre esses tipos de documentação técnica.
Políticas e procedimentos operacionais padrão
Estes são os documentos operacionais para organizações; eles contêm regras e regulamentos sobre como se espera que a organização e seus membros atuem. Políticas e procedimentos são como instruções, mas vão muito além. Procedimentos operacionais padrão (SOPs) são mais voltados para procedimentos nos quais um processo é executado—por exemplo, tomar uma impressão dentária.
Veja o capítulo completo sobre esses tipos de documentação técnica.
Publicação de livro técnico
Em breve...
Veja o capítulo completo sobre este tipo de documentação técnica.
Guias do usuário orientados para tecnologia
De forma breve, um guia do usuário de computador fornece informações técnicas sobre como usar hardware ou software de computador, incluindo instruções para tarefas como instalação, configuração e tarefas essenciais.
Veja o capítulo completo sobre este tipo de documento técnico.
Livros brancos
Definido brevemente, um livro branco é um documento tecnológico ou empresarial que fornece contexto sobre um projeto (dispositivo, método, etc.) e o defende. Os livros brancos tornaram-se ferramentas de marketing populares para as corporações, especialmente na Internet, já que muitos clientes em potencial pesquisam informações na Web. As corporações usam livros brancos para vender informações ou novos produtos como soluções que atenderiam às necessidades de seus clientes.
Veja o capítulo completo sobre este tipo de documentação técnica.
Informações relacionadas
Tipos de documentos e como usá-los. O que fazer
