Software para crear y mantener manuales de usuario/servicio

Estamos buscando un software que nos permita crear y mantener fácilmente manuales de servicio para las máquinas que fabricamos. Tenemos alrededor de 25 máquinas y hemos estado usando Microsoft Word hasta ahora, pero es extremadamente difícil y requiere mucho tiempo mantener 25 manuales de servicio que comparten al menos el 75 % del texto y las imágenes. Cuando hacemos un cambio en uno, tenemos que abrir los otros 24 y hacer el mismo cambio.

Necesitamos algo que nos permita usar algún tipo de texto e imágenes "compartidos" que se inserten en marcadores de posición en los manuales, para que podamos cambiar esa fuente compartida y se actualizará a todos los manuales, sin alterar el formato. Los números de página y el índice también deberían actualizarse automáticamente.

También debe haber un área donde todos los manuales estén organizados para facilitar el acceso, tal vez con el guardado de revisiones y fechas.

Windows es la plataforma preferida, pero también estoy abierto a otras.

¿El documento resultante debe estar en formato Word, o estaría bien con otros también, por ejemplo, PDF? ¿Se copian las "partes comunes" sin ningún ajuste (aparte de los números de capítulo y notas a pie de página generados automáticamente)? ¿Estaría bien con un formato de entrada diferente, como Markdown o HTML (al menos mientras haya editores GUI para él)? Tendría en mente un enfoque que podría delinear fácilmente para Markdown -> PDF en Linux (que probablemente también funcionará en Windows, que no puedo probar).
PDF también es bueno, pero el editor debe ser un editor de texto normal: los usuarios no son lo suficientemente técnicos para nada más.
Bien, entonces tal vez algo como Documento maestro podría encajar: un "documento maestro" básicamente es un "envoltorio" alrededor de varios documentos separados. Entonces, haga que sus usuarios editen las "secciones" en documentos separados y use documentos maestros para unirlos. Desde allí, puede exportar a, por ejemplo, PDF, HTML o lo que necesite y sea compatible (AFAIR, incluso podría crear libros electrónicos EPUB de esa manera).

Respuestas (3)

Una opción a considerar es Sphinx , que puede generar múltiples formatos de documentación.

Características:

  • El texto se almacena como texto reestructurado , que es texto sin formato, por lo que se controla fácilmente la versión.
  • Gratis, gratis y de código abierto
  • Multiplataforma (escrito en python)
  • Formatos de salida: HTML (incluida la Ayuda HTML de Windows), LaTeX (para versiones PDF imprimibles), ePub, Texinfo, páginas de manual, texto sin formato.
  • Amplia indexación, referencias cruzadas, etc.
  • Estructura jerárquica: fácil definición de un árbol de documentos, con enlaces automáticos a hermanos, padres e hijos
  • Incruste imágenes y diagramas en varios formatos (SVG es el mejor para este tipo de cosas), desde archivos externos.
  • Varios temas atractivos o define el tuyo propio.
  • Si los cambios en el aspecto deseado se pueden implementar mediante un cambio de tema y luego regenerando los documentos deseados.
  • Algunos sitios de ejemplo:
Además, se pueden lograr muchas cosas solo con reStructuredText, sin Sphinx.

MS Word ya hará esto por usted. Puedo confirmar que acabo de probar la respuesta a esta pregunta y funciona.

Vaya a la pestaña Insertar, luego haga clic en Objeto (está en la subcategoría de texto cerca del extremo derecho). A continuación, verá la siguiente captura de pantalla:

ingrese la descripción de la imagen aquí

Busque el archivo y marque la casilla "Vincular al archivo". Puede actualizar el archivo de origen (lo haría para evitar confusiones), o si está en el archivo de destino, cuando intenta editarlo, en realidad abre el archivo dentro del archivo. Difícil de explicar, pero lo entenderás cuando lo veas.

Creé un docuemtnA.docx, inserté un texto. Luego creé B.docx, le di algo de texto y, en el medio, seguí las instrucciones dadas anteriormente para insertar un enlace a A.docx. Luego actualicé A.docx y el contenido de B.doxc reflejó el cambio, sin ninguna acción de mi parte.

Esto funciona para MS Word 2010. La misma funcionalidad estará disponible para otras versiones, pero es posible que necesite diferentes menús para lograrlo.

¡Felicidades! Ahora eres el héroe de tu departamento :-)

Estoy investigando esto, volveré y actualizaré los resultados.
Por favor, haga (+1), porque su conformación podría ayudar a otros en el futuro, tal como lo he ayudado a usted, y de eso se trata el intercambio de pila :-)
Esto funcionó como dijiste, pero el índice (también conocido como tabla de contenido) no incluye nada de los documentos de Word externos.
Eso es a la vez sorprendente y decepcionante; Ciertamente puedo ver cómo sería un problema. Por desgracia, no puedo ayudar. Puede intentar preguntar en superuser.com o en un foro de MS Office. Si lo hace funcionar, ¿podría publicarlo aquí para ayudar a otros en el futuro?

LaTeX es una buena opción para esto. Permite que los documentos incluyan otros documentos y le permite escribir macros para eliminar otros tipos de elementos repetitivos. En general, es mucho menos agradable trabajar con Sphinx (TeX ya estaba mostrando su edad hace 10 años), pero le permitirá hacer todo tipo de cosas sofisticadas para la composición tipográfica impresa si tiene paciencia, lo cual será útil. si los manuales están destinados a ser impresos y verse bonitos impresos.

Software para crear y mantener manuales de usuario/servicio
RespuestasAquíPolítica de privacidad1y, 0v