Irrumpir en la redacción técnica: por dónde empezar (a partir de una formación en programación)

Actualmente estoy en el proceso de expandir mi empresa de codificación y desarrollo web a redacción más técnica y periodismo tecnológico independiente. Aunque mi experiencia es principalmente en tecnología, durante la escuela secundaria y la universidad puse algunos cursos AP y de escritura avanzada en mi haber y me he familiarizado bastante con la correspondencia comercial, y aunque he hecho algunos conjuntos de instrucciones básicas para clientes, Nunca he tenido un puesto de medio tiempo o de tiempo completo solo para escribir.

Por el momento he estado buscando sitios de carreras y contactando a mi red de contactos, sin embargo, aparte de esas medidas, ¿hay algo más que deba hacer? Por ejemplo, aunque tengo un blog que contiene artículos que he hecho, ¿debo armar también un portafolio de propuestas simuladas y correspondencia para mostrar mi conocimiento?

Muchas gracias de antemano por cualquier sugerencia,

Me parece que estás más inclinado hacia el periodismo tecnológico freelance que a la escritura tecnológica. Los considero campos bastante diferentes, y el camino en ellos no será el mismo.
@Lynn, te califiqué con un +1 porque me leíste la mente, ya que también estoy buscando hacer un poco de periodismo tecnológico, sin embargo, decidí mantener esta pregunta sobre redacción técnica porque, si bien me interesa el periodismo, hacer más de la redacción de la documentación está alineada con mi empresa y los servicios que ya ofrezco al cliente.
"... Puse algunos cursos AP y de escritura avanzada en mi haber..." ¿Qué es AP?
Colocación avanzada: básicamente cursos de nivel universitario ofrecidos a estudiantes de secundaria

Respuestas (4)

Hay diferentes tipos de escritura técnica, que difieren en la parte "técnica". El lugar lógico para que comience, si tiene experiencia en programación como la mía, sería con la documentación orientada al programador: API, SDK y los tutoriales y guías que los acompañan.

Si alguno de sus trabajos actuales (programación) pudiera beneficiarse de la documentación externa (interfaz) o interna (diseño, arquitectura), podría comenzar allí para desarrollar sus habilidades y su cartera (y tal vez su primer concierto). De lo contrario, en lugar de hacer un trabajo simulado para mostrar lo que puede hacer, ¿por qué no hacer un trabajo real para el proyecto de código abierto de su elección? Eso también puede ayudarlo con la creación de redes; cuando contribuyes con documentación valiosa al Proyecto Lo que sea, entonces (1) tus cosas se ven y (2) las otras personas que trabajan en el Proyecto Lo que sea podrían ayudarte a encontrar conciertos pagados.

También puede ir por la ruta de la asociación profesional. STC (Society for Technical Communicators) es la común, pero es una base amplia: encontrará algunos escritores de programación allí, pero también un grupo de personas que documentan interfaces de usuario, hardware y, sorpresa :-), no productos de software como dispositivos médicos y de ingeniería. Así que es un grupo amplio, y su profundidad depende de la gente de su capítulo local. Di una charla sobre la documentación de API en una conferencia regional de STC hace un tiempo y fue el único tema relacionado con la programación en el expediente; sin embargo, unos años después en la conferencia nacional hubo más opciones. Varía. Actualmente no soy miembro de STC, por lo que no tengo el sentido actual. Encontré más valor en los SIG de documentación de ACM e IEEE, aunque también dejé que caduquen esas membresías. (Perdón, simplemente perezoso, supongo. :-) )

Irrumpir en cualquier campo nuevo tiene dos partes clave: demostrar buenas habilidades y encontrar a las personas adecuadas para demostrárselas. Si puede hacerlo fácilmente en su posición actual, entonces tiene una ventaja; ya conoces a la gente. Si no, tienes que construir un cuerpo de trabajo y hacer algunas redes.

¡Muchas gracias por la respuesta! Centrarse en las API es algo que no puedo creer que no haya pensado antes porque con todo el software de código abierto que uso para proyectos de clientes, ni siquiera puedo contar cuántas veces he tratado con proyectos con documentación incompleta o limitada. así que definitivamente voy a prestar más atención a los proyectos de código abierto en términos de ser un escritor de documentación ya que cuando se trata de código, mi plato ya está lleno.
No me gusta la ACM , y dejé que mi membresía caducara tan pronto como ya no necesitaba asistir a las grandes conferencias de la ACM. El IEEE es un poco mejor. Me gusta el aspecto del STC, aunque no soy un escritor de tecnología, hasta ahora solo me suscribo a su blog, Intercom .

En base a tu experiencia y habilidades lingüísticas, te recomiendo estudiar estos dos libros:

Luego, aprende a usar Git y Github. En Github , encuentre un proyecto de código abierto que esté cerca de su área de interés. Voluntario para escribir. Aprenderá habilidades críticas para trabajar con equipos de desarrollo de software. Aplicará el conocimiento que adquiera al leer esos dos libros y comenzará a crear una carpeta de ejemplos de redacción técnica. (Sea abierto sobre sus objetivos. Alguien en el equipo podría contratarlo en algún momento de su carrera).

Dependiendo de dónde viva, debe unirse al STC e ir a las reuniones de Write the Docs . Aproveche esta oportunidad para hacer más conexiones, adquirir más habilidades y aprender sobre los empleadores locales.

En cualquier caso, si internaliza el contenido de estos dos libros, crea una carpeta de ejemplos relevantes y establece contactos, estará en una excelente posición para trabajar como escritor técnico. ¡Buena suerte!

Es posible que encuentre que la escritura técnica tiene un conjunto de reglas más limitado que la mayoría de las otras áreas de la escritura. La escritura tiene que ser extremadamente minimalista y simple. Hay menos espacio para cualquier tipo de creatividad verbal que en el periodismo. La escritura técnica no se trata de expresión personal, se trata de claridad y simplicidad.

Podría comenzar leyendo una guía de estilo de escritura técnica como ¡Léame primero! Una guía de estilo para la industria informática . Luego escribe un pequeño manual que siga las reglas descritas en la guía de estilo. La habilidad de memorizar una guía de estilo es probablemente la habilidad más importante para un escritor técnico.

Esta respuesta parece presuponer que el autor de la pregunta solo está familiarizado con la escritura creativa o la ficción, pero eso en la pregunta original en absoluto. ¿O me estoy perdiendo el punto?

Puede comenzar a escribir y hacer videos sobre consejos y guía de programación básica. Hay muchos programadores nuevos que buscan tales temas.

Bienvenido a Writer's, ¿puede gastar en su respuesta?