Guía para publicación de proyectos en la comunidad Galileo

Versión 2

     

    Introducción

    Este documento, te servirá como guía para preparar la documentación de tu proyecto para su publicación en la comunidad de la plataforma Intel Galileo en español. Deberás enviar un archivo comprimido al correo: cinvestav.galileo@gmail.com con el siguiente contenido:

    1. Un archivo PDF que contenga la documentación de tu proyecto siguiendo la estructura aquí indicada.
    2. Todas las imágenes incluidas en el documento (de preferencia agrupadas en una carpeta).
    3. Todos los demás archivos necesarios para la reproducción del proyecto (código fuente, archivos de diagramas de circuito, archivos CAD, etc).

    El formato del documento (tipo, tamaño y color de letra, justificación, etc) deberá ser básico pero presentable.

    El documento deberá contener una introducción, donde se describa de manera general el proyecto, es decir, que es, que hace, para que sirve, etc. Opcionalmente se puede incluir el porque, cuál fue la principal razón para el desarrollo del proyecto. En ésta sección se pueden incluir imágenes ilustrativas, además si existe, se puede incluir el enlace a un video donde se muestre el proyecto en funcionamiento.

     

     

    Funcionamiento

    En ésta sección se debe describir como funciona cada parte del proyecto y la manera que interactúan entre ellas. Puedes incluir imágenes para ilustrar.

     

    Software

    Que algoritmos se utilizaron y como fueron programados.

     

    Electrónica

    Como funciona la parte electrónica del proyecto, es decir, que interfaces se utilizan, que sensores, que voltajes se manejan, etc.

     

    Mecánica

    Como funciona la parte mecánica del proyecto, que tipo de motores/actuadores son usados, que función tienen los elementos estructurales, etc.

     

     

    Lista de material

    Se debe incluir una lista detallada del material necesario para la reproducción del proyecto, indicando la cantidad de cada componente. La lista deberá estar clasificada en:

    • Elementos de software: Si se requiere algún software además del IDE Arduino para Galileo. (EJ: MATLAB, LABView, etc.).
    • Elementos de hardware: Todos los componentes eléctricos y electromecánicos. (Motores, resistencias, capacitores, cables, conectores, shields para Arduino, tarjetas de red, fuentes de alimentación, etc.).
    • Extras: Todo el material restante, incluyendo material para construcción de elementos estructurales. (Láminas de madera, plástico, acrílico, mental, tuercas, tornillos, pegamento, etc.).

     

     

    Desarrollo

    En esta sección se debe explicar de forma detallada como replicar cada una de las partes que componen al proyecto, es decir, una especie de manual ilustrado con imágenes y especificaciones, donde se indique paso a paso el ensamble del sistema (conexiones, construcción de estructuras, PCBs, cables y conectores especiales, etc.) indicando en que parte son necesarios los archivos incluidos en el proyecto, como puede ser un archivo CAD para maquinado de piezas, un CAD para construcción de un PCB, el código fuente, etc. También se deberán indicar todas las precauciones que se deben tomar durante la construcción y manipulación del proyecto.

    Puedes tomar como referencia uno de los proyectos mas populares de la comunidad Intel Galileo en Inglés, el Data Monster Data Monster Documentation | Intel Communities.