Escribiendo el primer libro de programación

Hace poco me preguntaron si estaba interesado en escribir un libro para una editorial de buena reputación y, por supuesto, acepté. No soy un escritor de oficio, soy un desarrollador de software con cierta formación técnica en escritura. Lo más largo que he escrito es una disertación sobre computación distribuida, que no es lo mismo que un libro. Por supuesto, este libro trata sobre un tema de programación y debe ser instructivo e informativo. Mi problema es cómo empezar; He estado sentado frente a mi computadora durante aproximadamente 3 horas y he reescrito mi introducción unas 25 veces.

Estoy usando Scrivener como mi herramienta de escritura, que he usado para otros trabajos de tipo referencia, pero por alguna razón no tengo nada en mi cerebro para comenzar, ¡mi tablero de corcho está totalmente desprovisto de notas! ¡No sé qué hacer y me siento totalmente intimidado! ¿Alguien tiene un consejo para un autor de libros por primera vez para comenzar? ¡Me interesaría saber cuál es su proceso para comenzar y cómo organiza sus pensamientos!

Como todos han sugerido, no se preocupe por la introducción.
Gracias por las sugerencias útiles, hasta ahora he tomado un poco de cada una de las sugerencias y creo que he tenido un buen comienzo. Sin duda, es mucho más difícil de lo que esperaba, ¡pero también es muy divertido!

Respuestas (6)

Cierra la introducción. Prométete a ti mismo que lo escribirás al final.

Inicie una página de Scrivener en blanco.

Empieza a escribir todo lo que se te pase por la cabeza sobre el tema. Sigue tus pensamientos dondequiera que te lleven, pero haz de cada pensamiento una nueva línea. No organices; solo escribe.

Cuando te quedes sin energía, vuelve al principio de la lista, mira cada pensamiento y mira si genera más cosas.

Siga haciendo eso hasta que no pueda pensar en más cosas para agregar a la lista.

Ahora que tiene una lista de cosas, comience a agruparlas. Ya que sé mucho sobre programación, usaré la jardinería para mi ejemplo.

  • Grupo A: siembra
  • Grupo B: deshierbe
  • Grupo C: cosecha
  • Grupo D: insecticidas
  • Grupo E: tipos de plantas
  • Grupo F: orgánicos
  • Grupo G: color
  • Grupo H: temporada

etcétera. Simplemente ponga la letra (A) delante de cualquier declaración que tenga que ver con plantar.

Haz nuevas páginas para cada uno de los Grupos. Copie todo lo que tenga una A en la página A: Planting. Copie todo lo que tenga una B en la página B:Weeding.

Lo maravilloso de Scrivener es que no tienes que poner las cosas en orden todavía. Entonces, una vez que tenga todas sus declaraciones de F:Organic juntas, simplemente comience a escribir. Haz un volcado de información de todo lo que sabes sobre jardinería orgánica. Cuando se te acaben las cosas, ve al siguiente tema que te apetezca.

Después de un tiempo, tendrá suficiente información para ver cómo debe estructurarse su libro, o puede encontrar un editor que pueda ayudarlo a organizar todo. Puede arrastrar sus páginas de la forma que desee.

Lo importante es escribirlo todo. Puede reorganizar una vez que lo haya colocado en la página.

Gracias por el consejo, creo que porque mi cerebro suele pensar en fragmentos de pensamiento muy estructurados, a falta de un término mejor. La idea de escribir en el viento y simplemente seguir tus pensamientos nunca se me ocurrió. ¡Probaré esto seguro!
Lauren, estoy aprendiendo Scrivener y es genial. Pero por lo que estás describiendo, creo que un mapa mental sería un lugar aún mejor para comenzar. Luego pase a Scrivener cuando los temas se hayan agrupado y conectado visualmente. Funciona para mí, de todos modos.
@Lynn: probé algunos mapas mentales y los encontré confusos hasta el punto de ser abrumadores. Creo que depende de cómo un individuo se sienta más cómodo organizando la información. Lo que funcione para usted es la respuesta correcta. :)
Solo como una actualización: ¡he terminado una buena parte de este libro y todavía no he escrito la introducción!
pero has terminado una buena parte del libro... que era el punto. :)
¡Creé una cuenta aquí para agradecer la excelente respuesta! Esto es muy útil para alguien como yo que realmente apesta para que las ideas fluyan y organizarlas más tarde :)
¿Scrivener es adecuado para libros de programación? es decir, ¿es difícil incluir código de programación dentro del documento?
@Blankman No escribo código, así que no podría decirlo. ¿Usas una fuente especial?

Escribí cuatro de esos libros. El primero tenía 750 páginas. Los otros oscilaban entre 250 y 400 páginas cada uno.

Mi técnica consistía en presupuestar un número particular de páginas o una cantidad particular de tiempo cada día para escribir.

Por mi parte, descubrí que si escribía más de 4 páginas por día (6 en un buen día, variaba), me agotaba rápidamente.

Eso es 2000-3000 palabras.

Para la estructura general, escribí un esquema. No tiene que ser muy detallado, solo lo suficiente para guiarte.

No escriba su introducción hasta que haya terminado. Siempre escribí esas cosas al final.

No te molestes con la perfección. Su editor tiene editores de estilo, editores técnicos, etc. por una razón. Que hagan su trabajo. Por otro lado, recuerda que no son programadores, y cuando usas palabras como "O" como verbo, los confundirás.

Encuentre una parte que le interese y escríbala para seguir su propio flujo.

Hay partes menos interesantes que escribir. Poder a través de ellos. No se permita llegar a una parte más interesante sin pasar primero por una parte menos interesante.

A veces, incluso cuando se trata de presupuestar páginas o palabras por día, llegarán algunos días en los que simplemente no podrá escribir 2000 palabras. Haces tu mejor esfuerzo, pero solo puedes sacar 1000 chirridos. Eso está bien. Sin embargo, no hagas que el día siguiente tenga que ser un día de 3000 palabras para compensar la falta, o llegarás a un punto en el que necesitarás 10,000 palabras, lo cual es casi imposible de hacer un buen contenido, y te abrumará.

Si tiene un día ligero, distribuya la escasez entre 5 y 10 días. Si abrevia 1000 palabras, agregue 100 palabras por día hasta que lo compense.

Tómese días libres. En serio.

Además, si superas las palabras o páginas presupuestadas y sientes que puedes duplicarlas, oblígate a detenerte y no escribir nada hasta el día siguiente. Confía en mí en esto. Puede escribir un poco más, alrededor del 25% más o menos, pero no duplique. Quema la ciudad.

Creo que el problema de Steven en este punto es tener una idea general inicial del proyecto en lugar de contar las palabras. Podría estar equivocado.
¿500-750 palabras por página? ¡Eso es texto denso! Cambiaría el tamaño del texto para obtener unas 250-300 palabras por página más fáciles de usar. Le dará una mayor sensación de progreso y será más amable cuando quiera revisar su trabajo.

En las etapas iniciales, creo que tienes que liberarte de la noción de que estás destinado a producir cualquier cosa que se parezca a tu libro terminado.

Mientras escribe un volumen de no ficción, necesariamente existirá en un ecosistema de obras de no ficción que rodean el tema de su trabajo. En esta etapa no está de más releer y examinar algunos de los libros que contienen las ideas que constituyen la base de su propio trabajo. Debe anotar su lectura, proporcionar referencias al otro trabajo y luego tomar notas sobre lo que su volumen eventualmente dirá sobre ese tema. (Este también es un buen momento para anotar la estructura del libro que está leyendo para obtener consejos, haga más notas, por ejemplo, "Me gusta la estructura del Volumen X, pero la variedad de temas en el Volumen Y está más cerca de lo que cubriré ".)

Si haces este trabajo a fondo, probablemente terminarás con entre 20k y 50k de notas fundamentales. Organízalos en una estructura aproximada que te imaginas que sigue tu volumen.

Ahora tienes una estructura y una base. Examine las notas y amplíelas hasta que cubran lo que quiere cubrir en su libro. Esto debería llevarlo a la marca de 75-140k dependiendo de cuánto se expanda.

Si ha escrito demasiado ahora es el momento de editar. De hecho, una vez que tenga este lío desgarbado de tomar notas y editar textos explicativos es esencial. Tenga cuidado, busque formas de reducir la palabrería. Una referencia original puede convertirse en una nota al pie, puede convertirse en una cita integral del texto. O puede eliminar la referencia específica y simplemente dejar las notas.

De todos modos, eso es mucho más allá de cómo empiezas. Así que lo dejaré ahí.

EN EL CORAZÓN: Recuerda que tu trabajo no puede y no existirá en el vacío. El primer paso del viaje es siempre averiguar de dónde se parte. Así que antes de escribir, organice sus pensamientos, lea, tome notas, prepárese.

¿Entre 20k y 50k de notas fundacionales? ¿Para un libro de programación? ¡Dios mío!
Terminé con 25k de notas para mi tesis de pregrado de 10k. Creo que estar en una posición en la que tienes más conocimientos ingobernables y poco disciplinados de los que necesitas antes de empezar es esencial para hacer un producto terminado bien disciplinado, completo y fascinante. Acumular notas no debería ser el problema, sino modificarlas para darles forma.

He escrito una docena de estos. Hoy en día lo que mejor me funciona son los mapas mentales. Similar a la sugerencia de Lauren , escribo todo sobre el tema que necesito y quiero cubrir en un mapa mental. ( Pruebe MindMeister ). Comience a agrupar las cosas en temas principales con temas menores relacionados agrupados alrededor de ellos. Siga modificando y pronto tendrá sus capítulos, e incluso el orden en que debe escribir sobre ellos se hará evidente (es decir, debe saber cómo crear una base de datos antes de poder insertar registros en una).

Lo bueno de dividir las cosas de esta manera es que cuando termines, tendrás todos los temas en partes pequeñas. Dividir su proyecto en partes más pequeñas lo hace mucho más simple. En lugar de pensar, "¿cómo diablos voy a terminar alguna vez esta cosa enorme?", puedes concentrarte en las piezas pequeñas.

"En lugar de pensar, '¿cómo diablos voy a terminar alguna vez esta cosa enorme?', puedes concentrarte en las piezas pequeñas". Eso es definitivamente clave para todo el proceso. Buena publicación.

Por lo general, combino lo que Lauren y Lynn sugieren, en el sentido de que hago una lista de cada frase o declaración que conozco sobre el tema, las agrupo y luego las organizo en un esquema aproximado. He usado Scrivner, Freemind y otras herramientas de mapas mentales, pero últimamente, me encuentro usando Workflowy para hacer esto.

Aquí hay algunas respuestas relevantes y detalladas, a las que solo puedo agregar mis dos centavos, no un poco más :)

  1. ¿Quién es tu público objetivo? Si es para principiantes, ¿puedes volver a tus viejos días de aprendizaje de programación como novato y luego tratar de recordar algunas cosas que amabas u odiabas de algunos libros? Es más probable que los que amabas sean los puntos de venta comunes en los que deberías enfatizar, y viceversa. Hable con algunos programadores nuevos si desea obtener más información sobre esto. Si es un libro más avanzado, entonces supongo que es un trabajo más fácil para un programador avanzado (que supongo que lo eres). Puedes explicar las cosas de la forma en que te gustaría conocerte a ti mismo.

  2. La mayoría de los libros de programación están repletos de códigos compilados que echan a perder a los alumnos. Si te atreves a ser un poco aventurero, y deja algo de trabajo para que lo haga el cerebro del lector. A veces, esas largas expresiones idiomáticas parecen agotadoras para el cerebro. ¿Recuerdas el de Kernighan y Ritchie?

  3. ¿Cuál es la especialidad de su libro? Ya hay un montón de ellos en el mercado, y necesitas ser diferente a ellos. Seguramente, diferente no significa extraño, sino más útil/mejorado.

  4. Consejo general sobre la escritura: comience primero con la estructura. Crea el documento, escribe algunas viñetas que definitivamente quieras abordar y trátalo como tu propio cuaderno para los próximos días. Escribe en un inglés sencillo, sin prestar mucha atención al idioma. Luego regresa y revisa. Te sorprenderá ver cuántas nuevas ideas y mejoras surgieron del mismo tú que hace unos días temías emprender la tarea. Me pasa TODO EL TIEMPO.

  5. Siga alguna técnica de gestión del tiempo: establezca un límite diario/semanal de tiempo/página que definitivamente desee alcanzar. Y sí, haga que sus compañeros discutan sus ideas y las revisen de vez en cuando. Ayuda a impulsar nuevos pensamientos a veces.

Espero que esto ayude.