Por favor, haz clic aquí para ayudar. David McMurrey pagar por alojamiento web:
¡Dona cualquier cantidad pequeña que puedas!
La escritura 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 entender conceptos complejos. Una guía también puede contener información de solución de problemas, enlaces a comunidades relacionadas y enlaces a investigaciones relacionadas.
- En otros lugares, en el mundo gubernamental, documentos guía, o guía los documentos están destinados a proporcionar información útil al público, como aclarar las obligaciones bajo una ley o regulación existente, o proporcionar información sobre los procedimientos de la agencia. En otras palabras, traducen el complejo lenguaje legal de las normas administrativas para permitir que el público cumpla con esas normas.
Documentos de Guía
Un documento guía, en su esencia, es un conjunto de instrucciones pero con otros recursos para hacerlo más útil en general.
Revisando el capítulo sobre instrucciones, verás que las instrucciones están xxadas 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!
Guía de Fundamentos: Instrucciones
Los primeros seis elementos de la siguiente lista de encabezados parecen un conjunto común de instrucciones— ¡pero no el resto!
Elige la ubicación correcta.
Elige el Tamaño del Jardín
Elige verduras
Determinar Dónde y Cuándo Plantar
Determina Cuándo Plantar Qué
Diseña el Plan del Jardín
Adquirir Herramientas de Jardinería
Zonas de Jardinería de Verduras en los EE. UU.
Temperaturas Estacionales Promedio en EE. UU.
Plagas Comunes en el Jardín de Hortalizas y Control
Recursos en Línea para la Jardinería de Verduras
Foros y Comunidades de Jardinería Vegetal
Adaptado con permiso de Jardinería de Verduras para Principiantes: La Guía Completa
Incluso la longitud y el detalle de los primeros seis elementos son mayores de lo que esperarías en un común conjunto de instrucciones de dos páginas, sin mencionar las bonitas imágenes decorativas.
Aquí hay otra lista de encabezados que presagian un documento mucho más largo que un conjunto de instrucciones de una o dos páginas:
Selección del Sitio para el Jardín
Selección de Cultivos
Plan de Jardín: Ubicación, Rotación
Preparación del Suelo
Fertilización
Plantación
Riego
Control de Malezas
Mulching
Control de Plagas
Cosecha
Lo que se debe y no se debe hacer en jardinería
Adaptado con permiso de Guía de Jardinería de Hortalizas en Casa de Texas Joseph Masabn, Texas A&M AgriLife.
Suplementos de Guía: Extras
Lo que convierte 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 una seria responsabilidad de explicar las curvas de color, las máscaras de capa y los canales. El maravilloso software de imágenes gratuito 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 diferentes niveles en cada canal resultará en 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 (128,128,128 sería un color gris medio, por ejemplo). Aquí hay algunas configuraciones de color en GIMP: 
Como puedes ver, hay más azul que cualquier otra cosa (después de todo, es un píxel azuloso), seguido de verde, luego un poco 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 de solución de problemas a menudo está estructurada como un marco de intenta esto, intenta aquello.
|
Problema: El botón de encendido no inicia la computadora. ▢ Solución 1: Si tu computadora no enciende, comienza revisando el cable de alimentación para confirmar que esté conectado de manera segura en la parte posterior de la carcasa de la computadora y en la toma de corriente. ▢ Solución 1: Si tu computadora no enciende, comienza revisando el cable de alimentación para confirmar que esté bien conectado en la parte trasera de la carcasa de la computadora y en la toma de corriente. ▢ Solución 2: Si está enchufado a una toma de corriente, asegúrate de que sea una toma de corriente que funcione. Para comprobar tu toma de corriente, puedes enchufar otro dispositivo eléctrico, como una lámpara. ▢ Solución 3: Si la computadora está conectada a un protector contra sobretensiones, verifica que esté encendido. Puede que tengas que reiniciar el protector apagándolo y luego encendiéndolo de nuevo. También puedes enchufar una lámpara u otro dispositivo en el protector para verificar que esté funcionando correctamente. ▢ Solución 4: Si estás usando una laptop, la batería puede no estar cargada. Conecta el adaptador de CA a la pared, luego intenta encender la laptop. Si todavía no se enciende, es posible que debas esperar unos minutos y volver a intentarlo. |
Fuente: Adaptado con permiso de Conceptos básicos de computación - Técnicas básicas de solución de problemas
Comunidades y Foros
Recursos Relacionados
Prompts de IA para Documentos de Guía
Las listas de verificación, que normalmente no se leen, pueden usarse como fuente para indicar a la IA con algunas modificaciones. Copia lo siguiente, pégalo en un sistema de IA como Gemini de Google y verifica qué es lo que puede que te hayas perdido.
Nota: Todas las referencias al contenido, formato, estilo de los techdocs o sus componentes se pueden encontrar en el libro de texto de redacción técnica en línea.
¡próximamente!
Documentos de Orientación
Como se presenta aquí, los documentos de orientación traducen las normas administrativas en información legible por personas comunes no legales.
- Una regla administrativa se caracteriza por un lenguaje legalista y a menudo por un lenguaje técnico. Aquí hay un ejemplo de un extracto: SUBCAPÍTULO B: QUEMADO 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, Efectivo 2017.
- Un documento de orientación, por otro lado, intenta explicar en un lenguaje accesible los puntos clave de la norma administrativa para permitir que el ciudadano común cumpla con la norma. Aquí hay un ejemplo de extracto: Quema al aire libre. Comisión de Calidad Ambiental de Texas, 2015.
Posibilidades de proyecto
Si eres un alma lo suficientemente valiente como para escribir un documento de orientación, intenta encontrar una regla administrativa que sea misericordiosamente breve—de menos de 10 páginas. Aquí hay algunas posibilidades:
Considera seleccionar y escribir sobre uno de estos:
- Capítulo 361. Ley de Disposición de Desechos Sólidos. Este se refiere a las normas de llantas usadas o asbesto de Texas.
- Reciclaje de Aceite Usado. Comisión de Calidad Ambiental de Texas
- Gestión de Neumáticos Usados o de Chatarra
- Capítulo 2201, Boxeo. ¡Este no es sobre cartón!
- Capítulo 2100, Licencias, Registro y Operación (de barberías)
- Capítulo 5300, Terapia Matrimonial y Familiar
Diseño del documento de orientación
Algunas sugerencias para redactar un documento de orientación:
- Recuerda copiar la regla real como un apéndice. Algunos documentos de reglas pueden ser bastante largos. Simplemente puedes copiar las secciones de las reglas mencionadas en tu guía.
- Incluya tantos de los apéndices como sea práctico—en particular, los que son "estándar."
- Viste tu documento de orientación con un gráfico, encabezados y subtítulos, y otras características que lo harán parecer un documento de orientación genuino.
Prompts de IA para Documentos de Orientación
Las listas de verificación, que generalmente quedan sin leer, pueden usarse como fuente para indicaciones de IA con algunas modificaciones. Copia lo siguiente, pégalo en un sistema de IA como Gemini de Google y ve qué puede que hayas pasado por alto.
Nota: Todas las referencias al contenido, formato, estilo de techdocs o sus componentes se pueden encontrar en el manual técnico de escritura en línea.
¡próximamente!
Información Relacionada
Documentos de Orientación. Departamento de Agricultura de los EE. UU.
Portal de Orientación de HHS. Departamento de Salud y Servicios Humanos de EE. UU.
Buscar en la TCEQ: Orientación
Agradecería tus pensamientos, reacciones, críticas sobre este capítulo: tu respuesta—David McMurrey.
