Entrevistas Efectivas para Documentación de Software
Clase 4 de 20 • Curso de Introducción al Technical Writing y Documentación de Código
Contenido del curso
Las opciones para recolectar información son un poco limitadas cuando se trata de documentar bloques de código o proyectos de software. Uno de los caminos más seguros es acercarte a platicar con el equipo de programación porque, además de ser especialistas en el tema, son quienes colaborarán contigo en la recolección de información.
Recordemos que tú eres la persona responsable de interpretar y transferir la información recabada a otras personas. Es por ello que primero debes de conocer lo que sabe el equipo de programación. Este punto también es otro de los pilares del technical writer, así que tienes que pulir tus habilidades para interactuar con personas de este nivel.
Imagen de fancycrave1 en Pixabay
A continuación, te compartiré herramientas y recomendaciones a considerar antes y durante la recopilación de información para que esta sea todo un éxito.
Herramientas previas para recopilar información 🛠
Una vez que ubiques a las programadoras que te ayudarán a recopilar la información para documentar la pieza de software en cuestión, debes comenzar con la preparación de una entrevista, que es la herramienta recomendada para este tipo de actividades y la cual te sugiero que tenga esta estructura:
-
Datos generales del entrevistado, el entrevistador y la fecha.
-
Breve introducción del tema u objetivo de la entrevista.
-
Cuestionario con preguntas abiertas e inclinadas a los temas definidos que te interesan indagar.
-
Espacio para comentarios y/u observaciones.
Además, utilizar otras herramientas como la documentación disponible del software a documentar es un buen arma, principalmente para no hacer preguntas incongruentes al programador. Pregunta si existe alguna documentación, léela con lujo de detalle y así podrás organizar preguntas útiles y enfocadas al contexto de lo que quieres saber del software.
También recuerda que tienes internet. Utiliza esta biblioteca digital para buscar información que creas conveniente y que los programadores suponen que ya conoces. No defraudes las expectativas que tienen de ti.
Una técnica que funciona bastante bien es probar el propio software por tu cuenta. Si está disponible, ¡adelante, pruébalo! Probar su funcionalidad garantiza una mayor orientación hacia dónde enfocarás tu entrevista y, de esta manera, la formulación de nuestras preguntas será más precisa.
Recomendaciones previas a la entrevista 🎙
Es importante tomar ciertas recomendaciones previas a la entrevista:
-
No presiones a las programadoras, es evidente que tienen toda la información técnica que tú necesitas, así que es poco probable que una actitud intimidadora sea efectiva.
-
No ruegues a un programador para que te dé información, no llegarás muy lejos.
-
A nadie le gusta que los saturen con montañas de correos electrónicos y recordatorios. Quizá en un inicio funcione, pero sobre la marcha lo aborrecerás a tal grado que lo único que obtendrás de la programadora será poca o nula participación.
-
Sé detallista con los programadores. En las reuniones que tengas procura llevar algún detalle que la haga sentir a gusto durante la reunión, de esta manera lograrás que la entrevista sea más ligera.
-
Haz amistad con los programadores. Esta técnica funciona bastante bien, sé empático y descubrirás que será mucho más fácil obtener información.
-
Investiga por tu cuenta acerca de la pieza de software que documentarás. Sería un gran error de tu parte llegar e improvisar. Para la programadora será una falta de respeto hacia su tiempo y experiencia. Además, perderás credibilidad.
Tips para recolectar información ✌️
-
La información recoléctala en entrevistas 1:1 (uno a uno) con el programador, convoca a una reunión proponiendo fecha, horario y lugar adecuado.
-
Llega puntual, agradece a la programadora por su tiempo y compártele por qué necesitas la entrevista.
-
Ten a la mano las herramientas que utilizarás, ya sea que escribas en tu laptop o con libreta y bolígrafos. Procura llevar tu smartphone con batería para que puedas grabar la entrevista en formato audio y para que tomes fotografías en caso de que hayan hecho apuntes en algún pizarrón.
-
No escribas literalmente toda la información que te brindan, toma nota de conceptos técnicos, datos, números e información que consideres importante.
-
Si te quedaste con dudas en alguna explicación, pídele a la programadora que te replantee la respuesta.
-
Ten el control de la entrevista. No permitas que se desvirtúe ni que se salga del objetivo acordado.
-
Una vez que tengas tu reporte de la entrevista, compártelo con la programadora y propón una fecha límite para recibir su retroalimentación y validación.
Para cerrar este capítulo te comparto esta frase de James Baker que va muy ad hoc con este tema:
"La preparación adecuada previene el mal desempeño".
¿Tienes todo listo para tu entrevista? 🤓
Para finalizar escribe en los comentarios cuáles elementos debe tener tu formato de entrevista antes de realizarla. Además, si tienes experiencia realizando este tipo de entrevistas, puedes mencionarnos qué otro tip o recomendación te ha ayudado en tu trabajo.
¡Te espero en el próximo módulo para dar un repaso sobre estructura gramatical!