Describir
- Describir
- Recursos
- ¿Qué es la escritura técnica?
- Artículos
- Libros
- Cursos
- YouTube
- Comunidades
- Herramientas de escritura
- Herramientas de documentación
- Quien paga escritores técnicos
- Proyectos de código abierto
- Proyectos de código abierto/programas Los escritores técnicos pueden contribuir a
- Blogs a seguir para un contenido de escritura increíble
- Preparación para entrevistas de escritura técnica
- Sitios para publicar artículos
- Pasos de trabajo para roles de escritura técnica
Recursos
Este repositorio contiene diferentes recursos de escritura técnica que se ha reunido en todo Internet.
¿Qué es la escritura técnica?
La escritura técnica es una forma de comunicación que ayuda a los usuarios a resolver problemas con la tecnología. Es el proceso de crear contenido claro, conciso e informativo diseñado para transmitir información compleja de una manera que sea fácilmente entendida por la audiencia prevista.
A menudo implica escribir manuales, guías, informes y documentación que explicen conceptos técnicos, procesos o productos.
Artículos
- Escritura técnica más allá de BlogPosts
- Cómo comenzar con la escritura técnica
- Cómo convertirse en escritor técnico
- Escritura técnica para principiantes: una guía AZ para los conceptos básicos de blogs tecnológicos
- Escritura técnica: ¿Qué y cómo?
- Cómo aprender escritura técnica gratis
- Comenzando con la escritura técnica
- Asesoramiento para la escritura técnica
- Cómo escribir contenido que los lectores leerán en función de los aprendizajes de la psicología del usuario
- Cómo crear una cartera de escritura técnica
- Consejos de escritura para desarrolladores de software: cómo convertirse en un mejor escritor tecnológico
- 11 mejores prácticas para escribir documentación de API
- Escritura técnica frente a blogs técnicos
Libros
Escribiendo bien ~ Julian Shapiro
Escritura técnica, simplificado ~ Nell Johnson
Escritura para desarrolladores de Sotware ~ Philip Kiely
Escritura técnica para tontos ~ Sheryl Lindsell-Roberts
Docs para desarrolladores: una guía de campo de ingeniero para la escritura técnica ~ Jared Bhatti
Escritura técnica moderna: una introducción a la documentación del software ~ Andrew Etter
Todo el mundo escribe: Tu guía de referencia para crear contenido ridículamente bueno ~ Ann Handley
Al escribir bien ~ William Zinsser
Comunicación técnica ~ Mike Markel
Cursos
- Cursos de escritura técnica para ingenieros
- Escritura técnica: cómo escribir documentación de software
- Learn API Escritura técnica: JSON y XML para escritores
- El arte de la documentación de la API
- API de documentación: una guía para escritores e ingenieros técnicos
- Curso de certificación de escritores técnicos ~ Se creó un curso de certificación de escritores técnicos para aspirantes a escritores técnicos o personas que desean repasar sus habilidades de escritura técnica.
- SEO para desarrolladores ~ SEO para desarrolladores es un curso gratuito de 2 semanas que ayuda a las personas a descubrir su blog de tecnología o proyecto paralelo de manera sistemática
- Documentación API para desarrolladores ~ Una guía práctica para crear y mantener la documentación de la API.
YouTube
- Doctorhelptv
- HQ de escritor técnico
- Amruta Ranade
- William Smith
- Cómo convertirse en escritor técnico | Habilidades y crecimiento profesional
Comunidades
Las comunidades pueden proporcionar valiosas oportunidades de aprendizaje, crecimiento, tutoría y avance profesional. Conectarse con personas de interés similar es una de las razones por las cuales las personas se unen a las comunidades. Estas son algunas de las comunidades a las que pueden unirse los escritores técnicos:
- Escribe los documentos
- Docnexo
- Hackmamba
- Comunidad de escritura técnica de LinkedIn
- Comunidad de escritores globales
- Grupo de documentación de API
- Foro de escritores técnicos
- Hashnode
- La comunidad de Good Docs Project Project
- TechWriters.dev
- R/Escritura técnica
Herramientas de escritura
- Canva ~ Canva es una plataforma de diseño gráfico, que se utiliza para crear gráficos de redes sociales, presentaciones, carteles, documentos y otro contenido visual.
- Eliminar BG ~ Una herramientas que se utiliza para eliminar los fondos de la imagen.
- Markdown ~ Markdown es una herramienta de conversión de texto a HTML para escritores web.
- ASCIIDOC ~ ASCIIDOC es un lenguaje de marcado liviano y semántico diseñado principalmente para escribir documentación técnica.
- Denigma ~ Denigma es una herramienta que explica el código en inglés comprensible.
- Grammarly ~ Grammarly es un asistente de mecanografía que revisa la ortografía, la gramática, la puntuación, la claridad, el compromiso y los errores de entrega.
- Aplicación Hemingway ~ La aplicación Hemingway es una aplicación web y de escritorio que puede mejorar su estilo de escritura y retocar su contenido.
- Quillbot ai ~ Quillbot Ai es una herramienta de escritura multipropósito que puede ayudar a mejorar su estilo de escritura. Algunos de sus productos son parafrasherer, checker de gramática, verificador de plagio, coguionista, resumen, generador de citas y contador de palabras.
- Noción ~ La noción es un espacio de trabajo todo en uno para sus notas, tareas, wikis y bases de datos. Es una herramienta que puede usar para organizar sus pensamientos, proyectos e información.
- Dropbox Paper ~ Dropbox Paper es un espacio de trabajo de documentos en línea, donde puede organizar y mostrar texto, medios y archivos todo en un solo lugar.
- GoFullPage - Captura de pantalla de página completa ~ Una extensión de Chrome TAHT le permite tomar una captura de pantalla de la página completa de su ventana actual del navegador.
- Carbon ~ Carbon es la forma más fácil de crear y compartir hermosas imágenes de su código fuente.
- ISITWP ~ ISITWP Headline Analyzer Tool lo ayuda a escribir titulares que impulsan el tráfico, las acciones y el lugar mejor en los resultados de búsqueda.
- Capitalizar mi título ~ facilitando la capitalización del título para su escritura
- WordTune ~ Wordtune convierte el texto en mensajes concisos, atractivos y bien escritos.
- Analizador de cabecera ~ Escribir titulares que impulsan el tráfico, las acciones y los resultados de búsqueda.
- Generador de títulos ~ Genere excelentes títulos para artículos y publicaciones de blog.
- SEO Writing Assistant ~ Un editor de escritura inteligente que lo ayuda a optimizar su copia para el compromiso y el SEO.
- Hackmd ~ Un editor de Markdown colaborativo para compartir sus artículos y recibir comentarios de otros.
- Copyscape ~ Checker de plagio
- Markdoc ~ Un superset of Markdown para crear sitios web de documentación personalizados. Fue creado por Stripe e hecho de código abierto en mayo de 2022.
- Wordtune ~ Wordtune es un compañero de escritura con alimentación que reformula sus oraciones para decir exactamente lo que quiere decir a través de una escritura clara, convincente y auténtica.
Herramientas de documentación
- Gitbook ~ Una plataforma de documentación moderna donde los equipos pueden documentar todo, desde productos hasta bases de conocimiento internos y API.
- Lea los documentos ~ Una plataforma de código abierto para alojamiento, construcción y documentación de versiones.
- Docusaurus ~ Un generador de sitios estático que facilita la creación de sitios web de proyectos de código abierto.
- Sphinx ~ Un generador de documentación que convierte los archivos reestructurados en sitios web HTML y otros formatos.
- MKDOCS ~ Un generador de sitios rápido, simple y estático que está orientado a la documentación del proyecto de construcción.
- Swagger ~ Un conjunto de herramientas para la documentación de API, que incluye Swagger Editor, Swagger UI y Swagger Codegen.
- Postman ~ Una plataforma de colaboración para el desarrollo de API que facilita la creación, compartir, probar y documentar API.
- Slate ~ Un generador de sitio estático diseñado específicamente para la documentación de API.
- Redoc ~ Una herramienta de código abierto para generar documentación de API a partir de definiciones de OpenAPI (anteriormente Swagger).
- DOCZ ~ Una herramienta para escribir documentación para sus componentes React con MDX y soporte de relieve en vivo.
- Jekyll ~ Un generador de sitios estático que transforma el texto sin formato en sitios web y blogs estáticos.
- Hugo ~ Un generador de sitio estático rápido y flexible escrito en Go.
- Antora ~ Un generador de sitios de documentación para crear portales de documentación y sitios web de documentación técnica.
- VuePress ~ Un generador de sitios estático alimentado por Vue.js.
- ASCIIDOCTOR ~ Un procesador de texto rápido y una cadena de herramientas de publicación para convertir el contenido de ASCIIDOC en HTML5, Docbook, PDF y otros formatos.
- Confluence ~ Una herramienta de colaboración utilizada para ayudar a los equipos a colaborar y compartir el conocimiento de manera eficiente.
- Madcap Flare ~ Una herramienta integral de autoría técnica y publicación para crear contenido para diversos salidas.
Quien paga escritores técnicos
Escribir contenido técnico para organizaciones y publicaciones es una excelente manera de obtener ingresos adicionales. De esta manera, aprendes mucho, luego comparte tus conocimientos y te pagan. Consulte esta lista compilada para organizaciones que pagan escritores técnicos.
- Programa de escritores comunitarios
- Reciba el pago de escribir por estos más de 45 sitios web
- Publicaciones que le pagan para escribir artículos técnicos
Proyectos de código abierto
Contribuir al código abierto puede ser una forma gratificante de aprender, enseñar y desarrollar experiencia en casi cualquier habilidad que pueda imaginar. Mucha Peole contribuye al código abierto por diferentes razones y la vital que está mejorando el conjunto de habilidades.
Aquí hay algunos artículos para ayudarlo a comprender cómo contribuir a los proyectos de código abierto.
- Código abierto para escritores técnicos
- La Guía de escritores técnicos para contribuir a proyectos de código abierto
- Cómo contribuir a la fuente abierta como escritor técnico
- 4 consejos para convertirse en escritor técnico con contribuciones de código abierto
- Comenzando con el código abierto como escritor técnico
Proyectos de código abierto/programas Los escritores técnicos pueden contribuir a
- CodeCademy Docs ~ Docs es una colección de documentación de código impulsada por la comunidad para lenguajes y marcos de programación populares.
- El Proyecto Good Docs ~ El Proyecto Good Docs es una comunidad que trabaja juntos para crear las plantillas, herramientas y recursos para mejorar la calidad general de la documentación en OSS y más allá.
- La temporada de Docs de Google ~ Temporada de Docs brinda apoyo para proyectos de código abierto para mejorar su documentación y brinda a los escritores técnicos profesionales la oportunidad de obtener experiencia en código abierto.
- Hacktoberfest ~ Hacktoberfest es un evento anual para alentar a las personas a contribuir al código abierto en octubre.
- El proyecto de documentación de GNOME
Blogs a seguir para un contenido de escritura increíble
- TechWriters Hub
- Kesi Parker
- Idratherbewriting
- Todo escritura técnica
- Writetech Hub
- Hackmamba
Preparación para entrevistas de escritura técnica
Hay varios consejos que pueden ayudarlo a conseguir una entrevista, pero algunos de los importantes tienen un currículum bien personalizado y cartas de presentación. Consulte estas plantillas y consejos de cartas de presentación para ayudarlo a conseguir su próxima entrevista:
- Plantilla de carta de presentación para su próximo trabajo
- Cómo escribir una carta de presentación atractiva
- Cómo escribir un currículum de escritor técnico [+ejemplos]
- Mejor ejemplo de carta de presentación de escritor técnico y formato
Aquí hay algunos recursos para escribir preguntas técnicas de la entrevista para ayudarlo a prepararse para su próxima entrevista.
- 12 preguntas y respuestas de la entrevista de escritor técnico
- Preguntas de la entrevista del escritor técnico de Google
- Entrevista de trabajo de escritura técnica
Sitios para publicar artículos
- Hashnode ~ Hashnode es una plataforma de blogs de desarrolladores gratuito para ayudarlo a compartir sus ideas con personas en tecnología, desarrolladores e ingenieros.
- Medium ~ Medium es una plataforma de publicación social con muchos usuarios y puede publicar diversos contenidos e ideas.
- Dev.to ~ dev.to es donde los programadores comparten ideas y se ayudan mutuamente a crecer. Es una comunidad en línea para compartir y descubrir grandes ideas.
- Mirror.xyz ~ Mirror.xyz es una plataforma de publicación para escritores que aprovecha la tecnología de criptomonedas y blockchain.
- Freecodecamp ~ FreecodeCamp es una organización sin fines de lucro que consiste en una plataforma web de aprendizaje interactiva, un foro comunitario en línea, salas de chat, publicaciones en línea y organizaciones locales que tienen la intención de hacer que el desarrollo web de aprendizaje sea accesible para cualquier persona.
Pasos de trabajo para roles de escritura técnica
Hecho con ❤️ por Damilola Ezekiel
