Jan 01, 1970
Desarrolladores de software, ¿por qué no han comenzado todavía a escribir técnicas? by@theankurtyagi
1,150
Desarrolladores de software, ¿por qué no han comenzado todavía a escribir técnicas?
Enseñar y escribir sobre cualquier cosa es la mejor manera de aprender sobre ello, y es una tarea fácil para comenzar un nuevo estilo de vida.
Un blog es una pieza útil por muchas razones, no sólo para usted sino también para otros desarrolladores de software en tecnología.
La redacción técnica ayuda a un desarrollador de software a compartir sus conocimientos/experiencias técnicas con otros desarrolladores de software en ingeniería de software.
La escritura técnica es una disciplina de escritura que implica comunicar información compleja a quienes la necesitan para realizar una determinada tarea o lograr un determinado objetivo. Debido a esto, la redacción técnica a menudo se define como " simplificar lo complejo ".
También mejora tu comprensión del tema sobre el que estás escribiendo y muestra claramente tu experiencia técnica.
Lo más singular de la redacción técnica no solo es que has podido generar excelentes oportunidades futuras (un trabajo remoto en tecnología, un contrato de redacción independiente o una oportunidad de publicación como invitado en el sitio web de una gran empresa de tecnología, etc.), sino que también puede ayudarte a construir una presencia en línea que eventualmente lo ayudará en su carrera como desarrollador de software.
A veces, vuelvo y leo las publicaciones de mi blog cuando busco información sobre un tema específico.
Si hizo algo interesante en su carrera de ingeniería de software pero se lo guarda para usted, se está perdiendo un gran generador de oportunidades.
Empiece a escribir y es una forma eficaz de promocionar sus ideas en Internet.
“Escribe el blog que desearías encontrar cuando… https://t.co/PcXR0fL9QF
– Ankur💻🎧💪 (@TheAnkurTyagi) 3 de octubre de 2023
Además, si le gusta ayudar a otros a aprender, disfruta ser parte de proyectos de código abierto y mostrarles a otros cómo unirse, o encuentra satisfacción al explicar ideas complejas de manera fácil de entender a través de su escritura, entonces la escritura técnica es una excelente opción. tú.
En este artículo, mi objetivo es explicar cómo la programación y la escritura pueden fusionarse para mejorar nuestras habilidades de desarrollador. ¡Sí, escribiendo! Realmente creo que todos poseemos algún nivel de capacidad de escritura. Estoy aquí para brindarle sugerencias, consejos y ejemplos de escritura que lo ayudarán a convertirse en un desarrollador y comunicador más competente.
¿Qué es la redacción técnica?
La redacción técnica consiste en dar instrucciones claras y detalladas para ayudar a los usuarios, compañeros desarrolladores o administradores a comprender un producto técnico o una habilidad o idea técnica.
Un redactor técnico es alguien que crea estos tutoriales y documentación técnica.
La redacción técnica podría ser:
- Cómo hacer guías de usuario o integración entre dos SaaS técnicos
- Artículos de soporte en línea
- Informes técnicos que presentan información sobre un tema específico, a menudo después de realizar investigaciones o experimentos. Son comunes en los campos científicos y de ingeniería.
- Propuestas técnicas : estos documentos describen un plan, idea o proyecto de forma clara y persuasiva. Se utilizan para buscar aprobación, financiación o colaboración.
- Metamateriales internos para programadores y documentación API para desarrolladores.
En esencia, un escritor técnico transmite detalles técnicos de una manera que permite al lector aplicar esa información de manera efectiva para un propósito específico.
Si está comenzando en la redacción técnica e intenta escribir sobre desarrollo/programación de software o lo que ha aprendido en tecnología, pero aún no ha escrito su primer blog, encontrará la mayor cantidad de valor en las dos primeras secciones de esta publicación de blog donde hablo sobre cómo comenzar como escritor técnico o bloguero y cómo escalar tu blog.
El resto del blog le resultará útil para completar las lagunas de conocimiento que necesitará para tener éxito como escritor desarrollador de software, prosperar en el lugar de trabajo y avanzar en su carrera.
“Si tienes un sueño, puedes pasar toda la vida estudiándolo, planificándolo y preparándote para lograrlo. Lo que deberías hacer es empezar”.
—Drew Houston
¿La escritura está en todas partes?
Los dos principales recursos en línea que la gente usa para aprender a codificar son la documentación técnica y Stack Overflow, y los blogs completan los tres primeros.
La tripleta de permitir que las personas aprendan por sí mismas sobre tecnología incluye documentación clara, una comunidad vibrante que ofrece soluciones y publicaciones frecuentes.
Los desarrolladores valoran una amplia gama de fuentes adicionales, incluidos vídeos instructivos, tutoriales escritos, libros y foros; reúnen las fuentes y formatos que mejor se adaptan a su estilo de aprendizaje.
Ser capaz de expresar sus ideas con claridad dentro del equipo y en línea es una habilidad valiosa, ya que muchos desarrolladores la encuentran desafiante. Solo piense en cuánta escritura escribe todos los días que no implique escribir código. Esta habilidad es una superpotencia.
Participa en diversas formas de escritura, como chats de Slack, correos electrónicos, documentos internos para desarrolladores, borradores RCA, archivos Léame, comentarios de código, mensajes de confirmación de Git, solicitudes de extracción, comentarios de revisión de código, comentarios sobre el desempeño anual, notas de reuniones y más.
Dominar la escritura es crucial para los desarrolladores de software. Las habilidades de escritura inadecuadas pueden impedir su avance profesional más allá de cierto punto. Muchos ingenieros se dan cuenta más adelante en sus carreras de que “las habilidades interpersonales son tan importantes como el código”.
Jóvenes: su carrera de ingeniería de software mejorará significativamente y obtendrán mejores oportunidades futuras en tecnología si comienzan a escribir durante 30 minutos cada día y publican 2 o 3 blogs en línea cada mes, pero muy pocos desarrolladores pueden hacer esto en el transcurso del tiempo. a largo plazo. https://t.co/damIJ5gXys
– Ankur💻🎧💪 (@TheAnkurTyagi) 4 de octubre de 2023
Por qué escribir es crucial para los desarrolladores
JavaScript, TypeScript, PHP, Go, Java: existen muchos lenguajes de programación diferentes y es posible que incluso domines muchos de ellos.
A medida que nos esforzamos por producir código de mayor calidad en nuestras carreras tecnológicas, la capacidad de escribir y comunicarse de manera efectiva en el lenguaje cotidiano se convierte en una habilidad crucial, que puede subestimarse en el campo de la ingeniería de software.
La ingeniería de software no se trata sólo de código. Se trata de personas + código.
Cómo me convierto en un mejor escritor como ingeniero de software
La forma en que los ingenieros articulan sus pensamientos sobre el código puede ser tan crítica como el código mismo. Independientemente de su postura sobre este asunto, podemos reconocer unánimemente que nuestras palabras tienen el poder de mejorar o dificultar la eficacia del código.
Escribir puede ayudarte a aumentar tu superficie de suerte.
L = D * T, donde L es suerte, D es hacer y T es decir.
– Jason C. Roberts
6 principales beneficios de la redacción técnica
Le ayuda a comprender conceptos en un nivel más profundo.
Debes investigar los conceptos que estás explicando, lo que te expone a diferentes ideas, aplicaciones y trampas.
Los conceptos se graban mejor en tu cerebro cuando se los explicas a los demás.
Al estructurar y presentar información para otros, a menudo descubre lagunas en su conocimiento. Como resultado, también te ayuda a progresar más rápido en tu carrera de desarrollador.
Los escritores técnicos aprenden toda la vida porque con cada nuevo blog técnico que investigues y escribas, te convertirás en un experto en ese tema.
La escritura también fomenta una comprensión más profunda de la empatía del usuario. Le pide que se concentre más en las perspectivas y sentimientos de los lectores o usuarios del producto, en lugar de confiar únicamente en su punto de vista.
Aquí hay algunos beneficios adicionales:
Además, puede generar ingresos como redactor técnico contribuyendo a varias organizaciones. Echa un vistazo a estas increíbles empresas que pagan a escritores técnicos .
En la universidad, estudié dando clases particulares a otros en un albergue
Explicar algo, o incluso pretender hacerlo, te obliga a organizar tu conocimiento de manera coherente, exponiendo lagunas en tu conocimiento y reforzando las partes que sí conoces.
La mejor manera de aprender es enseñar y escribir es un gran activo para todo desarrollador.
En lugar de simplemente prestarle atención, las personas y las empresas se la corresponden. Cuando escribes una publicación de blog técnica, recibes comentarios instantáneos. Su redacción técnica también ayuda a correr la voz, abriendo puertas a oportunidades aún más interesantes.
También existe una carrera lucrativa en redacción técnica si te gusta y prácticamente todo lo que escribo en mi blog estos días son conceptos que estoy tratando de comprender mejor. Si no puedo explicarlo por escrito, no lo entiendo adecuadamente.
¿Cuáles son los ejemplos de redacción técnica?
Como redactor técnico, su función consiste en traducir información técnica compleja a un lenguaje accesible y fácil de usar. La redacción técnica abarca varias formas, incluida la creación de tutoriales paso a paso y guías completas.
El objetivo principal es facilitar la comprensión de cualquier aspecto técnico de un producto o servicio, ya sea entre los miembros del equipo interno o los usuarios finales.
Teniendo esto en cuenta, los siguientes ejemplos de redacción técnica deberían proporcionarle una comprensión clara.
Este es un ejemplo muy simple de revisión de supertokens y de cómo los "supertokens" son una buena autenticación de usuario.
Este es un muy buen ejemplo de cómo se puede crear un tutorial junto con la creación de una aplicación. En este blog, compartí una guía paso a paso para crear una tienda de comercio electrónico de Medusa, que es una alternativa de código abierto a Shopify.
En esta guía, compartí cómo implementar LLM con MindDB y OpenAI.
Un tutorial completo sobre cómo puedes migrar tu base de datos de Supabase a HarperDB
5- Documentación del producto
La documentación del producto incluye instrucciones sobre cómo utilizar e integrar eficazmente otras herramientas para desarrolladores.
Escribir documentos de producto requiere buenas habilidades de redacción técnica y conocimientos organizativos. Estos son solo un par de ejemplos que se incluyen en la redacción técnica que requieren altos niveles de habilidad en investigación, visualización y la capacidad de conectarse con una amplia variedad de audiencias.
Consejo: “Pregúntese: '¿Capta el título el interés del lector?' Si es así, probablemente profundizarán en la introducción y luego decidirán: "¿Vale la pena invertir mi tiempo en todo este artículo?" Un error frecuente que observo a menudo en los posts técnicos es el exceso de introducción o, por el contrario, muy poca.
Un párrafo redactado con precisión puede sentar las bases para una publicación de blog técnica.
¿Cómo empiezo como redactor técnico?
Con diferencia, la pregunta más común que recibo sobre “redacción técnica o blogs” es cómo empezar.
En la vida, parece que el mayor obstáculo para hacer algo y convertirse en lo que uno quiere es empezar.
El peor enemigo es la “inseguridad”. pic.twitter.com/fw1691QRSY
– Ankur💻🎧💪 (@TheAnkurTyagi) 10 de agosto de 2023
Ya sea comenzar un nuevo régimen de ejercicios, entrenar para un maratón, iniciar un negocio, escribir un libro o, más específicamente, en este caso, escribir, la parte más difícil siempre es comenzar.
Es fácil (y tentador) perder innumerables horas debatiendo qué debería hacer.
Es mucho más fácil “leer”, “leer” y “estudiar” que empezar a “escribir”.
Pero el secreto es que sólo necesitas dar un paso a la vez.
Construya al menos un activo compuesto en su carrera de ingeniería de software
– Iniciar un blog – Iniciar un boletín – Comenzar a grabar videos de YouTube – Iniciar un podcast – Comenzar a construir redes
Construir, publicar y repetir
Oportunidades futuras te esperan en Internet
– Kap.ts (@Kaperskyguru) 17 de febrero de 2023
Y mira a tu alrededor; la mayoría de los desarrolladores de ingeniería de software no escriben código las 24 horas del día, los 7 días de la semana; la mayoría de nosotros dedicamos mucho tiempo a hacer otras cosas todos los días.
Eso incluye:
- Demostrar una nueva funcionalidad en todo el equipo dentro de una empresa o clientes.
- Documentar una característica nueva o antigua de su producto.
- Actualización de un ticket JIRA relacionado.
- Crear trabajo pendiente para respaldar esa nueva característica.
Por supuesto, siempre hay tiempo para ir al baño/almorzar y también para navegar por Twitter 😉
así que no pienses demasiado, solo comienza
"Escribir es como aprender a jugar baloncesto".
– David Perell
Para ser un escritor exitoso y encontrar oportunidades, debes tener 3 habilidades.
- Codificación
- Escribiendo
- Inglés
Sí, incluso antes de comenzar a escribir, primero debes comprender el inglés, incluidos sus tiempos verbales, ortografía y gramática básica.
Sus lectores no quieren leer un artículo plagado de errores gramaticales y mala elección de palabras.
En la industria tecnológica, el inglés se ha convertido en el idioma de facto para la comunicación entre desarrolladores de software, ingenieros y otros profesionales tecnológicos en todo el mundo. Es el lenguaje utilizado para la documentación, los lenguajes de programación y las herramientas utilizadas para el desarrollo.
Aprenda a comunicar ideas de forma sencilla y clara
Saber cómo implementar una característica técnica no implica necesariamente que puedas explicar el proceso a otros.
Ser un buen profesor requiere empatía y habilidad para transmitir información de una manera adecuada a su público objetivo.
No entiendes algo si no puedes explicárselo a un niño de seis años.
Einstein, Alberto
No existe una estrategia perfecta para convertirse en un escritor excepcional. Quizás te preguntes, entonces, por qué estoy discutiendo este tema. Es porque es crucial abordar esto desde el principio.
“No busques una estrategia; busca tu voz única al escribir y construye tu estilo”.
El único truco de escritura que debes conocer.
Menos tecnología es más, trabajo con React el 90% del tiempo.
Si estás escribiendo por primera vez, tómate más tiempo para resolverlo.
Permítete escribir mal.
Deja de prepararte y empieza a actuar.
Cómo convertirse en un escritor destacado en la era de la IA:
Antes de escribir tu próxima publicación de blog, pídele a ChatGPT que escriba una sobre el tema y te muestre qué cosas genéricas ya están disponibles en Internet para que puedas evitar decir eso y escribir lo que es importante y exclusivo para la audiencia.
– Ankur💻🎧💪 (@TheAnkurTyagi) 16 de febrero de 2023
Para comprender a su audiencia, haga estas preguntas antes de comenzar a escribir.
- ¿Quiénes son tus lectores?
- ¿Qué buscan en Google o a qué problema se enfrentan?
- ¿Qué blogs están leyendo actualmente?
- ¿Cómo estarán leyendo?
Cómo idear ideas para publicaciones de blog
Escribe el artículo que te habría impedido pasar horas buscando en Google y rascándote la cabeza.
Siempre que aprenda algo nuevo, escriba sobre cómo lo aprendió y qué aprendió.
Escribe una historia sobre tu campo, interés o profesión.
Seleccione una publicación de blog de su blogger favorito que le haya resultado agradable y explore el mismo tema desde una nueva perspectiva, o aborde un tema diferente desde un ángulo similar.
Escribe la publicación de blog que desearías haber encontrado cuando buscaste algo en Google.
– Ankur💻🎧💪 (@TheAnkurTyagi) 20 de marzo de 2023
Nota: si hizo algo interesante en su carrera de ingeniería de software pero se lo guarda para usted, se está perdiendo un gran generador de oportunidades.
La mejor manera de navegar en Internet es escribiendo cuando se trata de promover sus ideas de manera efectiva.
Existe un punto ideal para escribir publicaciones técnicas y tutoriales. Escriba para el profesional que aún no ha tenido tiempo de aprender eso y vincúlelo a cosas que ya sabe. Por ejemplo, explicar una técnica JS moderna a alguien que conozca jQuery.
- Rachel Andrew (@rachelandrew) 20 de febrero de 2019
Conclusión
La escritura es una tarea fácil para la mayoría de los desarrolladores expertos.
Si cree que puede aprender mucho en tecnología leyendo una publicación de blog; Intente escribir uno esta semana.
– Ankur💻🎧💪 (@TheAnkurTyagi) 2 de octubre de 2023
La razón por la que todo desarrollador debería escribir una publicación de blog sobre lo que aprende en ingeniería de software es que escribir les hace descubrir que quizás no entienden algo tan bien como pensaban.
Enseñar y escribir sobre cualquier cosa es la mejor manera de aprender sobre ello, y es una tarea fácil para comenzar un nuevo estilo de vida porque ya tienes experiencia de primera mano, así que todo lo que tienes que hacer es presentarte y escribir una publicación de blog 12. este año, evalúe los resultados y planifique su próximo paso.
“Lee para juntar los puntos, escribe para conectarlos.”—David Perell
La conclusión es que perfeccionar sus habilidades de escritura y poner un poco de esfuerzo adicional en su escritura puede mejorar genuinamente sus habilidades como desarrollador. Estos consejos pueden resultarle útiles para colaborar con otros desarrolladores, mantener su trabajo, crear su contenido cuando sea necesario o incluso redactar propuestas de proyectos, entre otras tareas.
Recursos de redacción técnica
- Consejos para la redacción técnica (una publicación de blog bien escrita de Chris de CSS Tricks)
- Recursos-de-escritura técnica (un repositorio de GitHub de Cynthia Peter )
- Guía de redacción técnica de Google
- Fundamentos de redacción técnica
- Escribe los documentos
También publicadoaquí .
L O A D I N G
. . . comments & more!
. . . comments & more!
