Documentación técnica – Desafíos
Una buena solución
Una buena solución se basa en XML y con ello posee un formato neutral. Se trabaja modularmente para poder volver a utilizar bloques de textos, inclusos con variantes. Los modelos de formulación corresponden a la norma, lo mismo rige para las indicaciones de advertencia.
Una buena solución garantiza que los colaboradores puedan ser instruidos en 4-5 horas. Luego estos pueden trabajar productivamente.
Una buena solución guía al redactor. El redactor es guiado por una estructura y debe obligarse a mantenerla. De esta forma se puede obtener una estructura consistente de la documentación.
Una buena solución tiene modelos de formulación uniformes.
Una buena solución evita compuestos y oraciones complejas.
Una buena solución es un nuevo inicio, ya no hace falta recargarse con los históricos textos. Pues, en la mayoría de los casos, estos no poseen estructura.
Una buena solución incluye los controles (textos de pantalla). De esta forma se garantiza que los contenidos de los textos sean sincrónicos.
Una buena solución minimiza los costos de traducción.
Responsabilidad gerencial
En las relaciones externas es el gerente en persona quien se responsabiliza por los contenidos de un manual de instrucciones. En caso de daño (heridas/muerte) éste debe comprobar que si la máquina es utilizada correctamente, no deberían producirse accidentes. El manual de instrucciones sirve como protección, allí el explotador encuentra las especificaciones exactas a seguir para evitar un caso de daño. Si el manual de instrucciones presentara fallas y si no se han indicado correctamente las obligaciones al explotador, entonces es el gerente (fabricante) en persona quien tiene las consecuencias legales.
Por eso consideramos prioritario dentro de la documentación técnica, garantizar la seguridad legal del fabricante.
