Recientemente, hace dos artículos, se publicó un centésimo artículo en nuestro centro corporativo. En honor al número redondo, decidimos resumir un poco nuestra experiencia. En este artículo, diremos cómo nuestros desarrolladores trabajan en artículos, lo que les ayuda a escribir y a qué prestar atención cuando trabajan en texto.
Para comenzar, solo responda dos preguntas simples:
- ¿Por qué necesito esto?
- ¿Qué le diré interesante y útil a la comunidad habra?
Luego puede tomar el plan de este artículo (o elaborar uno propio) y hacerlo.
Hay etapas creativas y técnicas. Este artículo es sobre creatividad. Considera:
- ¿Por qué escribir artículos?
- Dónde obtener el tema para el artículo,
- Dónde encontrar el tiempo para escribirlo
- Las principales etapas del trabajo sobre el texto,
- Qué hacer si el artículo no va,
- Y por dónde empezar si nunca has escrito en Habr.
Esperamos que el texto sea útil para otros autores de Habr, incluidos los posibles.
Motivación: ¿por qué debería, como desarrollador, escribir en Habr?
No hay una respuesta única ni una bala de plata. Por lo tanto, damos las respuestas de nuestros empleados, donde todos pueden reconocerse a sí mismos, y los escucharemos con gusto, como usted.
- Socializacion
La empatía y el sentido de comunidad motivan. Quiero compartir emociones y pensamientos sobre el proceso de desarrollo con una comunidad interesada. - Organiza tu conocimiento
Me gusta el orden en mi cabeza, y escribir un artículo o el texto final en general puede acelerar la búsqueda de lagunas en la comprensión y el conocimiento sobre el tema. El artículo le permite mirar el tema desde diferentes ángulos, descubrir completamente todos los momentos incomprensibles, darse cuenta de algo. - Interés ordenar lo nuevo y compartir
Motiva a escribir sobre algo nuevo para él, sobre lo que hay de nuevo en el mundo del desarrollo. Si estuviera haciendo tareas típicas, no creo que haya ningún tipo de escape de esto. En general, el resultado es una instrucción con o sin bromas, que se asemeja a una respuesta detallada con Stack Overflow sobre la pregunta / tema formulada en el título del artículo. - Ahorre tiempo en entrenamiento dentro
El artículo es un compendio para colegas que aún tienen que contarlo más tarde. Y así escribió, y envió o dirigió un seminario. - Obteniendo comentarios y comentarios de la compañía
Es bastante agradable obtener vistas y ventajas en la compensación, mejora el karma. El karma mejorado también te motiva a escribir más. En los comentarios puedes encontrar información útil para ti de los muchachos que siguieron el mismo camino y que ya han llenado los baches. - Para lo mejor
Se inspira en el deseo de acelerar el desarrollo de la humanidad, si alguna actividad del autor le ahorrará a las personas más tiempo del que pasó, en promedio, es probable que la humanidad se beneficie en el desarrollo, ya que el tiempo ahorrado probablemente se empleará en actividades útiles.
La elección de un tema que considere utilidad para Habr
Al elegir los temas, nos enfocamos en nuestra experiencia subjetiva y casos prácticos, que pasamos y probamos nosotros mismos. Por supuesto, se supone que hemos estudiado literatura de antemano y no repetiremos lo que ya se ha escrito. Y de acuerdo con las reglas de buena forma, siempre nos referimos a fuentes útiles.
Buenos temas
- Hay soluciones sobre las que los desarrolladores dicen: "No había ninguna documentación oficial sobre esto, también en Habré. Tuve que jugar ". Si la decisión en sí misma es decente, entonces el artículo será bueno.
- Algunos temas surgen del desafío global planteado por el proyecto, por ejemplo, proporcionar alta disponibilidad y CI / CD transparente. Cada paso hacia este objetivo, la migración a .Net Core, Docker, etc., se puede describir en un artículo separado. En las manifestaciones, una broma "¡en un artículo!" A menudo salta, es decir colegas como insinuando.
- Parte del tema surge cuando investigas activamente un nuevo tema. Hay una señal: si el desarrollador pasó más de 4 horas investigando en Google o leyendo otros artículos, entonces vale la pena al menos recopilar la información encontrada, o tal vez escribir algo nuevo.
- Algunos textos nacen después de leer un libro interesante, asistir a una buena conferencia o incluso como documentación interna; quiero compartir nuevos conocimientos.
Lo que es beneficioso es bueno, ahorra tiempo en el futuro para los lectores y brinda experiencia práctica, en lugar de especulaciones filosóficas sobre la paz mundial.
Malos temas
Hay muchos de ellos, pero mencionaremos algunos de ellos:
- Una repetición de todo lo que se conoce con el único propósito de indexar por palabras clave,
- Publicidad directa o indirecta de una empresa o cliente (vea con quién trabajo),
- Un artículo sobre nada o una corriente de pensamientos sin estructura.
En general, todo es malo que no beneficia al lector o no lo respeta.
Las principales etapas del trabajo sobre el texto.
Para el autor, el trabajo en los textos pasa por 6 etapas creativas:
- Establecimiento de objetivos: formular un tema, idea y plan. Para encontrar un tema, respondemos las preguntas “¿Qué novedades aprenderán los lectores de este artículo?”, “Para quién lo escribimos”, “¿Qué es exactamente lo que queremos compartir?”. También es importante para nosotros que el artículo traiga algo nuevo. Para hacer esto, miramos las palabras clave que ya se han escrito sobre este tema y si nos estamos repitiendo.
- Notas o diario de laboratorio. En el curso del trabajo en la tarea, los desarrolladores toman notas: guardan enlaces útiles, escriben anclas de recordatorio para situaciones de emergencia, para que luego puedan aplicar ingeniería inversa a las notas en texto legible. Cuando se trata del texto, solo queda releer el "diario de laboratorio", reformular algunas notas utilizando un vocabulario más o menos generalmente aceptado y luego reunirlas en un orden lógico.
Uno de nuestros autores utiliza el editor de rebajas en línea hackmd.io, donde repara sus pasos para desarrollar el tema. Esta herramienta le permite compartir texto, mostrar el progreso del artículo y, lo más importante, inventarlo con anticipación. Como resultado, obtenemos un texto en el que publicar en Habr es suficiente para agregar un corte y dar un par de pequeños trazos. Esto es conveniente para controlar la estructura y el diseño del texto.
- Organizar el texto. Escribimos los pensamientos principales y observamos su utilidad y lugar en la estructura del artículo. Se obtiene la tabla de contenido, es decir, la agrupación de texto en bloques semánticos que se pueden percibir sin siquiera leer otras secciones.
- Editamos y editamos para que un extraño "no en el tema" pueda entender más o menos el significado de lo que se dijo. Puede volver a leer al menos una vez al día y editar lo que no le gusta. La edición requiere varias iteraciones, al igual que el trabajo en el texto. En esta etapa, observamos el lenguaje y los errores: el texto no verificado se lee como si hubiera sido escrito por un niño de dos años.
- Observamos el texto a través de los ojos de otros : el artículo está siendo leído por otro desarrollador o PM que es competente en este tema. Una mirada fresca y una crítica constructiva mejoran el producto.
- Estamos preparando el texto para imprimir. Hacemos ediciones finales, pensamos en las ilustraciones, elegimos los centros apropiados, ¡e imprimimos!
La secuencia de estas etapas no es estricta. Sucede que el autor primero elabora un plan, revela cada elemento y lo detalla al nivel deseado, luego corrige el texto en varias iteraciones. Y sucede que al principio el desarrollador describe la solución para la tarea de trabajo, y ya sobre esta base nace el texto para Habr. En cualquier etapa, otros colegas pueden unirse al artículo para ayudar con una idea o consejo.
Y ahora de los planes a la acción. Es decir, al texto.
Muchas tareas: cómo encontrar tiempo para trabajar en el texto
Trabajar en textos al estilo de "posponer todas las tareas y quedarse con la cabeza" no funciona para nosotros debido al
factor del autobús . Por lo tanto, los autores se dedican gradualmente al artículo en el fondo del resto del trabajo. A menudo, el texto es un compendio de la tarea de trabajo real.
Uno de nuestros autores comparó este trabajo con las pruebas. Al principio piensas que no hay tiempo para escribir exámenes. Luego insertas esta actividad en el proceso, y resulta que hay tiempo. Los textos, como los exámenes, ayudan a comprender lo que está sucediendo. Incluso si asigna al artículo cada hora al día, funcionará. Por supuesto, si es importante para una persona.
Otro escribe estrictamente en la mañana. Lo primero es lo primero. Sabiendo que tiene mucho trabajo principal por delante, puede dedicar 20 minutos al texto desde el comienzo de la jornada laboral. En tales circunstancias, resulta escribir de manera clara, concisa y sobre el caso.
Quiero escribir un artículo sobre Habr e incluso se me ocurrió un tema. Por donde empezar
No hay nada nuevo en este problema. Stephen King, George Orwell, Edgar Allan Poe, los camaradas Strugatsky, el dúo Henry Lyon Oldie, Richard Feynman y muchos otros autores de una forma u otra dijeron:
"Si quieres comenzar algo (escribir un artículo, un libro o una carta a un amigo), pero aún no puedes hacerlo, no hay mejor momento y situación para hacerlo que ... ¡ahora mismo!"
Uno de nosotros ayuda a abrir un editor de texto y a verter una corriente de pensamientos sobre el tema allí. Lo más probable es que resulte que "todo está mal", pero se ha dado el primer paso: se ha comenzado a trabajar en el artículo.
Hay otra manera: encontrar otro empleado y contarle sobre el tema del artículo. Y para comenzar la historia con las palabras: "Bueno, en fin ...". Y tan pronto como llegaron los primeros pensamientos, gritó "¡Gracias!" huye a ti mismo y escribe con urgencia tu historia. En palabras simples, con tapetes de producción, que luego reemplaza con algo constructivo.
Y para un aperitivo, el camino desde el clásico está estrictamente bajo su responsabilidad.
Estoy escribiendo, estoy escribiendo, estoy atascado. Que hacer
Hay tres escenarios que se pueden aplicar a la situación:
- Toma una taza de té y relájate. Ciertamente no necesita forzarse cuando el texto "no va", nada bueno viene de tal superación. Esto, por cierto, no se trata solo de escribir artículos.
Pero arrojar un trabajo no vale la pena. Tan pronto como sienta que está más o menos relajado, vuelva a leer lo que está escrito, seguro que se le ocurrirá algún otro pensamiento. Dibuja un bosquejo de la estructura del texto. Enviar texto a un colega.
Haga algo alrededor del texto, pero no extorsione palabras. Entonces, los pensamientos mismos comenzarán a pulularse y solo será necesario agarrarlos por la cola, y ponerlos, tal como están, en papel / en un editor de texto. - Rastrille todo el material en el lanzamiento del artículo "tal cual". En este punto, debe terminar de escribir los pensamientos principales o concluir lógicamente con la conclusión de que los hay. Si esto se ve bien, entonces el resto puede pasar al siguiente artículo.
- Un estupor profundo y prolongado puede significar que el tema no está cerca y que no necesita escribir sobre él. Es mejor cortar estos temas en la primera etapa. O consultar con un colega.
Si tiene otras opciones, cómo salir de un estupor creativo: comparta en los comentarios.
En conclusión
Escribir No escuches a nadie y escribe. Esto es bueno Y escribirás bien, en general excelente. Y luego la comunidad de habro se volverá inteligente, jurará y se enriquecerá.
Finalmente, enlaces útiles a este tema:
Comparte tus recetas en los comentarios, ¡espera!