Guía de estilo para documentación

Una Guía de estilo de documentación es clave para conseguir que los manuales sean homogéneos pues contiene los criterios, normas de estilo, forma y apariencia que han de aplicarse con el fin de que pueda desarrollarse una documentación consistente y coherente.

De ello también depende que la comprensión de un manual sea la esperable.

Elaboramos una guía de estilo de documentación para conocido grupo industrial con multitud de empresas de alta tecnología. Se puso en contacto con GEMINYS motivado por la falta de homogeneidad de sus manuales y la poca certeza de que dichos manuales cumplieran con la normativa vigente.

En su búsqueda de soluciones, emprendieron la tarea de formar a sus especialistas en las directivas de seguridad y su aplicación en documentación. Sin embargo, el plazo era largo no sólo teniendo en cuenta el desarrollo de la documentación en si, si no también, por el tiempo que dejaría de ser dedicado a su tarea principal.

Finalmente, atraídos por nuestra experiencia y el conocimiento relativo a buenas prácticas documentales acudieron a GEMINYS para la elaboración de sus manuales industriales.

Se elaboró una Guía de Estilos Corporativa que incluyó: 

● Todos los layouts y elementos indispensables para facilitar el trabajo de los redactores y sistematizar el desarrollo de los manuales.

● Un resumen de los puntos fundamentales a tener en cuenta a modo de «check-list» recogidos en las directivas de seguridad vigentes y que deberían incluirse en la documentación.

● Una serie de reglas de redacción y otras buenas prácticas documentales (codificación, ilustración, revisión, traducción) que unificarían los criterios en todo el grupo de empresas.

Actualmente el cliente no solo sigue utilizando esta Guía de estilo para su documentación, sino que la utiliza como especificación de documentación tanto para la subcontratación de documentación como para el desarrollo interno de la misma. 

Esta Guía ha ido evolucionando, incorporando nuevos elementos y adaptándose a las cambiantes normativas. Tanto es así, que cada vez que GEMINYS colabora con este cliente en un nuevo proyecto de documentación, recibe una nueva versión actualizada de este documento. 

¿Necesitas una guía de estilo para tu documentación?