Por favor, clique aqui para ajudar David McMurrey pagar pela hospedagem de sites:
Doe qualquer quantia pequena que 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, têm a finalidade de fornecer informações úteis ao público, como esclarecer obrigações sob uma lei ou regulamento existente, ou fornecer informações sobre os procedimentos da agência. Em outras palavras, eles traduzem a complexa linguagem jurídica das normas administrativas para permitir que o público cumpra com essas normas.
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 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 como essa em seu documento de guia—mas isso não é tudo!
Fundamentos do Guia: Instruções
Os primeiro seis itens na seguinte lista de títulos parecem qualquer conjunto comum de instruções—mas não o restante!
Escolha o Local Certo
Escolha o Tamanho do Jardim
Escolha Vegetais
Determine Onde e Quando Plantar
Determine Quando Plantar O Que
Desenhe o Plano do Jardim
Adquirir Ferramentas de Jardinagem
Zonas de Jardinagem de Legumes dos EUA
Temperaturas Sazonais Médias nos EUA
Pragas Comuns em Jardins de Hortas e Controle
Recursos de Jardinagem de Verduras Online
Fóruns e Comunidades de Jardinagem de Vegetais
Adaptado com permissão de Jardinagem de Legumes para Iniciantes: O Guia Completo
Até mesmo o comprimento e o detalhe dos primeiros seis itens são maiores do que você esperaria em um conjunto comum de instruções de duas páginas, sem contar as bonitas imagens decorativas.
Aqui está outra lista de títulos que prenunciam um documento muito mais longo do que um conjunto de instruções de uma ou duas páginas:
Seleção de 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 de 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.
Guias de Suplementos: Extras
O que torna um conjunto de instruções um guia são os suplementos discutidos na seção.
Teoria, Informação Conceitual
O software de criação e manipulação de imagens tem uma séria responsabilidade ao 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 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 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 uma cor 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 (afinal, é um pixel azul), seguido de verde, e depois 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 geralmente são formatadas como uma estrutura de tente-isso, tente-aquilo.
|
Problema: O botão de energia não liga o computador ▢ Solução 1: Se o seu computador não ligar, comece verificando o cabo de alimentação para confirmar se está conectado firmemente na parte de trás 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 está conectado corretamente na parte traseira do gabinete do computador e na tomada. ▢ Solução 2: Se estiver plugado em uma tomada, verifique se é uma tomada funcionando. Para checar 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 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, em seguida, tente ligar o laptop. Se ainda assim não ligar, pode ser necessário esperar alguns minutos e tentar novamente. |
Fonte: Adaptado com permissão de Conceitos Básicos de Informática - 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 ser lidas, 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 na livro didático de escrita técnica online.
em breve!
Documentos de Orientação
Como apresentado aqui, documentos de orientação traduzem regras administrativas em informações legíveis por pessoas comuns, que não são da área jurídica.
- Uma norma administrativa é marcada por uma linguagem fortemente legalista e frequentemente por uma linguagem técnica. Aqui está um exemplo de trecho: SUBCAPÍTULO B: QUEIMA 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 exemplo de trecho: 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 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 Descarte 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 Sucateados
- Capítulo 2201, Boxe. Este aqui 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 de documento de orientação
Algumas sugestões para escrever 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 maior número possível de apêndices que seja prático—em particular, aqueles que são "padrão."
- Decore seu documento de orientação com um gráfico, cabeçalhos e subtítulos, e outros recursos que farão parecer um documento de orientação genuíno.
Sugestões 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 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!
Informação Relacionada
Documentos de Orientação. Departamento de Agricultura dos EUA
Portal de Orientação 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.
