¿Cómo documentar un proyecto web? 5 reglas básicas y 5 pasos

¿Quieres aprender a planificar bien tus proyectos y no dejar nada al azar? ¿Sabes qué reglas fundamentales deberías seguir y cómo crear documentos de trabajo que funcionan?

La documentación es parte fundamental de la planificación. Una buena documentación te ayudará a organizar las tareas, las responsabilidades de cada miembro del equipo y las fechas clave, evitando así malentendidos, retrasos y descoordinación. Cuando falla la planificación, se producen roces entre los miembros del equipo, resultados mejorables y pérdidas económicas; por eso es tan importante hacerla. Y hacerla bien.

Si como Community Manager, director de marketing o director de proyectos necesitas coordinar tareas de diseño y desarrollo, debes invertir al principio: planifica y documenta. Aunque puede resultar laborioso, para la mayoría de proyectos no es complicado y te ahorrará mucho trabajo en constantes explicaciones y aclaraciones futuras.

En este post te voy a dar 5 reglas básicas y 5 pasos para crear documentos que alineen a tu equipo hacia un mismo objetivo.

 

 

Paso previo: Perfiles y visiones

Antes de empezar, debes escuchar las opiniones sobre el proyecto de todos los miembros que van a estar implicados en su elaboración; cada uno va a tener una visión sobre su área de especialización. Al juntar los puntos de vista de cada miembro, encontrarás la manera de alinearlos a todos, mejorarás tu visión sobre el proyecto, gestionarás mejor las expectativas y, lo que es más importante, te ayudará a prevenir riesgos y a estar preparado ante imprevistos.

La visión de cada miembro lleva consigo su experiencia en cada campo, y todos ellos son igual de importantes si quieres cosechar éxitos. Un ejemplo de diferentes perfiles y visiones:

• Director de proyecto: Cumplir el plazo y el presupuesto.
• Programador: Estabilidad del sistema.
• Diseñador: Apariencia estética.
• Director de marketing: Contenido orientado a venta.
• Cliente/gerente/propietario: Generación de beneficios.

Intenta poner los puntos anteriores en una escala de prioridad. Difícilmente lo conseguirás, dado que la respuesta es que todos son igual de importantes. Fallar en cualquiera de los puntos, significa fracasar.

Reglas básicas

# 1. No existen las obviedades

Los proyectos mal planificados y documentados suelen generar fricción entre los miembros y mensajes del estilo: “Cómo es posible que no lo sepa”, “Es de cajón”, “No lo dije porque lo daba por sentado”, “Era obvio”… Esto ocurre por dar las cosas por hechas o por aclaradas, pero, realmente, a la hora de documentar, no existen las obviedades, todo debe estar especificado hasta el último detalle.

Así que lista, recréate, repite… más vale pasarte de pesado que de escueto, dado que lo que para ti es obvio, para otra persona puede que no lo sea.

En la Universidad de Harvard un profesor demostraba a sus alumnos cómo no hay que dar nunca nada por sentado ni siquiera para preparar una tostada. ¡Y lo hacía para explicarles qué es un algoritmo! No te pierdas este vídeo porque es francamente bueno:

# 2. Piensa en quién va a leer el documento

Que todos los miembros del equipo habléis castellano o inglés, no significa que todos entendáis lo mismo al utilizar las mismas palabras.

Informáticos, diseñadores, gente de marketing… están programados de manera diferente, tienen una estructura mental distinta y utilizan su propia jerga. Como coordinador del proyecto, intenta adaptar el lenguaje de cada documento a la persona que lo va a leer, y del mismo modo, incluye tan sólo la información relativa a sus tareas y responsabilidades.

[quote style=”1″]Ejemplo: ¿Nunca te has quejado cuando te venden productos financieros que no entiendes cuando te los explican? Seguramente el personal que trabaja en banca lo entienda perfectamente. El fallo no es tuyo como cliente, el fallo es de quien lo explica, dado que no consiguen ponerse a tu nivel de conocimientos financieros (aunque puede que pienses que prefieren que los clientes no lo entiendan, pero eso ya es otro tema). ;)[/quote]

# 3. Escribe de una forma sencilla

Documentar un proyecto no es escribir una novela. Utiliza un vocabulario sencillo, adaptado a cada miembro del equipo y combínalo creando frases cortas y con un único sentido.

# 4. Adjunta imágenes y explicaciones gráficas

Dentro del documento, añade capturas de pantalla, gráficos, esbozos y ejemplos que puedan ayudar a ilustrar tus ideas. Apóyate de flechas y comentarios que expliquen cada elemento.

[quote style=”1″]Hazte estas preguntas: ¿puedo sustituir este párrafo por una imagen?, ¿ha quedado lo suficientemente ilustrado?, ¿ayudaría incluir algún ejemplo?[/quote]

# 5. Estructura el contenido

Es importante que al escanear visualmente el documento, el lector consiga hacerse una fotografía general del proyecto y entender así cómo encaja su perfil en él y cuál será su papel. Debes tener en cuenta que cada área del proyecto debe ir en un parte distinta del documento o incluso en documentos separados; es decir, aunque dos temas tengan que ver con la página principal, si uno es de programación y el otro es de diseño, deberán ir por separado.

Estructura del documento

# 1. Introducción y enfoque

La introducción debe incluir un resumen de todas las secciones del documento que formen una fotografía general del proyecto (problema que resuelve, enfoque, objetivos principales, requisitos…). Esta parte funciona a modo de resumen ejecutivo que todas las personas involucradas en el proyecto puedan leer brevemente para hacerse una idea. Como máximo debería ocupar una página.

# 2. Resumen del material que se espera recibir al final del proceso

En este apartado deben aparecer los resultados que se espera recibir al final del proyecto, qué debe entregar cada miembro o parte de equipo y el nivel de calidad esperado.

# 3. Descripción detallada de las funciones y elementos

En esta sección debes listar de manera pormenorizada cada caso de uso y función dentro del proyecto. En esta parte es donde más importancia toman los bocetos y ejemplos para ilustrar las funciones de una manera clara.

# 4. Fechas objetivo

Las fechas clave son todos aquellos momentos de especial relevancia en la consecución y entrega de los resultados en cada fase del proyecto. Las tareas suelen agruparse en sprints que trocean el proyecto en diferentes hitos que se deben conseguir.

Un gran aliado para marcar fechas y asegurarte de que se cumplen son los diagramas de Gantt, así que no te olvides de incluirlos en el documento.

# 5. Composición del equipo y recursos clave

Aunque ya se conozcan entre ellos, acuérdate de explicar quiénes son las personas que intervendrán en el proyecto, sus responsabilidades y tareas y sus datos de contacto. De esta manera evitarás roces del estilo “esto no me correspondía”.

Este punto es también ideal para definir las herramientas de comunicación y de gestión de tareas que se van a utilizar, para que a todos los miembros conozcan la forma y el lugar al que dirigirse al resto de compañeros. En este post encontrarás 10 ideas para utilizar Basecamp, una de las herramientas más utilizadas en la gestión de equipos.

Extra: control de versiones

Los documentos sobre los proyectos son susceptibles de variar a lo largo del tiempo conforme van apareciendo contingencias y el proyecto evoluciona. Es importante que encuentres tu manera de organizar las versiones de los documentos para que no se pierda ningún dato importante y estén ordenados. Algunas ideas para controlar las versiones de los documentos:

• Utiliza nombres de archivo que especifiquen el número de versión o la fecha de creación (como V.2 o 1-8-13).
• Puedes crear documentos adicionales desde cero que tan sólo especifiquen actualizaciones sobre el documento principal.
• Sustituye Word o los PDF por Google Docs para hacer un seguimiento completo de las modificaciones gracias a su historial de revisión.

¿Cómo sueles planificar y documentar tus proyectos? ¿Tienes alguna técnica especial para estos casos?

Imágenes: Shutterstock

[grwebform url=”https://app.getresponse.com/view_webform_v2.js?u=lhGe&webforms_id=3512103″ css=”on” center=”off” center_margin=”200″/] [grwebform url=”https://app.getresponse.com/view_webform_v2.js?u=lhGe&webforms_id=3512203″ css=”on” center=”off” center_margin=”200″/]