Cómo redactar una especificación técnica

Proporciona una descripción general o un breve resumen del proyecto o el producto. Comienza la especificación técnica con un resumen de lo que estás haciendo. Escribe “Descripción general” o “Resumen breve” como encabezado. Explica el problema y luego resume la descripción del proyecto o el producto y lo que va a hacer. A continuación, explica cuál será tu enfoque para lograrlo e incluye especificaciones del producto si se trata de un equipamiento. Puedes vincular la especificación técnica a cualquier documento de marketing o ingeniería que sea relevante para el proyecto. Por último, proporciona un cálculo aproximado del tiempo que te tomará terminar el proyecto o el producto.^[5]

• Puedes escribir lo siguiente: “El sistema actual para planificar viajes de tránsito en todo el condado suele dejar a los pasajeros varados y reduce la cantidad de pasajeros en ciertas rutas. Dos de los sistemas de autobuses permiten a los pasajeros planificar sus recorridos a través de internet, pero el tercero emplea mapas físicos y contactos telefónicos. Esta solución reduce la cantidad de pasajeros y provoca una financiación insuficiente, como se puede apreciar en los resultados de la encuesta de la primavera del año 2019. El objetivo es trasladar las 3 líneas de tránsito a 1 sistema de planificación al que los usuarios puedan acceder a través de internet. Esta herramienta les permitirá planificar sus viajes con más facilidad y determinar cuándo se encontrarán los autobuses en cada parada. Además, los pasajeros pueden utilizar la función “contáctenos” para informar los problemas de inmediato”.

Incluye una sección de objetivos si no se encuentra en la descripción general o el resumen breve. Escribe “Objetivos” en el encabezado y luego describe brevemente lo que planeas lograr con el proyecto o el producto. Escribe un resumen introductorio y luego utiliza números o viñetas para enlistar los objetivos.^[6]

• Si describes los objetivos en la sección de la descripción general, entonces esta sección no será necesaria. Sin embargo, es probable que tengas que incluir esta sección si en tu lugar de trabajo la requieren.
• Puedes escribir algo como “El nuevo sistema incluirá lo siguiente: 1) una herramienta para planificar las rutas, 2) una función para localizar buses, 3) un medio para que los ciclistas informen problemas”.

Escribe los requisitos del producto en una sección separada. Luego, escribe “Requisitos del producto” en el encabezado, seguido de las cosas que el producto debe hacer para resolver tu problema. Utiliza una lista de viñetas y no te preocupes por redactar una frase introductoria.^[7]

• Por ejemplo, “1) El planificador de rutas garantiza que los pasajeros no se queden varados y que los autobuses no se infrautilicen, 2) El buzón de contactos permite que los planificadores de tránsito respondan de manera directa a los problemas de los pasajeros”.

Explica cosas que estén fuera del alcance del proyecto. Puedes titular esta sección como “Fuera de alcance” o “No dirigido a los objetivos”. No escribas una introducción ni párrafos. En su lugar, debes crear una lista con viñetas de las cosas que no vas a hacer para resolver tu problema. Este detalle incluye el trabajo que no vas a realizar, las soluciones que no crees que van a funcionar y los atributos que el producto o el proyecto no tendrá. Debes ser minucioso para evitar que surjan malentendidos entre el cliente y tu equipo.^[8]

• Puedes escribir: “1) Este sistema no agregará rutas nuevas para los autobuses, 2) No instalaremos computadoras en las paradas de autobús ni en los propios autobuses, por lo que los pasajeros deben emplear sus propios dispositivos, 3) Los planificadores de tránsito no garantizarán soluciones inmediatas a los problemas de los pasajeros, y 4) Este servicio no incluirá paradas de una puerta a otra”.

Incluye una sección de “Preguntas abiertas” si existen problemas sin resolver. Tu especificación técnica constituye un resumen rápido del producto o el proyecto para que el cliente comprenda lo que va a conseguir y tu equipo trabaje hacia los mismos objetivos. No te preocupes por incluir cada detalle o responder preguntas “por determinar”. En su lugar, debes escribir “Preguntas abiertas” en el encabezado y presentar una lista con viñetas de las cosas que vas a determinar más adelante.^[9]

• Puedes escribir: “1) ¿Cómo vamos a gestionar las actualizaciones del sistema? 2) ¿Vamos a cambiar los mapas de ruta si se detecta algún problema? 3) ¿El sistema es capaz de servir a una cantidad de pasajeros multilingües sin errores de traducción? 4) ¿Cómo haremos para servir mejor a los ciclistas que no son expertos en tecnología?”.

Presenta el plan en la sección “Enfoque”. Puedes titular esta sección como “Plan” o “Enfoque”. Describe cómo vas a resolver el problema o los diferentes enfoques que estás considerando si aún no has tomado una decisión final. Explica tu investigación y cada tecnología o proceso que vas a emplear. Si es posible, incluye ilustraciones, cuadros y diagramas para que a tus lectores les resulte más sencillo comprender tu plan. Por último, analiza cómo vas a probar tu plan y qué harás si surgen problemas.^[10]

• Si describes enfoques o tecnologías diferentes, debes crear una subsección para cada uno de manera que tu plan sea fácil de seguir.
• Puedes escribir algo como lo siguiente: “Vamos a trabajar con el equipo de planificación de tránsito para diseñar un software que les permita a los pasajeros ingresar sus destinos en una aplicación que generará una ruta para ellos. Los ciclistas pueden modificar la ruta si lo desean. El sistema enviará actualizaciones de texto a los pasajeros para ayudarlos a encontrar sus rutas. Vamos a hacer que los usuarios de un comité de partes interesadas prueben el software antes de lanzarlo al público. Si el plan presenta errores, realizaremos actualizaciones en la página durante las horas en que los autobuses se encuentren desconectados. Además, tendremos un autobús de enlace adicional disponible para recoger a los pasajeros que se queden varados debido a problemas con el sistema”.

Incluye las otras opciones que has considerado pero que has descartado. Puedes redactar esta sección como un subpaso en tu plan o enfoque o colocarla al final de la especificación antes del cronograma. Escribe el encabezado “Otras opciones consideradas” y luego describe las alternativas que consideraste antes de escoger el plan actual. Luego, explica por qué descartaste cada opción.^[12]

• Puedes escribir lo siguiente: “Consideramos los mapas codificados por colores porque son una opción más económica. Sin embargo, los usuarios no respondieron bien a los mapas existentes y el grupo de prueba se confundió”.

Describe tus métodos y medidas para evaluar el producto o el proyecto. Puedes incluir esta información en una o varias secciones y titularla como “Cálculo de efectos” o “Control” y “Medidas”. En uno o más párrafos, debes explicar cómo te asegurarás de que tu producto o proyecto funcione correctamente y cumpla con tus objetivos. Además, debes describir cómo vas a comprobar la existencia de errores o problemas.^[13]

• Debes incluir los procesos analíticos específicos o las tecnologías que vas a emplear.
• Puedes mencionar algo como lo siguiente: “Vamos a comparar los tiempos de ruta proyectados con los tiempos de ruta reales para asegurarnos de que los autobuses lleguen a tiempo. Además, se llevará a cabo una encuesta a los pasajeros para evaluar su nivel de satisfacción e identificar problemas con el sistema”.

Identifica cómo vas a proporcionar seguridad y privacidad. Escribe “Seguridad y privacidad” en el encabezado. Luego, explica cómo vas a proteger a los usuarios de ataques cibernéticos. Describe brevemente los riesgos y cómo vas a proteger la privacidad en tu sistema. Debes redactar un par de párrafos para explicar tus métodos.^[14]

• Siempre existirán riesgos o surgirán inquietudes, así que evita mencionar que “no existen riesgos” en esta sección.
• Puedes escribir lo siguiente: “Los usuarios deberán ingresar su ubicación y las direcciones. Además, contarán con la opción de crear un perfil y guardar sus viajes. Para proteger sus datos, se incluirá un proceso de codificación y un cortafuegos”.

Termina con un cronograma y una lista de hitos. Un cronograma ayuda a mantener el proyecto en marcha, ya que indica tanto al cliente como a tu equipo lo que deben hacer. Puedes titular esta sección como “Cronograma” y luego desglosar las tareas de acuerdo a quién las esté realizando. Incluye una lista de viñetas para cada equipo o miembro del equipo, de acuerdo a tus preferencias.^[15]

• Por ejemplo, el desglose de tareas puede incluir los títulos “Equipo de ingeniería”, “Equipo de planificación”, “Marketing” y “Control de calidad”.
• La lista de viñetas para el equipo de ingeniería puede incluir las siguientes tareas: “1) escribir actualizaciones de la página web, 2) escribir aplicaciones de planificación de viajes, 3) escribir sistemas de contactos.

Redacta el documento a espacio sencillo y omite 1 línea entre las secciones. Debes utilizar la opción de espacio sencillo para que tu especificación técnica sea más corta y fácil de manejar. Si deseas cambiar párrafos o secciones, tan solo omite 1 línea. De esta manera, el lector logrará mantenerse al día sin agregar páginas innecesarias.^[16]

• Es probable que tu instructor o empresa te proporcione instrucciones de formato diferentes. En tal caso, debes seguir dichas instrucciones.

Utiliza un punto de vista en primera persona en todas tus especificaciones técnicas. Dado que vas a analizar un trabajo que tú y tu equipo van a completar, debes emplear siempre los pronombres en primera persona “yo” y “nosotros”. Cuando te refieras a un equipo o una persona en particular, debes utilizar su nombre para que quede claro de quién estás hablando. De esta manera, mantendrás la especificación técnica directa y precisa, ya que el lector sabrá cómo completar cada acción.^[17]

• Por ejemplo, puedes mencionar lo siguiente: “Vamos a actualizar las especificaciones según sea necesario” en lugar de “Se actualizarán las especificaciones según sea necesario”.
• De manera similar, puedes escribir lo siguiente: “El equipo de ingeniería creará una página web” o “Amy redactará un plan de marketing”.

Redacta un texto claro y conciso que sea fácil de seguir. Evita desarrollar tus ideas en una especificación técnica, ya que vas a desperdiciar tanto tu tiempo como el de tus lectores. Debes utilizar la menor cantidad de palabras posible para expresar tus ideas y organizar tus pensamientos para que sean fáciles de seguir. Revisa tu informe para eliminar las palabras innecesarias y las frases repetitivas de manera que quede más directo.^[18]

• Por ejemplo, puedes cambiar la frase “Crearemos una página web que permita a los pasajeros planificar el recorrido deseado y realizar un seguimiento del autobús” por “Esta página web permite la planificación de viajes y el seguimiento de autobuses”.

Consigue un socio para que revise tu especificación técnica y te proporcione comentarios. Comparte tu especificación técnica con un miembro del equipo o un compañero de clases que la comprenda. Pídele que marque los errores que detecte y te dé su opinión acerca de dónde puedes realizar mejoras.^[19]

• No le muestres tu especificación técnica a alguien que no comprenda tu campo de especialidad. Es probable que se confunda y te recomiende cambios que no son necesarios.

Verifica si la especificación técnica necesita cambios. Con base en los comentarios que recibiste, repasa la especificación técnica y corrígela si consideras que es necesario. Concéntrate en hacer que la especificación técnica sea comprensible para el cliente y tu equipo. Sin embargo, no te preocupes si no te queda perfecta.^[20]

• Es probable que tengas que actualizarla a medida que tu proyecto o producto avanza. Este es un documento temporal, así que no dejes que te impida llevar a cabo el trabajo real.