Cuando estás redactando un documento, ¿por dónde empiezas? ¿Qué formato o estilo utilizas para presentar y comunicar tu información en un documento? Estas preguntas y otras pueden ser respondidas a través de una Guía de Estilo. Una Guía de Estilo contiene un conjunto de reglas que un escritor utiliza para mantener la consistencia en la gramática, el formato y el contenido de un documento. Existen varios diseños de Guías de Estilo. Por lo general, hay una guía genérica que proporciona un resumen de los estilos y formatos que se deben utilizar para tipos específicos de manuales, y luego hay una guía más específica con mayor detalle, por ejemplo, para escritores médicos y científicos al presentar documentación regulatoria o investigaciones, desarrolladores al enviar solicitudes de cambios en bases de datos y documentar código, ingenieros que requieren Especificaciones Funcionales y Especificaciones Técnicas, probadores que requieren especificaciones de control de calidad, usuarios que requieren guías de usuario y hojas de referencia que documentan procesos y definiciones, personal de recursos humanos al redactar instrucciones o material educativo, o fabricantes al crear especificaciones de diseño, etc. Estos son solo algunos ejemplos.
Seguir un conjunto de pautas escritas garantiza que el documento sea consistente, uniforme y permite que el escritor se centre en la redacción del material. Puedes llamarlo un plan o una plantilla a seguir. Ayudará al escritor a diseñar el producto final y también facilitará la lectura, ya que los lectores sabrán de antemano dónde se encuentra cierta información dentro del documento debido al estilo consistente. La Guía de Estilo también:
- Detalla la gramática y la terminología de la industria.
- Indica cómo se mostraría cierto texto dentro de, por ejemplo, especificaciones o descripciones médicas, o definiciones de bases de datos.
- Indica cómo mostrar números o cómo presentar abreviaturas, es decir, ¿deben presentarse con mayúsculas iniciales o algunas con mayúsculas iniciales y otras en minúsculas?
- Explica cómo dar formato a otros objetos, como casillas de verificación, viñetas o listas desplegables.
- Muestra dónde se definen los objetos. ¿Deben, por ejemplo, las definiciones colocarse al final del documento, antes del glosario o dentro del apéndice?
- ¿Cómo se deben formatear y organizar las tablas? ¿Se debe aplicar un color de fondo a la tabla o solo el encabezado debe tener un color de fondo?
- Indica qué tipo de tipo de letra, fuente y tamaño se debe utilizar. ¿Se aplicará un estilo de periódico o de columna y el texto siempre estará justificado a la izquierda?
- Indica el tipo de gráficos incrustados; ¿solo se permiten archivos jpeg o se permiten otros tipos de archivos gráficos?
- Hay muchos otros elementos o secciones que también deben describirse, como la tabla de contenidos, el apéndice, los encabezados y pies de página y los saltos de párrafo.
La mayoría de las Guías de Estilo contienen referencias a material de muestra, convenciones estándar, un glosario, etc. Así que supongo que la respuesta a la pregunta “¿Necesitamos una Guía de Estilo?” es “Sí”. Nota: Como recordatorio, al igual que con todos los documentos, incluye una sección para el ciclo de revisión y las hojas de aprobación. Esto garantizará que todos aprueben la Guía de Estilo en particular. Consulta algunos consejos en el próximo artículo.
