¿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.

desorganizacion-tareas

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

pregunta-miembros-equipoAntes 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

No hay obviedades en web

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

Captura de pantalla

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

diagrama-de-gantt

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

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″/]

Álvaro Verdoy


16 comentarios

  • Marina

    01/08/2013 a las 17:20

    Gracia por planificar las documentacion

    Responder

  • ARELI

    01/08/2013 a las 22:43

    Un post de gran ayuda, para los que gestionamos proyectos.

    Gracias

    Responder

  • Anand

    06/08/2013 a las 13:05

    Yeah the most important thing is the planning document shouldn’t look boring, should be crisp and broken into correct modules/sections of content, and right kind of tools must be used, Basecamp, MS projects are good examples. some time technical documentation doesnt interest the business guy and too much of market or case studies in the planning doc doesnt interest the technical guys as you said above think who will read is the point i am reiterating.

    Responder

  • Gustavo

    10/08/2013 a las 18:48

    Muy buen artículo, yo recién estoy empezando en estos temas lo que si me parece mucho más práctico Dropbox para poder compartir una carpeta con varios miembros de un grupo y luego en la web de Dropbox aparece día y hora en que cada miembro del grupo modifico un archivo y se pueden recuperar modificaciones anteriores del mismo.

    Responder

  • christian

    08/04/2014 a las 11:24

    Interesante, tu tutorial.Recien me voy a inciar en este campo y he departido con amigos si utilizar html5 o joomla, pero ninguno hablamos sobre la documentacion(Objetivos, fechas de entrega).
    Deseo diseñar una web, pero como personalizar, hacerla unica y no copiarlo.
    ejemplo : Un estudio de abogados o una academia; necesariamente m voy a guiar de otras web similares, como hago para no caer en la copia, hay tips acerca de este tema.Gracias por la respuesta.

    Responder

  • Ximenino

    24/07/2015 a las 10:46

    Álvaro, gracias.
    Compartir el conocimiento y experiencia de algo a alguien, demuestra tu altruismo y amor al resto.
    Gracias, me ayudaste bastante.

    Responder

  • Jose

    14/07/2016 a las 09:36

    Muy buenos consejos, en nuestra empresa nunca se documenta nada y después es imposible hacer bien los proyectos ya que donde se dijo digo dije diego… Ojalá mi jefe se aplicara el cuento y hiciera bien las cosas…

    Responder

  • Karina

    29/11/2017 a las 17:44

    Excelente artículo, muy buenos consejos, Gracias 🙂

    Responder

  • Guille

    21/07/2018 a las 05:15

    Alguna herramienta que puedas recomendar para la planificación de un desarrollo?

    Responder

  • Gorka

    01/09/2018 a las 12:36

    Muy interesante artículo.
    Te dejo link del software Dokuteka, muy útil para llevar la gestión de la documentación de proyectos web o de cualquier otro tipo.

    http://www.softiniza.com/dokuteka

    (es gratis)

    Responder

  • jhon hader rojas cabrera

    13/01/2021 a las 15:07

    Hola, muy buena ayuda para los que apenas estamos empezando con el emprendimiento, este articulo es viable para no confundirse en cuanto a la documentación de tu idea de negocio. Muchas gracias por tu ayuda.

    Responder

Dejar un comentario

Tu dirección de correo electrónico no será publicada.

Socialancer Limited te informa de que los datos de carácter personal que nos proporciones rellenando el presente formulario serán tratados por Socialancer Limited como responsable de esta web. La finalidad de la recogida y tratamiento de los datos personales que te solicitamos es para gestionar los comentarios que realizas en este blog. Legitimación: Consentimiento del interesado. El hecho de que no introduzcas los datos de carácter personal que aparecen en el formulario como obligatorios podrá tener como consecuencia que no podamos atender tu solicitud. Como usuario e interesado te informamos de que los datos que nos facilitas estarán ubicados en los servidores de Raiola (proveedor de hosting de Socialancer Limited), dentro de la UE. Ver política de privacidad de Raiola. Podrás ejercer tus derechos de acceso, rectificación, limitación y suprimir los datos en editorial@socialancer.com así como el derecho a presentar una reclamación ante una autoridad de control. Puedes consultar la información adicional y detallada sobre Protección de Datos en nuestra página web: https://www.socialancer.com, así como consultar nuestra política de privacidad.