Formato de texto en redacción técnica (redacción de procedimientos)

En un procedimiento, al describir un componente de la interfaz de usuario, usamos la fuente en negrita para representar los componentes de la interfaz de usuario. También hacemos coincidir el texto con las mayúsculas y minúsculas del componente de la interfaz de usuario. Pero, ¿también necesitamos hacer coincidir el estilo de fuente? Por ejemplo, si el componente de la interfaz de usuario está en cursiva, ¿debemos escribir el texto en cursiva?

Solo para asegurarse, está usando "UI" para indicar "Interfaz de usuario", ¿sí?
No es estándar tener fuentes en cursiva en los controles en la mayoría de las GUI. ¿Es esto algo más que software o una interfaz de máquina?

Respuestas (3)

Todo esto tiene que ver con el reconocimiento. El usuario puede reconocer el componente que se menciona por su nombre (verbal) o por la vista (visual). El reconocimiento por nombre es suficiente en la mayoría de los casos.

Si busca el reconocimiento por nombre, la razón por la cual el texto en negrita en el manual es para desplazar el nombre del resto del texto para que el lector pueda elegir fácilmente el nombre. No se trata de hacer que el texto se vea como el texto en la interfaz, porque confía en el reconocimiento por nombre, no por apariencia.

Por otro lado, si busca el reconocimiento visual, entonces está creando una imagen del control en la documentación y esa imagen debe ser una coincidencia exacta para el control o la coincidencia visual no funcionará. Esto significa que querrá hacer coincidir todo: fuente, color, estilo, etc. A menudo, la mejor manera de hacerlo es con un gráfico o una fotografía del control en lugar de manipular la fuente.

Sin embargo, no tiene sentido hacer nada entre estos dos. Si la coincidencia visual no está completa, la coincidencia visual del lector se confundirá o recurrirá a la coincidencia verbal, en cuyo caso la elección de la fuente, etc., es irrelevante.

Gracias. El "compensar el nombre del resto del texto" tenía mucho sentido.
En algunos casos, he visto (y usado) un estilo específico para todos los elementos de la interfaz donde no solo la negrita actúa como una señal visual, sino también el color; usado juiciosamente, puede ser poderoso. Si lo hace, mantendría una paleta muy limitada, tanto para el control estético del diseño como para mantener la señal visual singular y fácilmente analizable.

Estas son cuestiones de estilo y, sobre todo, una cuestión de opinión; pero si la coincidencia tiene como objetivo ayudar al usuario a reconocer la clave, entonces si estuviera escribiendo un manual, coincidiría con las cursivas y, si es posible, también con la fuente.

Supongo que por "procedimiento" no te refieres a código, sino a una receta de acción para que un operador humano logre algún objetivo o resultado.

Por lo general, en la documentación, le gustaría que todas las referencias de la interfaz de usuario tuvieran un estilo coherente. Esto me llevaría a pensar que hacer coincidir estilos de fuente con elementos individuales no es el enfoque ideal.

La mejor práctica sería crear una guía de estilo que incluya cómo va a indicar un elemento de la interfaz de usuario y adherirse a eso en todos los casos. Esto ayudará a su audiencia a reconocer un elemento de la interfaz de usuario cuando lo vean en el texto.