Notas:
• Os capítulos deste livro didático foram traduzidos usando a OpenAI e podem conter erros. Se você encontrar problemas com as traduções, envie correções para o autor em admin@mcmassociates.io.
• Se você encontrar tecnologia obsoleta ou imprecisa aqui, também é bem-vindo a enviar correções. No entanto, lembre-se de que este é um livro sobre escrita técnica, não um manual de tecnologia—tecnologias mais antigas ainda podem fornecer exemplos úteis.
• Doe para manter Livro Didático de Redação Técnica Online grátis.
• Enquanto você está aqui, envie um e-mail amigável para o David: admin@mcmassociates.io
Uma grande mudança ocorreu neste livro de escrita técnica online: agora ele usa documento técnico (techdoc para se referir 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.
Introdução: Escrita Técnica
- O que há de novo?
- Sobre redação técnica
- Sobre cursos de redação técnica
- Recursos
- Sobre o autor
- Agradecimentos
- Links para obras de referência
Aplicações da Redação Técnica
Nota: Este livro didático online agora utiliza documento técnico, ou apenas documentação técnica, em casos onde relatório é muito específico. (emblemas da ONU) indicam que as traduções estão disponíveis se você clicar no link.
- Pesquisa sobre techdocs
- Documentos comerciais e de emprego:
- Relatórios de dados
- Planos de negócios
- Propostas
- Relatórios de recomendação e viabilidade
- Documentos técnicos
- Relatórios de progresso
- Instruções
- Relatórios de antecedentes
- Relatório de design de engenharia
- Guias do usuário orientados por tecnologia
- Especificações e folhas de dados
- Notas de lançamento
- Casos de uso, estudos de caso
- Políticas e procedimentos operacionais padrão
- Relatórios de pesquisa primária. Para laboratório e campo.
- Revisões de literatura
- Guias e documentos de orientação
- Manuais
- Matéria frontal e matéria posterior:
Estruturas de Informação
Estruturas de informação são usadas como partes de documentos mais longos, mas podem ser utilizadas como documentos por si mesmas, especialmente para projetos de redação técnica. Essas estruturas de informação são um bom ponto de partida para pessoas em redação técnica de desenvolvimento.
Design de Documentos
- Visão geral do design do Techdoc
- Visão geral do design do livro
- Visão geral do design da página
- Títulos
- Listas
- Avisos especiais
- Não textuais: tabelas, figuras, gráficos
- Formato Techdoc e embalagem final
- Destaque e ênfase
- Indexação
Processos e Diretrizes na Redação Técnica
- Processo de escrita: do público ao rascunho.
- Análise de público
- Análise de tarefa
- Traduzindo informações técnicas
- Técnicas de revisão do poder
- Processamento de Informações
- Coleta de informações (NoodleTools ou Caderno LM)
- Citações, Paráfrases, Resumos: Formulação, Pontuação, Atribuição
- Padrões básicos e elementos da frase
- Problemas comuns de gramática, uso e pontuação
- Problemas comuns de ortografia
- Estratégias para revisão por pares e escrita em equipe
