Soy ingeniero. En mi empresa, los ingenieros parecen pasar mucho tiempo revisando la documentación técnica escrita por personas que trabajan en diferentes oficinas y zonas horarias. Parte de la razón por la que dedicamos tanto tiempo es que se nos presentan muchas preguntas pequeñas, un correo electrónico a la vez, en lugar de recibir bloques más grandes de tareas de revisión superpuestas en una vista de la documentación completa.
Los escritores están usando FrameMaker. Los ingenieros no tienen licencias de FrameMaker, pero saben cómo usar las herramientas de revisión de código. Mis preguntas son:
La larga experiencia nos ha enseñado a muchos de nosotros que cuando le envías un correo electrónico a una persona ocupada con más de una pregunta, solo responde la primera e ignora el resto. Por lo tanto, muchos de nosotros nos hemos acostumbrado a hacer una pregunta por correo electrónico. Es posible que pueda resolver parte del problema pidiéndoles a los escritores que le envíen un montón de preguntas en un solo correo electrónico, siempre que las responda todas.
Pero no espere que lo primero que obtendrá sea un documento completo con preguntas de revisión adjuntas. Los redactores técnicos rara vez tienen acceso a fuentes de información que les permitan escribir un documento completo sin hacer un montón de preguntas a los ingenieros. Necesitan sus respuestas para escribir el documento.
En cuanto a FrameMaker: Framemaker viene en dos variantes, no estructurado y estructurado, y en la actualidad Framemaker estructurado viene con soporte para un sistema de escritura estructurado llamado DITA. Si sus escritores usan las versiones estructuradas o DITA de Framemaker, entonces sí, hay una versión XML del documento que se puede revisar con herramientas estándar de revisión de código. Sin embargo, si utilizan Framemaker no estructurado, la respuesta es no. Mi impresión es que la mayoría de las organizaciones que usan FrameMaker todavía usan la versión no estructurada.
Un método común para revisar la documentación generada con FrameMaker no estructurado es usar archivos PDF y usar las herramientas de revisión integradas en Adobe Acrobat Reader. Incluso hay una versión basada en servidor (al menos supongo que todavía existe) que permite que varios revisores comenten la misma copia de un PDF para que puedan ver los comentarios que otros ya han hecho.
Personalmente, preferiría tener una endodoncia que revisar de esta manera. Al igual que usted, preferiría que todo el proceso se llevara a cabo utilizando texto estructurado y herramientas de revisión estándar basadas en texto. Pero muchos escritores técnicos parecen preferir este enfoque, y también hay algunos ingenieros que insisten en que tienen que revisar la forma impresa final del documento. No tengo idea de por qué, pero es un hecho desafortunado de la vida.
El uso de herramientas de revisión de código en FM XML tiene algunos inconvenientes:
Corre el riesgo de que los programadores quieran cambiar el código XML, en lugar de solo el texto. Tendría que usar herramientas para hacer que la estructura XML sea de solo lectura y permitir cambios solo en los elementos de texto.
El texto se vuelve menos legible debido a las etiquetas en línea para referencias externas, inserciones de texto, estilos de carácter, etc.
PDF evita todo esto y tiene algunas ventajas adicionales:
Águila Blanca