¿Documentar mi trabajo?

Frecuentemente nos enfrentamos a la necesidad de dejar plasmado en una evidencia, el trabajo que hemos hecho para desarrollar un proyecto, por más mínimo que éste sea. Es por ello que podemos cuestionarnos, ¿qué tan necesario resulta hacerlo?

Cuando desarrollamos un proyecto hacemos uso de un sinfín de herramientas que nos permiten construir, diseñar, y evaluar el desempeño de nuestra creación. Sin embargo, en la mayoría de las veces, se deja de lado la elaboración de una evidencia que sustente el método, los medios y los resultados obtenidos; presentando un trabajo funcional pero carente de formalidad.

La importancia de documentar un trabajo o proyecto, radica en los elementos que lo componen, pues además de robustecer su presentación, podemos tener a la mano información completa y detalles que por algún motivo, omitimos, cuando el proyecto estaba en desarrollo.


El proceso para la construcción de un documento consiste metodológicamente en establecer qué tipo de proyecto se realizará, pues en el caso de que el proyecto consista en el desarrollo de un evento, convocatoria, o presentación, estaremos hablando de un plan de proyecto. Ahora bien, si nuestro proyecto trata acerca de la realización de un dispositivo (hardware), diagnóstico o implementación, se estaría generando una ficha técnica.

Indistintamente del proyecto que se trate, es posible rescatar aquellos elementos indispensables para lograr un trabajo completo y formal.

  • Marco teórico referencial.

Es altamente recomendable contar con un marco teórico que permita sustentar el trabajo de investigación y los puntos de arranque de un proyecto, pues con ello deja de perderse el sentido elemental del mismo. Con este punto se establecen las consideraciones científicas que son tomadas en cuenta, además de fungir como una apertura hacia quien está leyendo el reporte del proyecto.

  • Materiales, equipo e insumos utilizados.

Establecer cuáles son los materiales utilizados en el desarrollo del proyecto (incluso el tornillo más pequeño), también es un punto razonable para incluir en nuestro documento, pues de ésta manera podemos indicar una proyección de la replicabilidad del mismo. Esto es, que cuando otra persona interesada en replicar el proyecto comenzará a evaluar su factibilidad a partir de los materiales utilizados.

  • Metodología y desarrollo de experimentos.

En un sentido lógico, un documento que reporta el trabajo desarrollado para la realización de un proyecto, es necesaria la especificación de los experimentos realizados y la metodología utilizada, pues se estandarizan los procedimientos a seguir, al momento de replicar dicho proyecto.

  • Diagramas.

Los diagramas son una de las partes más esenciales de un reporte de trabajo, puesto que además de darle un punto más de formalidad, permiten esclarecer cada una de las etapas componentes del proyecto.

  • Tablas de resultados.

Comúnmente un problema que se presenta cuando se elabora un documento para nuestro proyecto, es la parte referente a los resultados, puesto que si un reporte carece de ésta etapa difícilmente será entendible cuales son los resultados obtenidos, de entre tanta información contenida. La solución a ello es establecer un área específica para colocarlos. Indispensable es definir que no sólo se trata del uso de tablas (aunque formalmente sea una recomendación)  para representar los resultados, ello depende del tipo de proyecto realizado, pues de igual manera dichos resultados pueden establecerse mediante un postulado breve, que no debe de confundirse con el siguiente punto.

  • Conclusiones (en caso de ser necesarias).

Hablamos del cierre formal del documento, con ésta parte termina el trabajo de investigación realizable, es aquí donde se determina el análisis de factibilidad para el proyecto, presentando la resolución de los problemas enfrentados, las aclaraciones pertinentes, y estableciendo el cumplimiento de los objetivos o metas, para los cuales el proyecto ha sido desarrollado.

  • Referencias.

Sin duda alguna, la parte más indispensable para lograr un documento (plan de proyecto o ficha técnica) completo y correcto. Esto se debe puesto que la mención de referencias indica las fuentes consultadas para las consideraciones que éste proceso de investigación requiere. Añade el punto de formalidad más completo, y le da un sustento en la literatura, a la cual, aquel que lee el reporte puede tener acceso.


El conjunto de elementos anterior nos sugiere una condición necesaria y suficiente para tener éxito al momento de documentar un trabajo. Aunque parezca una pérdida de tiempo, el hecho de realizarlo, nos brinda una preparación para un buen desempeño en cualquier área de investigación, en donde es indispensable el conocimiento de documentar adecuadamente un proyecto.Documento

Uno de los beneficios más grandes que puede brindar el documentar cualquier actividad, es la generación de un documento que contenga la información relevante acerca de nuestro proyecto, el cual puede estar a nuestro alcance de manera inmediata; es válido el uso de imágenes e incluso fotografías del desempeño, aunado por ejemplo al uso de gráficas con programas de procesamiento numérico, de tal manera que éste documento pueda servir para su presentación o la participación por un presupuesto (que en el caso particular debe de ser incluido), e incluso la atención a una convocatoria.

About Edson Aldair Pérez Hernández

Fundador del Club de Robótica Estudiantil, Sistemas Embebidos y Programación (CRESEP). Estudiante de Ingeniería en Comunicaciones y Electrónica. Escuela Superior de Ingeniería Mecánica y Eléctrica. Instituto Politécnico Nacional.

Facebooktwittergoogle_plusredditpinterestlinkedinmailby feather

Comentarios

Autor: Edson Aldair Pérez Hernández

Fundador del Club de Robótica Estudiantil, Sistemas Embebidos y Programación (CRESEP). Estudiante de Ingeniería en Comunicaciones y Electrónica. Escuela Superior de Ingeniería Mecánica y Eléctrica. Instituto Politécnico Nacional.