xml - what - Mejor software de edición manual
what is xml (10)
Estoy escribiendo un manual para nuestro nuevo producto de software ... y M $ Word simplemente no lo corta. Entonces, ¿cuál es el mejor software o lenguaje para usar para crear / editar un manual de software?
Para un manual impreso voy con LaTeX.
MikTex es la mejor implementación de Windows en mi opinión. Mi editor preferido es WinEdt
Hay un gran tutorial de LaTeX por Tobias Oetiker
Si va a ser principalmente un manual electrónico y los usuarios estarán en línea, entonces una wiki controlada puede ser una buena opción.
Debería preguntarse qué características son importantes. ¿Quieres un manual impreso? ¿Un manual en línea con hipervínculos entre secciones? Enlaces de la aplicación en secciones del manual? Una vez que especifique sus necesidades con más detalle, las personas podrán ayudarlo más.
También puede usar HTML simple antiguo, especialmente si su manual es principalmente para lectura electrónica.
Texas:
Todas las empresas para las que he trabajado (desde Interleaf) utilizan Adobe FrameMaker.
DITA para el contenido, DITA Open Toolkit para procesar los documentos, y luego tiene múltiples opciones que editor usar, Epic, XMetal, Serna, oXygen, etc.
Lo haría usando látex. Puede generar un PDF profesional atractivo y te ayuda con la tabla de contenidos, haciendo referencia a imágenes y secciones, citas, etc.
Recomiendo texlive desde http://www.tug.org/texlive/
Edito estos archivos con vim, pero hay algunos buenos softwares de gui como LyX como dijo Chris Charabaruk y Texmaker , que te ayuda a editar la fuente a través de su interfaz gráfica de usuario.
Usamos Ayuda y Manual . Tiene algunos caprichos, pero en general es bastante bueno; especialmente ahora que guarda en un formato no binario que se puede fusionar. Su manual está en control de versión, ¿verdad?
Recomiendo Adobe InDesign para los manuales que requieren un diseño de precisión y gráficos de alta calidad. También utilicé Adobe Framemaker para los manuales. Ofrece algunas ventajas significativas sobre InDesign para documentos altamente estructurados. Permite un nivel mucho más complejo de numeración de párrafos y creación de variables que Indesign.
Ambos programas son más difíciles de aprender que MS Word, pero ambos son muy superiores a Word cuando desea utilizar más de un puñado de gráficos o ilustraciones.
Entonces, si el diseño gráfico o la impresión de alta calidad es importante, InDesign es mi elección. Si solo tiene que imprimir en una impresora láser o en blanco y negro, pero desea más potencia en la numeración y las variables, ejecute encabezados y pies de página.
Ambos programas ofrecen excelentes capacidades de exportación y soporte para XML y flujos de trabajo estructurados.
A riesgo de sonar impopular, me gustaría sugerir el uso de DocBook , junto con un editor XML decente (preferiblemente uno que pueda procesar DocBook muy bien). Hay una cadena de herramientas XSLT disponible que puede generar varios formatos de salida diferentes, incluidos HTML o PostScript (que se pueden convertir fácilmente a PDF o imprimir).
Si bien DocBook no es lo más fácil para trabajar, es mucho más poderoso que simplemente usar un documento de Word, y es menos complejo y difícil de manejar que TeX.
En cuanto a un editor decente en sí, LyX es un buen editor WYSIWYG para documentos TeX, e incluye algunos (desactualizados, desafortunadamente) soporte para exportar DocBook. También he visto editores WYSIWYG decentes para DocBook, pero desafortunadamente sus nombres no vienen a mi mente en este momento; busca y encontrarás.
EDITAR: Hay otra pregunta SO que pide las mejores herramientas para DocBook , también es posible que desee verificar las respuestas en esa.