Por favor, haga clic aquí para ayudar. David McMurrey pagar por alojamiento web:
¡Dona cualquier pequeña cantidad que puedas!
La redacción técnica en línea seguirá siendo gratuita.
Aquí hay dos definiciones de documentos guía:
- A guía es un documento, publicación o recurso digital que proporciona instrucciones paso a paso, consejos e información sobre cómo realizar tareas específicas, usar productos o comprender conceptos complejos. Una guía también puede contener información para la resolución de problemas, enlaces a comunidades relacionadas y enlaces a investigaciones relacionadas.
- En otros lugares, en el ámbito gubernamental, documentos guía, o orientación Los documentos están destinados a proporcionar información útil al público, como aclarar las obligaciones en virtud de una ley o regulación existente, o proporcionar información sobre los procedimientos de la agencia. En otras palabras, traducen el complejo lenguaje jurídico de las normas administrativas para permitir que el público cumpla con esas normas.
Documentos guía
Un documento guía, en su esencia, es un conjunto de instrucciones pero con otros recursos para hacerlo más ampliamente útil.
Revisando el capítulo sobre instrucciones, ves que las instrucciones están xxed por una sección que detalla el equipo y los suministros necesarios y por una sección que detalla los pasos del procedimiento, a menudo en formato de lista vertical numerada. Incluye una sección como esta en tu documento de guía—¡pero eso no es todo!
Fundamentos de la guía: Instrucciones
Los primeros seis elementos en la siguiente lista de encabezados parecen cualquier conjunto común de instrucciones—pero no el resto!
Elija la ubicación correcta
Elija el tamaño del jardín
Elija verduras
Determine dónde y cuándo plantar
Determinar cuándo plantar qué
Diseñar el plan del jardín
Adquirir herramientas de jardinería
Zonas de jardinería de hortalizas en Estados Unidos
Temperaturas estacionales promedio de Estados Unidos
Plagas comunes en el cultivo de hortalizas y su control
Recursos en línea para la jardinería de hortalizas
Foros y comunidades de cultivo de hortalizas
Adaptado con permiso de Cultivo de hortalizas para principiantes: La guía completa
Incluso la extensión y el detalle de los primeros seis elementos son mayores de lo que esperarías en un conjunto común de instrucciones de dos páginas, por no mencionar las bonitas imágenes decorativas.
Aquí hay otra lista de encabezados que presagian un documento mucho más extenso que un conjunto de instrucciones de una o dos páginas:
Selección del sitio para el jardín
Selección de recorte
Plan del jardín: Ubicación, Rotación
Preparación del suelo
Fertilización
Siembra
Riego
Control de malezas
Acolchado
Control de plagas
Cosecha
Qué hacer y qué no hacer en la jardinería
Adaptado con permiso de Guía para el cultivo de hortalizas en el hogar en Texas Joseph Masabn, Texas A&M AgriLife.
Suplementos de la guía: Extras
Lo que convierte a un conjunto de instrucciones en una guía son los suplementos discutidos en la sección.
Teoría, información conceptual
El software de creación y manipulación de imágenes tiene la seria responsabilidad de explicar las curvas de color, las máscaras de capa y los canales. El maravilloso software gratuito de imágenes GIMP tiene una buena explicación de los conceptos en Curvas de color básicas:
|
Colores de píxeles — por Pat David Recuerda, cada píxel está representado por una combinación de 3 colores: rojo, verde y azul. En GIMP (actualmente en 8 bits), eso significa que cada color RGB puede tener un valor de 0 a 255, y combinar estos tres colores con niveles variables en cada canal dará como resultado todos los colores que puedes ver en tu imagen. Si los tres canales tienen un valor de 255, entonces el color resultante será blanco puro. Si los tres canales tienen un valor de 0 –entonces el color resultante será negro puro. Si los tres canales tienen el mismo valor, entonces obtendrás un tono de gris (por ejemplo, 128,128,128 sería un gris medio). Aquí hay algunas configuraciones de color en GIMP: 
Como puedes ver, hay más azul que cualquier otra cosa (al fin y al cabo es un píxel azulado), seguido del verde y luego un toque de rojo. Si cambiáramos los valores de cada canal, pero mantuviéramos la misma proporción entre Rojo, Verde y Azul, entonces conservaríamos el mismo color y solo aclararíamos u oscureceríamos el píxel en cierta medida. |
Información de solución de problemas
La información para la resolución de problemas a menudo se presenta en un formato de "prueba esto, prueba aquello".
|
Problema: El botón de encendido no enciende la computadora ▢ Solución 1: Si su computadora no arranca, comience comprobando el cable de alimentación para confirmar que esté enchufado de forma segura en la parte trasera de la carcasa del equipo y en la toma de corriente. ▢ Solución 1: Si su ordenador no arranca, comience por comprobar el cable de alimentación para confirmar que está enchufado de forma segura en la parte trasera de la carcasa del ordenador y en la toma de corriente. ▢ Solución 2: Si está enchufado en una toma de corriente, asegúrese de que ésta funcione. Para comprobar la toma de corriente, puede enchufar otro aparato eléctrico, como una lámpara. ▢ Solución 3: Si la computadora está conectada a un protector contra sobretensiones, verifique que éste esté encendido. Puede que tenga que restablecer el protector contra sobretensiones apagándolo y volviéndolo a encender. También puede enchufar una lámpara u otro dispositivo en el protector contra sobretensiones para comprobar que funciona correctamente. ▢ Solución 4: Si está usando un portátil, la batería puede no estar cargada. Enchufe el adaptador de corriente a la toma de corriente y, a continuación, intente encender el portátil. Si aún no se enciende, es posible que deba esperar unos minutos e intentarlo de nuevo. |
Fuente: Adaptado con permiso de Fundamentos de la informática - Técnicas básicas de resolución de problemas
Comunidades y Foros
Recursos relacionados
Indicaciones de IA para documentos guía
Las listas de verificación, que normalmente no se leen, pueden usarse como fuente para indicaciones de IA con algunas modificaciones. Copie lo siguiente, péguelo en un sistema de IA como Gemini de Google y vea lo que pudo haber pasado por alto.
Nota: Todas las referencias al contenido, formato y estilo de techdocs o de sus componentes se pueden encontrar en el libro de texto en línea sobre redacción técnica.
¡Próximamente!
Documentos de orientación
Tal como se presenta aquí, los documentos de orientación traducen las normas administrativas en información comprensible para personas comunes que no son juristas.
- Una norma administrativa se caracteriza por un lenguaje fuertemente legalista y, a menudo, por un lenguaje de ingeniería. Aquí hay un extracto de ejemplo: SUBCAPÍTULO B: QUEMA AL AIRE LIBRE §§111.201, 111.203, 111.205, 111.207, 111.209, 111.211, 111.213, 111.215, 111.217, 111.219, 111.221. Comisión de Calidad Ambiental de Texas, vigente desde 2017.
- Un documento de orientación, por otro lado, intenta explicar en lenguaje accesible los puntos clave de la norma administrativa para permitir que el ciudadano común cumpla con la norma. Aquí hay un extracto de ejemplo: Quema al aire libre. Comisión de Calidad Ambiental de Texas, 2015.
Posibilidades del proyecto
Si eres un alma lo suficientemente valiente como para redactar un documento de orientación, intenta encontrar una norma administrativa que sea misericordiosamente breve—de menos de 10 páginas. Aquí tienes algunas posibilidades:
Considere seleccionar y escribir sobre uno de estos:
- Capítulo 361. Ley de Eliminación de Residuos Sólidos. Este aborda las normas de Texas sobre neumáticos usados o asbesto.
- Reciclaje de aceite usado. Comisión de Calidad Ambiental de Texas
- Gestión de neumáticos usados o desechados
- Capítulo 2201, Boxeo. ¡Este no trata sobre cartón!
- Capítulo 2100, Licencias, Registro y Operación (de barberías)
- Capítulo 5300, Terapia matrimonial y familiar
Diseño de documento de orientación
Algunas sugerencias para redactar un documento de orientación:
- Recuerde incluir la regla real como un apéndice. Algunos documentos de reglas pueden ser bastante largos. Puede simplemente copiar las secciones de las reglas a las que se dirige su orientación.
- Incluya tantos apéndices como sea práctico—en particular, los que sean de plantilla.
- Viste tu documento de orientación con un gráfico, encabezados y subencabezados, y otras características que lo hagan parecer un documento de orientación genuino.
Instrucciones de IA para documentos de orientación
Las listas de verificación, que normalmente no se leen, pueden usarse como fuente para indicaciones de IA con alguna modificación. Copia lo siguiente, pégalo en un sistema de IA como Gemini de Google y observa lo que podrías haber pasado por alto.
Nota: Todas las referencias al contenido, formato y estilo de techdocs o de sus componentes se pueden encontrar en el libro de texto en línea sobre redacción técnica.
¡Próximamente!
Información relacionada
Documentos de orientación. Departamento de Agricultura de los Estados Unidos
Portal de orientación del HHS. Departamento de Salud y Servicios Humanos de EE. UU.
Buscar en la TCEQ: Orientación
Agradecería sus opiniones, reacciones y críticas con respecto a este capítulo: tu respuesta—David McMurrey.
