¿Cómo se escriben los blogs técnicos? [cerrado]

Usualmente leo mucho sobre programación relacionada con cosas. Cuando el tema que leo no está relacionado directamente con mi trabajo (por ejemplo, leer sobre algunos Algoritmos que no uso en el trabajo diario), los olvido.

Una forma de reforzar lo aprendido es escribir blogs. Soy un principiante en escribir blogs. Cuando comencé a escribir, descubrí que es muy difícil. Incluso simplemente reproducir el contenido lleva unas dos horas. Escribir un blog bien pensado a menudo lleva todo un día o, a veces, un fin de semana.

¿Esto es normal? ¿Algún consejo para escribir tutoriales técnicos / blogs técnicos?

Escribir es difícil, una buena escritura es aún más difícil. La cuestión de tratar de explicar algo es que requiere más conocimiento que simplemente "un poco saberlo". Descubro que al bloguear 1. descubro temas relacionados que necesito entender, 2. identifico dónde mi comprensión es superficial

Lea estas diapositivas http://www.ai.uga.edu/mc/WriteThinkLearn.pdf . Explican mucho sobre la escritura (e incluso lo compara con la programación)

Todo trabajo de calidad requiere tiempo y esfuerzo. Es de esperarse.

Algunos de mis escritos más antiguos del blog tardaron aproximadamente 3 semanas en completarse. Escribes un borrador, lo relees, haces las correcciones necesarias, lo escaneas nuevamente y luego lo corriges. Toma tiempo.

Una idea simple de cómo mantenerte motivado. Si está planeando algo grande, considere si tendría sentido dividir el trabajo en 2-3 partes y publicarlas por separado. Por supuesto, las partes deben ser útiles para sus lectores por sí mismas. Luego, como tardan menos tiempo, es más probable que lo logre y complete el trabajo parcial.

Algunos consejos de este blogger técnico desconocido:

• Verifique (no solo lea) el código que ha ingresado cortando y pegando desde la vista previa a la línea de comando o un archivo de texto para ejecutar. Varias cosas (como terminaciones de línea, sangría y caracteres Unicode) pueden confundirse al transferir desde un editor (o shell) a una página web y viceversa.
• Obtener un humano para comprobar la ortografía, la gramática y el contenido - Muestra que un poco de esfuerzo fue en la fabricación de los artículos correcta y fácil de leer. Si no hay nadie cerca, asegúrese de volver a leer el artículo completo antes de publicarlo.
• Si la plataforma de blogs tiene resaltado de sintaxis , úselo. Si no, publique el código en algún lugar que lo tenga y enlace allí.
  • Corolario: mantenga grandes fragmentos de código lejos del texto del artículo. Esto es un poco vago, pero si el texto explica cómo funciona un código, está bien incluir un fragmento. Si presenta una pieza de software para descargar, es mejor consultar una interfaz web VCS.
• Cada artículo debe ser legible por sí solo . Hacer referencia a otros artículos está bien, pero no solo asuma que el lector ha leído cualquier otra publicación antes de esta.
• Use otros formatos que el texto cuando ayudan a la comprensión. Para algunas cosas, el código es suficiente, pero para algunos una imagen o incluso una animación pueden ser mucho más comprensibles.

A menudo encuentro que una publicación de blog difícil lleva tanto tiempo porque requiere investigación; esa investigación no solo ayuda a tu publicación de blog, sino que te ayuda a desarrollar tu propio conocimiento personal en el proceso. Como dijiste, estás reforzando el conocimiento al escribir la publicación; También estás expandiendo tu conocimiento. Aproveche el tiempo que requiere y valórelo como una experiencia de aprendizaje.

Sí, es normal que la redacción de blogs técnicos tome tiempo. Para mí, la escritura toma la menor cantidad de tiempo (tan corta como una hora o hasta un día, dependiendo de la duración). Luego, la edición y la reescritura suelen llevar más tiempo (hasta dos o incluso tres días). Otro aspecto mencionado que lleva tiempo es aclarar cualquier código de muestra. Además, me gusta pasar tiempo buscando enlaces de apoyo para mis temas. ¡Todo toma tiempo!

Supongo que podrías escribir blogs técnicos ahora. Pero te sugiero que lo hagas cuando te vuelvas experto en algún dominio en particular. Pasar un fin de semana no parece demasiado tiempo. Todo depende de la complejidad del tema. Supongo que lo que estoy diciendo es que el núcleo de su idea debería llegar a usted naturalmente. La ejecución podría (y tomará) más tiempo.

La gente está buscando consejos de expertos en un blog ... no un experimento noobs. pero estoy hablando en un sentido general .. No quiero desanimarte a escribir blogs. Pero tenga en cuenta lo siguiente.

1. Tu blog debería decir algo nuevo. No solo recopile datos y colóquelos en su propio blog

2. Esté absolutamente seguro de lo que está diciendo, es decir, adhiérase a resultados empíricos sólidos o conceptos o cosas altamente probados que haya experimentado de primera mano .

3. Prepárate para las críticas.

4. Aprenda las técnicas de escribir blogs (precisión, concisión, etc.)

5. Escribir algo porque usted piensa que shud ser escrito; no porque creas que se leerá.

Los elementos de estilo

Creo que la escritura técnica sigue muchas de las mismas reglas que cualquier escritura. Si solo lees un libro sobre escritura, debería ser el clásico Strunks "The Elements of Style" . Repasa una lista de cosas que mejorarán su composición, siendo la más importante (OMI), "Omitir palabras innecesarias".

También recomendaría " On Writing " de Stephen King . Si bien se trata más de la escritura ficticia, todavía contiene muchas gemas para cualquier aspirante a escritor, especialmente en áreas como la edición y el proceso de escritura.

Dicho esto, lo difícil de la escritura técnica no es la escritura real, sino aclarar tus pensamientos sobre lo que estás escribiendo. El pensamiento confuso lleva a una mala escritura. La buena escritura requiere que tengas una idea clara de tu tema, por lo que enseñar y escribir es una forma tan excelente de dominar un tema.

Bueno, me lleva mucho tiempo escribir publicaciones de blog, sí. Con frecuencia los escribo durante varios días, o incluso los dejo en borrador durante un par de semanas, de vez en cuando los leo de nuevo y los corrijo y retoco un poco aquí y allá.

Lleva tiempo, pero si ese es el precio por escribir algo de lo que no me avergüenzo después, creo que vale la pena.