Flujo de trabajo para convertir el contenido de Wiki en un manual del sistema

StackOverflow https://stackoverflow.com/questions/618508

  •  03-07-2019
  •  | 
  •  

Pregunta

Estamos implementando un nuevo sistema de software para muchos usuarios en muchos lugares (más de 200 usuarios en 8 países). En el pasado, hemos escrito un manual para los usuarios y luego lo actualizamos cada cierto tiempo. Esto funciona bien, ya que todos los usuarios tienen el mismo manual y cubren las principales cosas, pero tiene sus problemas, como no se actualiza tan a menudo, a veces faltamos actualizaciones y algunos usuarios tendrán copias antiguas.

Hemos estado hablando sobre el uso de un wiki durante las fases de prueba e implementación para crear una base de conocimientos sobre el sistema. Lo ideal sería que quisiéramos alguna forma de convertir eso en algún tipo de documento electrónico que luego podamos "enviar con bastante" y enviar como el manual oficial, así como permitir que los usuarios usen y actualicen el wiki.

¿Alguien más ha hecho algo similar? ¿Alguna sugerencia para sistemas wiki, flujos de trabajo, formatos de documentos, etc.?

¿Fue útil?

Solución

La mayoría de los wikis admiten la exportación a través de PDF, por ejemplo:

Otros consejos

Puede escribir algo que genere LaTeX de la wiki y presente un manual en PDF. Con paquetes como hyperref puede retener referencias cruzadas como hipervínculos.

Además, puede integrar contenido de múltiples fuentes, como un diccionario de datos, en el documento LaTeX, que puede combinarse y combinarse con el contenido de la wiki. También puede configurar la arquitectura para que pueda admitir referencias cruzadas que vayan en cualquier dirección.

Framemaker también puede admitir esto utilizando el MIF , y también puede usar Lout de forma similar o convierta su contenido de wiki a docbook, que le permitiría usar cualquiera de las muchas opciones de representación disponibles para ese formato.

Como nota aparte, las siguientes publicaciones de Stackoverflow tratan diversos sistemas para mantener la documentación.

Madcap Flare es una herramienta de creación de ayuda y manual que utiliza HTML para el Fuente de cada tema. Podrías fácilmente hacer una importación masiva de las páginas de Wiki. Entonces se requeriría un poco de limpieza, pero después de eso, tiene un buen sistema de fuente única que puede generar CHM, ayuda para navegar en la web, PDF, DOC / DOCX, etc.

¿Cómo está almacenando la fuente de ayuda en este momento? ¿Son archivos de MS Word, ayuda de MS, LaTeX?

Si pone sus archivos fuente de ayuda bajo el control de versiones, obtendrá todos los beneficios de una wiki sin tener que migrar a un nuevo sistema. La gente puede editar fácilmente los archivos de ayuda. Es posible rastrear, revertir esos cambios, etc. . y obtienes los manuales precisos como antes.

Seguí los enlaces de Node y encontré algunas páginas de mediawiki que pensé que eran dignas de mención.

Di una respuesta anterior que puede ser útil para el " wiki a PDF " parte: considere el uso del código o la funcionalidad de código abierto de PediaPress. También puede obtener ODFs de este, aunque sus archivos PDF ya son bastante bonitos (aunque supongo que debería cambiar el nombre de su marca y renovarla para su empresa, supongo).

Licenciado bajo: CC-BY-SA con atribución
No afiliado a StackOverflow
scroll top