Elementos claves de una buena documentación de proyectos

Identificación del proyecto

Deberá figurar claramente a qué proyecto se refiere la Propuesta. El proyecto se identificará mediante la inclusión de su título y acrónimo. Se incluirá igualmente, en este apartado, un breve resumen de un párrafo de extensión, del objetivo prioritario del proyecto.

La intención de este apartado es condensar brevemente los datos más relevantes del proyecto (nombre, temática y objetivo principal), para que le
sirva al lector como una referencia rápida de lo que viene a continuación, y así pueda decidir si sigue o no con la lectura del documento.
Intervinientes principales en el proyecto En este apartado se citarán los intervinientes más importantes del proyecto: los miembros del equipo desarrollador y el profesor que desempeña el papel de tutor del proyecto

Antecedentes y estado actual del tema

Para poder afrontar la realización de un proyecto con garantías hay que empezar con una buena actividad de documentación, que permita  conocer con el grado de detalle suficiente, las características del problema a abordar, las técnicas empleadas en el pasado para su solución y los resultados obtenidos.

También deberá investigarse cómo se está abordando el problema actualmente y con qué resultados. Por otro lado, a la hora de presentarse delante de un cliente para ofrecer la realización de un proyecto, toda esta información debe estar perfectamente asimilada, con objeto de poder situar nuestro proyecto  en el contexto tecnológico presente y poder argumentar convenientemente las fortalezas.

Factores

Cliente: es necesario cuantificar todas las necesidades y las especificaciones requeridas por el cliente ya que serán la base de la planificación. A partir de los requisitos necesarios se pueden calcular los diferentes aspectos incluidos en la gestión y la planificación como tiempo, recursos y presupuesto.

Objetivos: todo proyecto parte desde la definición de un objetivo final concreto para el cual se diseña. Todas las fases y la elaboración de un proyecto están enfocadas a conseguir un resultado concreto que determina el cumplimiento exitoso del objetivo marcado en la planificación.
Alcance: se pueden diferenciar dos tipos de alcance, el alcance del proyecto y el alcance del producto. En el alcance del proyecto se debe analizar la combinación de todas las tareas y el trabajo para llevarlo a cabo. En el alcance del producto se deben identificar las limitaciones con respecto al producto y comprobar si el resultado cumple con las características y las funciones requeridas.
Tiempo: en la planificación se define una fecha de inicio y fin para el proyecto, siendo este plazo de tiempo considerado el tiempo total del proyecto. En este tiempo se definen la secuenciación de las actividades y la estimación de plazos
para cada actividad.
Calidad: es necesario que el proyecto asegure la satisfacción sobre los requisitos y las necesidades establecidas. Es imprescindible elaborar una
planificación y un control de la calidad tanto del proceso como del producto mediante actividades de seguimiento.
Coste: partiendo de un presupuesto establecido y definido, es muy importante llevar a cabo un proceso de gestión del coste que asegure la realización del proyecto con el presupuesto aprobado y por tanto hacer una planificación de recursos, estimaciones y control del coste.
Recursos: un recurso se define como la fuente de la cual se extrae un beneficio y pueden ser de tipo humano, económico, temporal, material, equipos, instrumentos o instalaciones.
Riesgo: en cualquier proyecto existe multitud de riesgos que posteriormente, si se materializan, se convierten en problemas que provocan situaciones adversas, por ello es necesario realizar actividades para la gestión de riesgos.

Fases del ciclo de vida de un proyecto

Definición
La fase de definición comienza a partir de la identificación de una idea que se convertirá en un nuevo proyecto.
El principal trabajo en esta fase es establecer los objetivos del proyecto dependiendo de las necesidades y los requisitos del cliente o mercado.
Es una fase de gran importancia para alcanzar el éxito en el proyecto ya que unos objetivos mal planteados darán lugar al fracaso a pesar de una correcta gestión.

Aprobación
Inicialmente se realiza una fase preparatoria donde intervienen todos los miembros participantes en el proyecto con la intención de lograr el
entendimiento del proyecto y estudiar todos sus aspectos. El objetivo de esta fase es identificar el problema o la necesidad para posteriormente trasladarlo como proyecto identificando igualmente su solución y respuesta.

Se realiza un estudio de viabilidad técnica y operativa además de un análisis económico, análisis de mercado y legal del proyecto.
El resultado del estudio en esta fase de aprobación se refleja mediante documentos de tipo presupuestario. Una vez analizada esta propuesta de
proyecto, en el caso de ser aprobada por la compañía, se iniciarán las siguientes fases de desarrollo sobre el proyecto.

Planificación
El objetivo de esta fase es planificar todo el trabajo que se debe realizar en el desarrollo del proyecto y enumerar todas las tareas necesarias para poder completarlo en función del tiempo y los recursos disponibles. La planificación incluye las siguientes actividades:
• Estimación de costes, plazos y cronogramas de tiempo.
• Razones que justifican el proyecto y su inversión.
• Elaborar una estrategia, gestionar riesgos y organizar el equipo de trabajo.

Ejecución
La fase de ejecución del proyecto consiste en reunir todos los recursos disponibles y utilizarlos para realizar todas las tareas anteriormente planificadas cumpliendo los requisitos de tiempo, coste y resultado, además de realizar los informes oportunos sobre el estado del proyecto.
Esta fase de ejecución es considerada la más larga y complicada del ciclo de vida de cualquier proyecto y puede estar llena de problemas  provocados por una mala gestión de recursos.

Durante la fase de ejecución se debe realizar un control y una supervisión sobre el plan establecido con el objetivo de identificar los cambios y los riesgos durante la ejecución del proyecto, generando además la documentación necesaria para su aceptación.

Cierre
Una vez que el cliente aprueba la entrega, el trabajo del equipo de proyecto
será realizar un informe y una evaluación posteriores al cierre que serán
presentados a los directivos de la empresa en base al éxito global del proyecto.

 

Contenido

Podemos indicar una serie de puntos que no deberían faltar en cualquier documentación de proyecto:

  • Identificación de la propuesta
  • Identificación del proyecta
  • Partes interesadas.
  • Justificación del proyecto
  • Descripción completa del proyecto.
    – Textos explicativos
    – Diagramas
    – Bocetos
    – Etc.
  • Objetivos del proyecto
  • Requisitos de usuario
  • Requisitos de sistema
  • Tecnologías
    – Lista de tecnologías a utilizar (Lenguajes de programación, frameworks…)
    – Herramientas (IDE`s, Programas, etc. )
    – Hardware (Ordenadores, servidores,..)
    – Metodologías (Metodologías utilizadas para la realización del TFM)
  • Plan de proyecto
  • Lista de tareas y sub-tareas
  • Secuenciación de tareas
  • Temporalización de tareas
  • Recursos de cada tarea
  • Diagrama de Gantt.
  • Presupuesto
  •  Comentarios

Objetivos

Los objetivos se presentarán en dos grados de detalle. Por un lado, deberá aparecer claramente el objetivo global, que es explicado con un lenguaje general y sin entrar en gran detalle. Por otro lado, deberán aparecer los objetivos concretos. Mientras que el objetivo global es único, los objetivos concretos son múltiples, y deben necesariamente presentarse numerados.

Los objetivos concretos deben describirse con la corrección suficiente como para que los miembros del tribunal examinador puedan objetivamente determinar o medir su grado de cumplimiento. El no hacer esto, se considerará una falta, o un fallo, en la definición adecuada del proyecto.

Deberá quedar claro, en este apartado, la relación entre los objetivos concretos y el objetivo global, mediante la explicación de cómo la consecución de los primeros consigue la consecución del segundo.

Requisitos

Si para la correcta realización del proyecto, se prevé que el cliente deba participar de alguna manera, deberá especificarse claramente en este apartado. Por ejemplo, es posible que se requiera que el cliente proporcione ciertas informaciones, o que deba intervenir en validaciones de prototipos dentro de plazos prefijados, etc.

Requisitos del usuario
Especifica los requisitos que el sistema deberá cumplir exigidos por los usuarios. Su inclusión en la Propuesta es, por un lado, un compromiso de su cumplimiento; por otro, supone un efecto tranquilizador para el cliente, que comprueba que no ninguno ha sido pasado por alto. Debe quedar claro que la responsabilidad de comprender qué quiere el cliente exactamente es del equipo desarrollador.

Requisitos del sistema
Deberán especificarse las prestaciones y requisitos mínimos del sistema informático que se requerirá para soportar la solución informática que
proporciona el proyecto ajustada a los márgenes de rendimiento que puedan exigirse. Esto permite que el equipo desarrollador se asegure de que la plataforma informática requerida para el sistema informático que se  desarrollará en el proyecto es de unas dimensiones asumibles y de que está escalada según lo que necesita y espera el cliente.

Plan de trabajo

La tarea principal del proyecto deberá desglosarse en tareas y subtareas.

Estas irán numeradas de una manera indicativa de su jerarquía (por ejemplo: 7, 7.1, 7.1.1, etc.).

Para cada tarea o subtarea se especificará: interviniente responsable, otros participantes, breve descripción, consumo de recursos previsto, dependencias con otras tareas, duración y plazo de ejecución.

Presupuesto del proyecto

Deberá presentarse el presupuesto (ficticio) para el desarrollo del proyecto.

Deberá incluirse: material bibliográfico, material fungible, equipos (considérense períodos de amortización), personal, alquiler de instalaciones,
entre otros.

En el caso del personal cualificado, se facturará por hora de dedicación a precios representativos del mercado actual.

Aunque en una propuesta cara al cliente nunca lo haríamos, aquí se distinguirá entre el coste de desarrollo y el precio para el cliente, siendo la diferencia el beneficio bruto esperado.