Por favor, clique aqui para ajudar David McMurrey pagar pelo hospedagem na web:
Doe qualquer quantia pequena que você puder!
A Escrita Técnica Online continuará gratuita.
Aqui estão duas definições de documentos guia:
- Um 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 orientadores, ou orientação Os documentos têm a intenção de 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 linguagem legal complexa das regras administrativas para permitir que o público cumpra essas regras.
Documentos de Guia
Um documento de 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 os equipamentos e suprimentos necessários e por uma seção detalhando os passos procedimentais, muitas vezes em formato de lista vertical numerada. Inclua uma seção assim no seu documento de guia—mas isso não é tudo!
Fundamentos do Guia: Instruções
Os primeiros seis itens da lista a seguir de cabeçalhos parecem qualquer conjunto comum de instruções—mas não o resto!
Escolha o Local Certo
Escolha o Tamanho do Jardim
Escolha Legumes
Determine Onde e Quando Plantar
Determine Quando Plantar O Quê
Desenhe o Plano do Jardim
Adquirir Ferramentas de Jardinagem
Zonas de Jardinagem de Vegetais dos EUA
Temperaturas Sazonais Médias nos EUA
Pragas Comuns na Horta 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
Até mesmo o comprimento e o detalhamento dos primeiros seis itens é maior do que você esperaria em um conjunto comum de instruções de duas páginas, sem mencionar as imagens decorativas bem bonitas.
Aqui está outra lista de cabeçalhos que prevê um documento muito mais longo do que um ou dois páginas de instruções:
Seleção do Local para o Jardim
Seleção de Culturas
Plano do Jardim: Localização, Rotação
Preparação do Solo
Fertilização
Plantio
Rega
Controle de Ervas Daninhas
Cobertura morta
Controle de Pragas
Colheita
O que Fazer e o que Não Fazer na Jardinagem
Adaptado com permissão de Guia para Jardinagem de Vegetais em Casa no Texas Joseph Masabn, Texas A&M AgriLife.
Suplementos do Guia: 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 séria responsabilidade de explicar curvas de cor, máscaras de camada e canais. O maravilhoso software de imagem gratuito GIMP tem algumas boas explicações dos conceitos em Curvas de Cor 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 diferentes níveis 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 uma cor cinza intermediário, 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 por verde, e então uma pitada 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 alguma medida. |
Informações de Solução de Problemas
As informações de solução de problemas são frequentemente formatadas como uma estrutura de tente-isto, tente-aquilo.
|
Problema: O botão de energia não liga o computador. ▢ Solução 1: Se o seu computador não iniciar, 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 1: Se o seu computador não ligar, comece verificando o cabo de energia para confirmar se ele está conectado de forma segura na parte de trás do gabinete do computador e na tomada. ▢ Solução 2: Se estiver Plugado em uma tomada, certifique-se de que é uma tomada funcionando. Para verificar sua tomada, você pode conectar outro dispositivo 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 precisar reiniciar o protetor contra surtos desligando-o e ligando-o novamente. Você também pode conectar uma lâmpada ou outro dispositivo ao protetor para verificar se ele 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, então tente ligar o laptop. Se ele ainda não ligar, você pode precisar esperar alguns minutos e tentar novamente. |
Fonte: Adaptado com permissão de Fundamentos de Computador - Técnicas Básicas de Resolução de Problemas
Comunidades e Fóruns
Recursos Relacionados
Prompts de IA para Documentos Guias
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 em livro didático de escrita técnica online.
em breve!
Documentos de Orientação
Conforme apresentado aqui, os documentos de orientação traduzem regras administrativas em informações legíveis por pessoas comuns não jurídicas.
- Uma regra administrativa é marcada por uma linguagem fortemente legalista e, muitas vezes, por uma linguagem de engenharia. 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, Vigente desde 2017.
- Um documento de orientação, por outro lado, tenta explicar em uma linguagem acessível os pontos principais da norma administrativa para permitir que o cidadão comum cumpra a regra. Aqui está um exemplo de trecho: Queima ao Ar Livre. Comissão do Texas sobre Qualidade Ambiental, 2015.
Possibilidades de projeto
Se você é uma alma corajosa o suficiente para escrever um documento de orientação, tente encontrar uma norma administrativa que seja misericordiosamente breve—com menos de 10 páginas. Aqui estão algumas possibilidades:
Considere selecionar e escrever sobre um destes:
- Capítulo 361. Lei de Disposição 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
Design do documento de orientação
Algumas sugestões para escrever um documento de diretrizes:
- Lembre-se de incluir 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 maior número possível de apêndices que seja prático, em particular, aqueles que são "padrão".
- Enriqueça 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 normalmente ficam sem leitura, podem ser usadas como fonte para prompts de IA com algumas modificações. Copie o seguinte, cole 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 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
Eu apreciaria seus pensamentos, reações e críticas em relação a este capítulo: sua resposta—David McMurrey.
