¿Qué se necesita para convertirse en un escritor técnico?

Es interesante cómo percibimos a quienes han escrito libros de texto. Las oportunidades para que todos publiquen contenido nunca han sido mejores. Cualquiera puede bloguear; Todo lo que necesita es una dirección de correo electrónico y acceso a Internet. Produzca suficiente contenido relacionado y podría publicar fácilmente un libro usted mismo a través de una plataforma, incluso una tan grande como Amazon. Entonces, ¿por qué percibimos de manera diferente a quienes han publicado libros, especialmente aquellos que tienen su contenido en forma física? ¿Son correctas nuestras suposiciones sobre los autores y sus habilidades? En lugar de darte la respuesta, déjame echar un vistazo a lo que se necesita para convertirte en autor y podrás decidirte.

Para dar un poco de historia: comencé mi carrera como desarrollador y con la experiencia pasé a un rol de arquitectura técnica. Coescribí dos libros y un tercero como proyecto en solitario. Gran parte de este artículo se basa tanto en la experiencia personal como en las ideas de amigos que han escrito libros.

Puede parecer obvio decir esto, pero escribir un libro lleva tiempo. Mucho tiempo. Si bien no he llevado un registro del tiempo dedicado a proyectos de libros, puedo decir con confianza que mi proyecto más reciente tomó más de 400 horas de trabajo según mis patrones de trabajo. Si lo miras como 1 hora por lado, no parece demasiado difícil. Esto es evidente durante un período que el libro promedio puede esperar de 9 a 15 meses, pero algunos títulos tardan más. Tenga en cuenta que todo esto se suma a su trabajo diario y no tiene en cuenta el tiempo que dedica a pensar en cómo abordar cada capítulo, los detalles y las ideas que desea comunicar.

No hay andarse por las ramas; Si bien un éxito de ventas tecnológico genera un poco de dinero, no se compara con los ingresos de un desarrollador experimentado. Si el ingreso personal en retorno directo por sus esfuerzos invertidos es su motivador, entonces no recomendaría ser autor. Sin embargo, hay otros beneficios menos tangibles, pero los abordaremos más adelante.

Debe creer en la idea o tecnología sobre la que está escribiendo. Esta fe no tiene que ser celosa o evangélica. Diría que este nivel de creencia puede ser un gran problema, ya que puede desanimarlo a reconocer cuándo la tecnología tiene una debilidad o no es apropiada para ciertos escenarios. Por otro lado, la falta de fe hará que sea más difícil avanzar cuando las cosas sean difíciles. Por supuesto, existe el riesgo de que su perspectiva se manifieste en su escritura y socave todos sus esfuerzos.

Puede que sorprenda a algunos cuando digo que, para empezar, no es necesario que conozca todos los aspectos básicos de lo que está escribiendo. Aún así, debe estar razonablemente familiarizado y, probablemente, lo más importante, tener una sólida comprensión de la arquitectura y cómo funciona. Esta comprensión arquitectónica lo ayudará a abordar las cosas que no conoce por completo. Como dijo Donald Rumsfeld, hay desconocidos desconocidos y conocidos desconocidos. Es posible que conozca a extraños, pero en su viaje de escritura, prepárese para abrazarlos y dirigirse a ellos cuando tenga sentido para el libro. Pero no solo eso, si tiene incógnitas conocidas, es razonable suponer que lo mismo se aplica a los demás. Al abordar estas incógnitas, agrega valor al libro.

Con respecto a las incógnitas desconocidas, podemos enfrentar este desafío investigando su tema tanto como sea posible. ¿Qué temas se tratan en los foros de chat? ¿Cómo aplicaría la tecnología en casos de uso de nicho? ¿Bajo qué condiciones no tendría sentido aplicar su tema? ¿Cómo es el código si puedes verlo? Responder a este tipo de preguntas traducirá las incógnitas desconocidas en incógnitas conocidas para las que estamos preparados.

Una vieja expresión dice: "Si le das un pescado a un hombre, lo alimentas por un día. Cuando le enseñas a pescar a un hombre, lo alimentas de por vida“. En otras palabras, si le das a alguien la respuesta a un problema, puede resolverlo. Pero explíquele a alguien por qué algo es un problema y cómo y por qué funciona una solución. Entonces no solo superarán su obstáculo actual, sino que también tendrán la comprensión para evitar o resolver problemas relacionados en el futuro. Un rasgo inherente de los libros de referencia es que envejecen relativamente rápido, pero los mejores libros son aquellos que, aunque están actualizados, brindan una excelente perspectiva de los porqués y los motivos y continúan vendiendo y brindando valor a los lectores. Se puede encontrar evidencia de esto en libros como Psychology of Computer Programming de Gerald Weinberg, escrito en 1971; Si bien sus explicaciones están desactualizadas (discusiones sobre tarjetas perforadas, etc.), los problemas subyacentes siguen siendo válidos hoy. Si los comentarios que he recibido son algo que me interesa, no se trata solo de compartir respuestas, es por eso que las respuestas funcionan.

El argumento bien conocido en contra de la documentación era que el buen código se documenta a sí mismo. Pero incluso el código de alta calidad no puede expresar cómo encajan miles o cientos de miles de líneas de código; Incluso si pudiera revisar todo el código, se sentiría como las líneas de la canción "El libro del amor"-"El libro del amor es largo y aburrido, nadie puede levantar la maldita cosaLa clave para ser un escritor efectivo es condensar todo ese "código de autodocumentación" en suficiente información para permitir que el lector haga uso de la tecnología y, lo que es más importante, para ayudarlo a comprender cómo usarla de la mejor manera posible. trampas Pero no solo tratamos de condensar la documentación, idealmente también ofrecemos información y valor agregado, o como dice la canción: "Me encanta cuando me lees."

No tenga miedo de revisar y editar su escritura. El autoexamen puede ser un desafío para muchos, y es fácil leer lo que crees que has escrito. Muy a menudo ayuda dejar de lado lo que ha escrito y pasar a lo siguiente antes de volver a mirar lo que ha escrito. Un poco de tiempo de lo que has escrito generalmente hace que sea más fácil tener un ojo crítico, y reconocer los puntos que te has perdido o que sientes que podrían expresarse mejor. Mejor aún, tenga la confianza de hacer que otra persona revise la escritura y proporcione comentarios. Las personas que conoce probablemente saben cómo dar retroalimentación que es más fácil de tragar. O al menos no estarás dispuesto a admitir que tienen razón. Escribí un capítulo para un libro y por una u otra razón no cumplió con los requisitos. Bueno, fue necesario que un colega me dijera que el capítulo necesitaba un trabajo considerable para llevarlo al nivel que la gente espera de mí. Si no hubiera escuchado y tenido esto en cuenta, la discusión con el editor y sus revisores probablemente habría sido mucho menos placentera.

Para transmitir detalles esenciales, necesita claridad en su pensamiento para comprender los puntos que considera esenciales. La claridad no siempre llega de inmediato, especialmente si eres una persona intuitiva. Si no tiene claro algo, ¿cómo obtendrá un lector la claridad que desea? Eso no significa que no serás un buen escritor si eres una persona intuitiva. Significa que necesitará la paciencia para pensar en lo que entendió intuitivamente hasta que obtenga la claridad para decir algo claramente. A veces, la mejor manera es escribir un flujo de conciencia y luego estar dispuesto a escribir y reescribir hasta que llegue esa claridad. Lo que más me gusta hacer es reflexionar o discutir cosas con colegas: las conversaciones de ida y vuelta mientras beben pueden ayudar a transmitir el punto.

Dice el dicho, "Una imagen vale mas que mil palabras.” No tienes que ser un gurú de da Vinci o Visio (para ser honesto, odio trabajar en Visio y usar PowerPoint). Las ilustraciones dibujadas a mano también son cada vez más populares. La clave es que debe ser suficiente para ayudar a los estudiantes visuales. Si trabaja con un editor, es posible que tenga un equipo de gráficos que pueda ayudarlo.

El altruismo es una cosa divertida; Algunas personas descartan la idea, argumentando que siempre hay una venganza o un impulsor como el "gen egoísta" de Richard Hawkins. Entonces, ¿hay una recompensa cuando asumes el desafío de la escritura técnica? Mucho, pero como dije, no es directamente fiscal. Sin embargo, hay beneficios indirectos, razón por la cual a menudo se ven escribir a consultores independientes. Al igual que ser reconocido como un colaborador clave en un proyecto de código abierto, ser un autor publicado lo distingue de la multitud. Como empleado o autónomo, eso le da más credibilidad, y esa credibilidad, a su vez, puede ayudar con una serie de cosas, desde la búsqueda de empleo hasta las negociaciones salariales y el aumento de la probabilidad de que un trabajo sea seleccionado en una conferencia.

Es probable que los beneficios menos tangibles sean más significativos, como: B. Implementación de un gran proyecto, puesta en marcha y entrega de valor. Hay un verdadero golpe de endorfinas. A diferencia de completar un proyecto, un libro es más un esfuerzo individual; seguramente otros lo ayudarán con él. Aún así, es esencialmente solo, por lo que el éxito es correspondientemente mayor.

Al menos para mí, y creo que también es cierto para otros, leer/escuchar a alguien decir que se ha beneficiado del libro también es muy gratificante. Si te gusta la idea de "por adelantado" o "lo que pasa, vuelve", esta respuesta marcará la diferencia.

Esto me llevaría a hacer un llamamiento a todos los lectores: si ha extraído algo útil de un libro, dígalo abiertamente. Si el libro no está a la altura de sus expectativas o esperanzas, exprese su opinión en un tono constructivo en lugar de una crítica negativa, p. B. "Ayudaría si el libro tuviera...". Tales cosas ayudan al autor a encontrar el coraje para un nuevo título o una segunda edición. Dichos comentarios son mucho más fáciles de incorporar y actuar. La segunda vez, la idea de escribir puede ser mucho más intimidante ya que sabes en qué te estás inscribiendo.

Espero que veas a partir de esto que convertirse en un escritor técnico y ser un gurú en un campo en particular no está reservado solo para unos pocos talentos. Se trata más de la motivación para ayudar y compartir la comprensión y el conocimiento. En el camino para convertirse en un escritor de tecnología, es probable que amplíe su conocimiento que lo acercará a su campo.

Si lo hemos convencido de que tiene lo que se necesita y desea obtener más información sobre los aspectos prácticos de un proyecto de creación, p. B. cómo trabajamos con un editor y desarrollamos una idea en un proyecto real, entonces consulte mi blog.