¿Cuáles son las mejores herramientas para escribir un libro técnico bien formateado con muchos ejemplos de código?

Answer 1

Auto-publiqué algunos libros técnicos con muchos listados de códigos en ellos. Aquí está la suma de mi humilde experiencia:

• Necesitas un procesador de textos decente. Cualquier editor en estos días es bueno. Yo uso LibreOffice Writer . Puede usar MS Office Word . De cualquier manera, asegúrese de que su procesador de textos pueda emitir archivos Doc (x) y Pdf . Probablemente necesitará ambos más adelante.
• Necesita una fuente monoespaciada para las listas de códigos. Yo uso Fantasque Sans Mono. Si lo desea, puede buscar en el catálogo de Open Font Library otras fuentes de código abierto.
• Para ahorrarse una experiencia de edición dolorosa, formatee su código desde la fuente, antes de copiarlo al manuscrito. Haga todas las líneas de menos de 80 caracteres de ancho, ponga llaves en líneas separadas, agregue suficientes comentarios en línea, etc.
• Si el código contiene caracteres no imprimibles, indíquelo claramente en el texto y / o en la lista de códigos.
• Por lo general, formateo mis listados de códigos como tablas con dos columnas: la columna izquierda para numerar las líneas, la columna derecha contiene el código en sí. También le doy un color de fondo gris claro a la mesa. Esto hace que el código se destaque del texto, y el lector puede seguir la descripción del texto fácilmente.
• Necesitará una plantilla para trabajar. Si se publica automáticamente, consulte el sitio web de su editor en línea. Publico con CreateSpace y proporcionan plantillas de Word listas para usar, de acuerdo con mi tamaño de recorte.
• Tu portada necesitará un poco de reflexión. Si publica en inglés, la mayoría de los editores en línea tienen algún tipo de herramientas de creación de portadas. Si publica en cualquier otro idioma, necesitará alguna solución. Uso GIMP y KPaint para el desarrollo de portadas.
• ¡Asegúrese de que cada línea de código que publique realmente funcione! Recibirá muchos correos electrónicos de lectores quejándose de que copiar / pegar su código bloqueó su carpeta de Windows (o algún otro pésimo execuse como ese).

Espero que esto ayude. Feliz autoría!

Answer 2

Prueba neutriNote si estás usando Android, es compatible con el formato con Markdown, el cerco de código de programación y LaTeX para la fórmula matemática. Las notas se almacenan en texto plano universal.

neutriNote – Aplicaciones en Google Play

También es altamente personalizable, lo que significa formas ilimitadas de sincronización, copia de seguridad y extensión de sus funciones por parte de los usuarios.

(Soy el desarrollador).

Answer 3

Adobe FrameMaker (curva costosa y de alto aprendizaje, pero adecuada para la tarea)

Madcap Flare (curva costosa y de alto aprendizaje, muy adecuada para la tarea)

Microsoft Word o LibreOffice (no es costoso, la curva de aprendizaje fácil, requerirá configuración o personalización para estar a la altura de la tarea)

Answer 4

Mi elección sería Adobe FrameMaker. Es una aplicación de publicación, en lugar de simplemente un procesador de textos. Funciona bien para producir libros completos: cada capítulo es un archivo separado, y un archivo de libro es una lista de archivos de capítulos, por lo que puede mover capítulos fácilmente o generar diferentes libros que compartan algunos capítulos.

Maneja muy bien la numeración de capítulos, secciones, figuras, ejemplos, etc., el tipo de cosas que puede usar ampliamente en un libro técnico.

FrameMaker no es fácil de aprender. Probablemente quieras encontrar una clase para comenzar. Medio día a día debería ser suficiente para ponerte en camino.

Y le advertiría que se aleje de Microsoft Word para un proyecto del tamaño de un libro. Word se empantana con documentos grandes o complejos. El formateo y la numeración pueden corromperse. He pasado mucho tiempo en Word solucionando problemas generados por la aplicación misma.

Answer 5

Hay muchas herramientas Si quieres un libro estilo revista de alta calidad, iría por Adobe InDesign. Pero hay otras herramientas que funcionarán bien para PDF y mejor para contenido en línea, mi favorita es MadCap Flare.