[es-documentation] Recordando algunas normas

classic Classic list List threaded Threaded
1 message Options
Juan Carlos Sanz Cabrero Juan Carlos Sanz Cabrero
Reply | Threaded
Open this post in threaded view
|

[es-documentation] Recordando algunas normas

Buenas.

Recuerdo que una norma de las guías (y que es muy conveniente también
para los documentos propios), es que nunca se aplica formato directo, es
decir no se aplican negritas, ni cursivas, ni ningún otro formato de los
que están en la barra de formato. Todos los formatos se deben aplicar
con *estilos* (de párrafo, carácter o lo que corresponda).

Lo mejor es aplicar los estilos que ya tiene el documento. Pero por si
dudas, la explicación de los estilos que se deben aplicar se puede ver
(en inglés) en la plantilla que está publicada en la carpeta "7
Plantillas" de cada guía.

Estamos intentando sustituir los estilos que se llaman L0-loquesea por
sus equivalentes que no empiezan por LO y algunos estilos que tenían
nombres personalizados, se están sustituyendo por los estilos corrientes
de LO. En estos casos los nombres de los estilos aparecen en español
(por ejemplo Figura/Figure, Destacado/Enphasis, Muy
destacado/StrongEenphasis).

Hay que tener en cuenta que hay estilos que en el documento se ven
igual, pero que en realidad no son lo mismo y puede ser que en cualquier
momento cambien, por lo que hay que tener cuidado de aplicar el estilo
que corresponda. Por ejemplo, Destacado y Keystroke con las plantillas
que estamos aplicando en estos momentos, se ven igual (como cursivas),
pero seguramente en los documentos de la versión 7 Keystroke tendrá un
fondo amarillo, por lo que si el estilo está mal aplicado nos causará
problemas.

Otra aclaración, para hacer referencia a los nombres de los elementos,
menús o cualquier cosa de la interfaz, se emplea el estilo Destacado
excepto si es una acción que debe ejecutar el usuario, en cuyo caso se
emplea MenuPath. Ejemplos:
     • En el  menú /Archivo /( Destacado) se encuentran todas las
opciones relacionadas con archivos.
     • Para crear un documento nuevo seleccione *Archivo > Nuevo*
(MenuPath).

Para las secuencias de menú se sigue empleando el signo *>* porque es
más cómodo que cambiarlo por el triángulo (que alguien me ha mencionado)
y por coherencia con el resto de las guías, incluidas las de otros
idiomas. Ya sé que en la Guía de estilo pone que se emplee el triángulo,
pero lo que casi nadie se fija es que antes menciona  "En el contenido
de la ayuda…" y una herencia que creo que ya hemos superado. Aclaro, que
no vamos a modificar la Guía de estilos porque la también la usan otros
colaboradores, no es propia de la documentación

Con respecto a las figuras, ya publiqué el enlace a un vídeo en el que
explicaba como modificarlas en el documento. Pero no decía nada del modo
de hacer las capturas de pantalla. Recomiendo que las capturas se hagan
con un capturador de pantallas específico mejor que con el GIMP u otras
herramientas que también podrían servir. La ventaja es que la mayoría de
los capturadores de pantalla permiten seleccionar la ventana o el
diálogo directamente, con lo que no hay que estar ajustando la captura a
los mismos. También permiten sacar o no el puntero del ratón, según nos
interese, o hacer la captura con algún retraso para colocar los menús (u
otros elementos) en la posición que nos interese. Por si alguno no sabe
que capturadores usar, yo utilizo Shutter en Linux y ShareX en Windows,
pero claro está, hay mucho más y seguro que mejores.

Lo que sí que hay que evitar es que las capturas de pantalla tengan
adornos, como por ejemplo sombras o bordes, También es recomendable no
sacar el puntero del ratón si no es necesario para la explicación, y si
se saca, evitar que los /tool-tips/ tapen cosas importantes.

Supongo que más de uno pensará que por qué no está escrito en la guía
del colaborador o en algún sitio de esos y contesto: si tuviéramos una
guía del colaborador de 100 páginas nadie la leería (teniendo diez u
once hay muchos que no la leen…) y no nos engañemos, si el primer día
que nos acercamos a la documentación leemos un montón de reglas que no
terminamos de entender, no me digáis no os echaríais atrás. Además estas
normas pueden ir cambiando con cada guía.

Bueno, ya me he extendido bastante, seguro que ya alguno no lee el
mensaje completo ;-)

Saludos

Juan C. Sanz


--
Para instrucciones sobre darse de baja envíe un mensaje a: [hidden email]
¿Problemas? https://es.libreoffice.org/recibe-ayuda/listas-de-correo/baja/
Guías para envío + más: https://wiki.documentfoundation.org/Netiquette/es
Archivo de la lista: https://listarchives.libreoffice.org/es/documentation/
Privacy Policy: https://www.documentfoundation.org/privacy