Hasta ahora se ha familiarizado con SDLC-Software Development Life Cycle, el proceso cíclico en Ingeniería de Software que establece un orden para el flujo de trabajo, pero hoy ha nacido otro niño en el bloque-DDLC. DDLC son las siglas de Document Development Life Cycle, ¡sorpresa! Estoy seguro de que debe haber pensado en Base de datos en lugar de Documento, pero el Documento está absolutamente aquí.
Hoy las palabras se han convertido en todo y hasta que algo se comunique de manera enfática, nadie tiene tiempo de escuchar lo que has desarrollado. Así que las empresas finalmente se han levantado para mejorar la parte más ignorada del ciclo de vida del desarrollo de software, la documentación como un aspecto importante, de hecho muy importante. Esto ha dado paso a los escritores técnicos no solo a un respiro sino a un trabajo respetado en el trabajo. Anteriormente, la mayoría de los escritores técnicos solían trabajar por contrato o como autónomos. Pero ahora, la escena ha cambiado y los escritores no solo reciben un pago alto, sino que también reciben la debida importancia. Entonces, en este artículo, veamos cuáles son las fases por las que pasa un escritor técnico para crear un documento.
o Análisis de requisitos
el diseño
o Desarrollando
o Prueba
o Publicación
o Mantener
Análisis de requisitos -Esta es la etapa inicial en la que el escritor técnico reúne todo el material necesario y luego analiza el requisito real. La materia disponible debe mapearse adecuadamente con el requisito de modo que, desde el principio, el flujo se mueva en la dirección correcta y cada hora que pasa se pueda contar para la finalización de la tarea.
El escritor se reúne con los expertos en la materia (PYMES) y los codificadores de la aplicación varias veces para comprender el alcance del software y las características principales. La mayoría de los escritores creen que una reunión debería ser suficiente, pero creo que cada vez que conoces a los expertos, se despliegan más funciones de la aplicación. Simplemente porque, inicialmente solo se informan las funciones de nivel de usuario, luego, lentamente, en reuniones posteriores, el desarrollador revela la forma en que funciona cada componente. El conocimiento profundo del entorno, los usuarios finales y la funcionalidad relacionada ayuda al escritor a comprender bien el proyecto. Y un proyecto bien entendido se puede documentar de la mejor manera.
Aquí no basta con entrevistar a los expertos, el escritor debe utilizar el software para obtener los detalles de la funcionalidad. Todo el análisis debe anotarse en formato legible. Esto será muy útil más adelante y, mientras se documenta, no se necesitarían más rondas de pymes o desarrolladores.
Diseño – Esta fase es muy importante ya que crea el esqueleto del documento. Desde la portada hasta el resumen, la tabla de contenido (TOC), el texto real, el glosario y el índice, aquí se crea un diseño. Por ejemplo, si está utilizando Microsoft Word 2007, solo necesita colocar los esqueletos de TOC e Index. Más adelante, a medida que continúe escribiendo, estas tablas se actualizan siempre que haga clic en la opción de actualización.
En la fase de diseño, tienes toda la estructura lista y solo falta el contenido. Una vez que esté listo con el diseño, comenzará a surgir una vista aproximada de la forma del documento.
Desarrollando – Esta fase es la fase de escritura real. Si estuviera escribiendo un documento preliminar, habría comenzado desde esta fase y habría terminado solo aquí. Aquí se escribe el texto real y si se mantiene el TOC y el índice, los títulos, marcas de libros y referencias se establecen junto con la escritura. Escribir también significa colocar tablas, imágenes, títulos, notas, elaboración detallada, etc.
La fase de desarrollo, aunque disfruta del lugar central, aún brilla cuando se asocia y mapea con el resto de las fases exactamente como se planeó.
Pruebas – Como indica el título, esta fase se produce después de haber escrito el documento y haber actualizado todas las tablas, incluidos el TOC y el índice. Al hacer clic en un encabezado en particular en el TOC debe llevar el control a la página conectada. Los enlaces e hipervínculos adicionales deben estar bien conectados y verificados. Aparte de estas pruebas, la verificación gramatical, la verificación de puntuación y el flujo regular de oraciones y frases sensibles son elementos de prueba naturales.
Recuerde, si un enlace no funciona correctamente, puede ser indultado, pero como escritor técnico, cualquier error gramatical o falla en el flujo de la oración no se puede tomar a la ligera de ninguna manera.
El documento para software normalmente sigue una guía de estilo que indica cómo se debe escribir un título o cómo se deben enmarcar los párrafos. Por lo tanto, el uso de la guía de estilo debe seguirse de memoria.
Una vez probado para las regulaciones antes mencionadas, se envía un documento a las pymes y codificadores de software que luego leen el documento entre líneas para confirmar que lo que está escrito es exactamente lo que sucede. Cualquier problema reportado se comunica al escritor quien luego asegura la veracidad de las palabras.
Publicación – Una vez que todo el texto está bien enmarcado, administrado y revisado, está listo para su publicación. Si el documento se va a publicar fuera de la empresa, se sugiere realizar una copia impresa del documento y ver cómo quedará después de la impresión. Como una vez que la impresión se realiza a gran nivel, cualquier cambio costará demasiado y también afectará su reputación como escritor técnico porque el escritor no solo es responsable de crear documentos sino también del formato adecuado. El escritor debe asegurarse de que el documento sea apto para la lectura y se adapte a los ojos del lector. La selección de fuentes, la elección del tamaño y el uso del brillo en las imágenes son algunos puntos que pueden convertir un documento de aspecto extraño en una obra maestra.
Mantenimiento – Como de costumbre, esta es la fase más larga y quizás interminable. Incluye la adición, eliminación y actualización del documento. Si se agregan más funciones al software, deben agregarse de manera destacada para que los lectores existentes puedan prestar atención directamente a las cosas recién agregadas.
En caso de que se haya actualizado la herramienta de creación, el escritor debe aprender nuevas funciones e incorporarlas en el documento existente, etc.
Las fases antes mencionadas siempre se han seguido pero de manera inconsciente. Ahora tenemos una idea, ¿por qué no ceñirse a las fases y asegurarse de que el resultado sea absolutamente maravilloso y profesional?
Prashant Shrivastava