Por favor, clique aqui para ajudar David McMurrey pagar pelo hospedagem de site:
Doe qualquer quantia que você puder!
A Escrita Técnica Online continuará gratuita.
Aqui estão duas definições de documentos guia:
- A guia é um documento, publicação ou recurso digital que fornece instruções passo a passo, dicas e informações sobre como realizar tarefas específicas, usar produtos ou entender conceitos complexos. Um guia também pode conter informações de solução de problemas, links para comunidades relacionadas e links para pesquisas relacionadas.
- Em outros lugares, no mundo governamental, documentos de orientação, ou orientação documentos, destinam-se a fornecer informações úteis ao público, como esclarecer obrigações sob uma lei ou regulamento existente, ou fornecer informações sobre procedimentos da agência. Em outras palavras, eles traduzem a complexa linguagem legal das regras administrativas para permitir que o público cumpra essas regras.
Documentos de Guia
Um documento guia, em sua essência, é um conjunto de instruções, mas com outros recursos para torná-lo mais amplamente útil.
Revisando o capítulo sobre instruções, você vê que as instruções são xxadas por uma seção detalhando o equipamento e os suprimentos necessários e por uma seção detalhando as etapas do procedimento, muitas vezes em um formato de lista vertical numerada. Inclua uma seção assim no seu documento de guia — mas não é só isso!
Fundamentos do Guia: Instruções
Os primeiros seis itens da lista a seguir de títulos se parecem com qualquer conjunto comum de instruções—mas não o restante!
Escolha a Localização Certa
Escolha o Tamanho do Jardim
Escolha Legumes
Determine Onde e Quando Plantar
Determinar Quando Plantar O Que
Desenhar o Plano do Jardim
Adquirir Ferramentas de Jardinagem
Zonas de Jardinagem de Vegetais nos EUA
Temperaturas Sazonais Médias nos EUA
Pragas Comuns na Jardinagem de Vegetais e Controle
Recursos Online para Jardinagem de Vegetais
Fóruns e Comunidades de Jardinagem de Vegetais
Adaptado com permissão de Jardinagem de Vegetais para Iniciantes: O Guia Completo
Mesmo o comprimento e o nível de detalhe dos seis primeiros itens é maior do que você esperaria em um conjunto comum de instruções de duas páginas, sem mencionar as belas imagens decorativas.
Aqui está outra lista de cabeçalhos que prenunciam um documento muito mais longo do que um conjunto de instruções de uma ou duas páginas:
Seleção do Local do Jardim
Seleção de Culturas
Plano do Jardim: Localização, Rotação
Preparação do Solo
Fertilização
Plantio
Regando
Controle de Ervas Daninhas
Cobertura do solo
Controle de Pragas
Colheita
O que fazer e o que não fazer na jardinagem
Adaptado com permissão de Guia de Jardinagem de Vegetais em Casa no Texas Joseph Masabn, Texas A&M AgriLife.
Guia de Suplementos: Extras
O que torna um conjunto de instruções um guia são os complementos discutidos na seção.
Teoria, Informação Conceitual
O software de criação e manipulação de imagens tem uma responsabilidade séria em explicar curvas de cor, máscaras de camada e canais. O maravilhoso software de imagem gratuito GIMP tem algumas boas explicações de conceitos em Curvas de Cores Básicas:
|
Cores de Pixel — por Pat David Lembre-se, cada pixel é representado por uma combinação de 3 cores: Vermelho, Verde e Azul. No GIMP (atualmente em 8 bits), isso significa que cada cor RGB pode ter um valor de 0 a 255, e combinar essas três cores com níveis variados em cada canal resultará em todas as cores que você pode ver na sua imagem. Se todos os três canais tiverem um valor de 255, então a cor resultante será branco puro. Se todos os três canais tiverem um valor de 0 – então a cor resultante será preto puro. Se todos os três canais tiverem o mesmo valor, você obterá um tom de cinza (128,128,128 seria um tom de cinza médio, por exemplo). Aqui estão algumas configurações de cor no GIMP: 
Como você pode ver, há mais azul do que qualquer outra coisa (é um pixel azul, afinal), seguido de verde, e depois um toque de vermelho. Se mudássemos os valores de cada canal, mas mantivéssemos a mesma proporção entre Vermelho, Verde e Azul, então manteríamos a mesma cor e apenas clarearíamos ou escureceríamos o pixel em uma certa medida. |
Informações de Solução de Problemas
As informações de solução de problemas costumam ser formatadas como uma estrutura de experimente-isso, experimente-aquilo.
|
Problema: O botão de ligar não inicia o computador ▢ Solução 1: Se o seu computador não ligar, comece verificando o cabo de alimentação para confirmar se está conectado corretamente na parte traseira do gabinete do computador e na tomada. ▢ Solução 1: Se o seu computador não ligar, comece verificando o cabo de alimentação para confirmar se está conectado de forma segura na parte traseira do gabinete do computador e na tomada. ▢ Solução 2: Se estiver conectado a uma tomada, verifique se é uma tomada funcional. Para testar sua tomada, você pode conectar outro aparelho elétrico, como uma lâmpada. ▢ Solução 3: Se o computador estiver conectado a um protetor contra surtos, verifique se ele está ligado. Você pode ter que redefinir o protetor contra surtos desligando-o e ligando-o novamente. Você também pode conectar uma lâmpada ou outro dispositivo ao protetor contra surtos para verificar se está funcionando corretamente. ▢ Solução 4: Se você estiver usando um laptop, a bateria pode não estar carregada. Conecte o adaptador CA na tomada e tente ligar o laptop. Se ele ainda não iniciar, pode ser necessário esperar alguns minutos e tentar novamente. |
Fonte: Adaptado por permissão de Fundamentos de Computador - Técnicas Básicas de Solução de Problemas
Comunidades e Fóruns
Recursos Relacionados
Prompts de IA para Documentos de Guia
Listas de verificação, que geralmente ficam sem leitura, podem ser usadas como fonte para prompts de IA com algumas modificações. Copie o seguinte, cole-o em um sistema de IA como o Gemini do Google e veja o que você pode ter perdido.
Nota: Todas as referências ao conteúdo, formato, estilo dos techdocs ou seus componentes podem ser encontradas no livro texto de escrita técnica online.
em breve!
Documentos de Orientação
Conforme apresentado aqui, documentos de orientação traduzem regras administrativas em informações compreensíveis para pessoas comuns que não são da área jurídica.
- Uma norma administrativa é marcada por uma linguagem fortemente jurídica e, muitas vezes, técnica. Aqui está um exemplo de trecho: SUBCAPÍTULO B: QUEIMADAS AO AR LIVRE §§111.201, 111.203, 111.205, 111.207, 111.209, 111.211, 111.213, 111.215, 111.217, 111.219, 111.221. Comissão do Texas de Qualidade Ambiental, Válido a partir de 2017.
- Um documento de orientação, por outro lado, tenta explicar em linguagem acessível os pontos-chave da norma administrativa para permitir que o cidadão comum cumpra a regra. Aqui está um trecho de exemplo: Queima ao Ar Livre. Comissão do Texas para a Qualidade Ambiental, 2015.
Possibilidades de projeto
Se você é uma alma corajosa o suficiente para escrever um documento de orientação, tente encontrar uma regra administrativa que seja mercifulmente breve—com menos de 10 páginas. Aqui estão algumas possibilidades:
Considere selecionar e escrever sobre um destes:
- Capítulo 361. Lei de Manejo de Resíduos Sólidos. Este aborda as regras do Texas sobre pneus usados ou amianto.
- Reciclagem de Óleo Usado. Comissão do Texas sobre Qualidade Ambiental
- Gestão de Pneus Usados ou de Sucata
- Capítulo 2201, Boxe. Este não é sobre papelão!
- Capítulo 2100, Licenciamento, Registro e Operação (de barbearias)
- Capítulo 5300, Terapia de Casamento e Família
Documento de orientação sobre design
Algumas sugestões para redigir um documento de orientação:
- Lembre-se de copiar a regra real como um apêndice. Alguns documentos de regras podem ser bastante longos. Você pode apenas copiar as seções das regras abordadas em sua orientação.
- Inclua o máximo possível dos apêndices que for prático—em particular, aqueles que são "padrão."
- Prepare seu documento de orientação com um gráfico, títulos e subtítulos, e outras características que o farão parecer um verdadeiro documento de orientação.
Prompts de IA para Documentos de Orientação
Checklists, que geralmente ficam sem leitura, podem ser usadas como fonte para prompts de IA com algumas modificações. Copie o seguinte, cole-o em um sistema de IA como o Gemini do Google e veja o que você pode ter perdido.
Obs: Todas as referências ao conteúdo, formato, estilo dos techdocs ou seus componentes podem ser encontradas no livro didático de redação técnica online.
em breve!
Informações Relacionadas
Documentos de Orientação. Departamento de Agricultura dos EUA
Portal de Orientações do HHS. Departamento de Saúde e Serviços Humanos dos EUA
Agradeceria suas opiniões, reações e críticas em relação a este capítulo: sua resposta—David McMurrey.
