Sunteți pe pagina 1din 60

MANUAL DE PROCEDIMIENTOS PARA LA ELABORACIN DEL PROYECTO PEDAGGICO INTEGRADOR NIVEL POR NIVEL

(Versin 1.1)

01/08/2011 Politcnico Colombiano Jaime Isaza Cadavid CLAUDIA ALEJANDRA ROSERO NOGUERA

PRESENTACIN El Politcnico Colombiano Jaime Isaza Cadavid es una Institucin de Educacin superior, que se dedica a la formacin de la juventud antioquea; con una marcada y reconocida vocacin hacia la Educacin Tcnica y Tecnolgica. En la actualidad nos encontramos inmersos en la era del conocimiento, que determina nuevos modelos de actuacin donde la tecnologa y el conocimiento son imprescindibles para el crecimiento, fortalecimiento y permanencia en los diferentes mbitos sociales. Por ello el compromiso de la institucin por la formacin de profesionales ntegros con las competencias que el sector productivo necesita. Los procesos de enseanza, aprendizaje y evaluacin deben desarrollar formas para medir, acompaar y ajustar sus gestiones para el logro de los resultados propuestos en los Niveles de formacin. Este propsito se plantea desde la formacin por proyectos en los que se empleen competencias de formacin en situaciones y problemas diversos, graduales y continuos de cada Nivel acadmico respectivo, enmarcados en la creatividad y la formacin pedaggica. Por lo anterior, se presenta este manual, el cual pretende orientar al estudiante a realizar paso a paso la elaboracin del Proyecto Pedaggico Integrador (PPI). PERFIL DEL ESTUDIANTE El graduado de la Tcnica Profesional en Programacin de Sistemas de Informacin , podr desempear los siguientes roles: Programador Junior: Dado un diseo puede implementarlo en un ambiente especfico. Auxiliar de documentacin Auxiliar en el soporte bsico de aplicativos Probador de software: A partir de una lista de chequeo verifica el cumplimiento de especificaciones. Auxiliar en mantenimiento de Sistemas

El graduado de la Tecnologa en Sistematizacin de Datos en apoyo a equipos coordinados por Ingenieros, podr ser: Asistente en levantamiento de requerimientos. Asistente de diseo Programador Junior en una plataforma tecnolgica Ejecutor de planes de prueba. Asistente en la construccin de planes de pruebas Soporte tcnico informtico e Instruccin a usuarios finales. Documentador de manuales para sistemas de informacin Administrador de Recursos Informticos

COMPETENCIAS ESPECFICAS Y TRANSVERSALES A DESARROLLAR Cl ie nt e Cl ie nt e

Requisitos

Diseo

Programacin

Pruebas

Implantacin

Competencias Especficas especficas

Manejo de Negociacin

Comprensin del Enfoque Sistmico / Procesos

Programar en un lenguaje Documentacin de Software Construccin de modelos de datos

Pruebas de Software

Soporte a usuario

Comprensin Organizacional Modelamiento de Datos

Operador de Recursos Informticos

Competencias Generales

- Trabajo en equipo - Orientacin al logro - Comunicacin oral y escrita - Investigacin y creatividad

- Manejo de las TICs - Gestin de la Informacin - Pensamiento Analtico Sistmico - Pensamiento Algortmico

- Pensamiento conceptual - Organizacin y planificacin - Interpretacin de documentos - Aplicar mejores prcticas

MDULOS SOL

Mdulo sol: Mdulo que coordina a los dems mdulos del semestre para desarrollar satisfactoriamente
el PPI. El profesor de ste mdulo tiene a su cargo la responsabilidad de organizar, acompaar y gestionar los PPI de los estudiantes durante el semestre.

MODULOS SOL DE LA TCNICA

PRIMER SEMESTRE SEGUNDO SEMESTRE TERCER SEMESTRE CUARTO SEMESTRE

Identificacin del Ciclo de Vida del Software Pensamiento Analtico Sistmico I (*)

Definicin de Requerimientos Pensamiento Analtico Sistmico II (*)

Construccin de elementos de Software Web Pensamiento Analtico Sistmico III (*)

Garanitizar el cumplimiento de los Requerimientos del Software

MODULOS SOL DE LA TECNOLOGA

QUINTO SEMESTRE SEXTO SEMESTRE SPTIMO SEMESTRE

Anlisis de Requerimientos Construccin de elementos de Software 2 (*)

Diseo del Sistema Construccin de elementos de Software 3 (*)

Implantar el Sistema de Informacin Construccin de elementos de Software 4 (*)

(*) Mdulo Sol Alternativo, slo en casos especiales, aprobados por la Coordinacin del PPI

QUE ES UN PROYECTO PEDAGGICO INTEGRADOR?


Proyecto Pedaggico Integrador: tipo de proyecto que centra su inters en la gestin educativa compartida, por lo que se caracteriza en no corresponder a reas especficas de formacin. Se asume como una estrategia didctica que puede involucrar la participacin de la comunidad que rodea el centro educativo, que tiene lmites en el tiempo y resultados que se concretan mediante productos de gestin (Nikerson, Perkins y Otros, 1994). El PROYECTO PEDAGGICO INTEGRADOR (PPI) se constituye en la estrategia didctica de integracin modular que da la oportunidad al estudiante de demostrar ante la comunidad acadmica que es merecedor de forma integral de continuar con su proceso de formacin al siguiente nivel. Esto significa que el estudiante debe utilizar las competencias adquiridas durante su formacin para proponer un proyecto del nivel de formacin respectivo. Adems de lo anterior, el PROYECTO PEDAGGICO INTEGRADOR (PPI) constituye una experiencia de auto-aprendizaje para el estudiante, dado el grado de profundidad y dedicacin que este implica, convirtindolo en la experiencia perfecta de la educacin del futuro profesional del sector del software. La tcnica Profesional en sistemas de informacin del Politcnico Colombiano Jaime Isaza Cadavid fundamenta su proceso formativo en la canalizacin del esfuerzo del estudiante hacia el desarrollo de un proyecto que rena las competencias aportadas por todos los mdulos que hacen parte del semestre. Esto se entiende como una estrategia didctica que involucra lmites de tiempo y resultados que se concreta mediante productos de gestin. Para comprender la importancia del proyecto pedaggico integrador es necesario identificar que es un proceso adquirido por el estudiante para iniciar su ciclo formativo como Tcnico profesional; como su nombre lo indica integra la dinmica de enseanza y las competencias obtenidas y desarrolladas en los dems mdulos que se ven durante el semestre y su respectiva aplicacin.

OBJETIVO DEL PPI


Aplicar de manera integral las competencias desarrolladas en los diversos mdulos de los niveles en proceso ascendente de lo simple a complejo, con proyecciones hacia la creatividad y el inicio de actividades investigativas.

GUIA PARA EL EQUIPO DE ESTUDIANTES, PARA LA ELABORACIN DE SU PPI

ENTREGABLES SEMESTRE POR SEMESTRE Se define la generacin de entregables ligados al ciclo de vida del software como evidencia objetiva del proceso de aprendizaje, cada semestre el nivel de dificultad vara dependiendo de las competencias a alcanzar en los diferentes mdulos.

Recuerde Cada entregable se debe presentar en un solo documento, teniendo en cuenta la norma ICONTEC vigente.

I.M.P.O.R.T.A.N.T.E El Docente del mdulo de programacin se encarga de evaluar el cdigo antes de cada socializacin.

Los proyectos internos de clase el alcance ser asignado por el docente del mdulo sol alternativo

A continuacin se describe lo que deben entregar nivel por nivel:

Para desarrollar satisfactoriamente su PPI, tenga en cuenta los siguientes anexos, los cuales contienen los documentos necesarios para realizar los entregables: Esquema de Actividades (Anexo 1): Es una lista de actividades que facilita la creacin del diagrama de Gantt, tenga en cuenta las semanas del semestre con las diferentes actividades que aseguren el cumplimiento del proyecto. Lista de chequeo para verificar interpretacin de especificaciones (Anexo 2): Diligenciar la lista, la cual le permite al docente del mdulo sol, verificar la interpretacin del documento que se entreg. Estndar Diseo de Interfaz de Usuario (Anexo 3) Estndar para Codificar (Anexo 4) Estndar Manual de Usuario (Anexo 5)

El profesor del mdulo sol (Identificacin del Ciclo de Vida del Software), es el responsable de entregar a los estudiantes las Especificaciones proyecto asignado.

ENTREGABLE 1
Semana 8 Politcnico EL EQUIPO DE PPI DEBE ENTREGAR POR ESCRITO Diagrama de Gantt Con base en el esquema de Actividades (Anexo 1), debe construir en una herramienta ofimtica el Diagrama de Gantt. Recuerde que en el esquema, deben estar discrimina das todas las actividades de PPI, a realizar durante todo el proyecto, indicando tiempo estimado y tiempo real. Impactos y posibles beneficiarios del proyecto Debe analizar cules son los impactos y posibles beneficiarios del proyecto a desarrollar; tenga en cuenta que no todo proyecto, posee los aspectos indicados a continuacin, ya que puede ser el caso de que alguno o algunos de ellos no tengan repercusin o relevancia en el proyecto; o por el contrario, se puede determinar otro tipo de impactos en otras reas o aspectos. Impacto Social: Establezca de que manera el proyecto contribuir en el desarrollo de la sociedad y en qu sentido influirn los resultados del trabajo en determinados sectores sociales. Ejemplo: Impacto Ambiental: Indique en que aspectos el proyecto tiene beneficios o riesgos ecolgicos; o como el proyecto puede mejorar y controlar aspectos ambientales negativos. Ejemplo:

Impacto Educativo: Indicar de que manera el proyecto beneficiar generalmente o particularmente al proceso de enseanza-aprendizaje personal y/o de la sociedad. Ejemplo: Impacto Econmico: Indique las repercusiones (beneficios y/o problemas) de carcter econmico que tendr el proyecto en el mbito local, regional o nacional; se puede sealar los aspectos econmicos positivos que provocar el proyecto en los individuos, grupos o sociedad. Ejemplo:

Solucin a la lista de chequeo para verificar interpretacin de especificaciones Con base en la lista de chequeo Anexo 2 debe diligenciar parcialmente los tems con la temtica que conoce. Mapa de Navegacin Un mapa de navegacin sirve para forma parte del diseo y en este sentido es cada vez ms fundamental definir el mapa de navegacin o esquema detallado de las opciones que va a tener el usuario en cada parte del sistema. Esto supone responder a las siguientes preguntas: Hacia dnde se puede ir desde cada sitio? Siempre se puede volver al principio?

Hay varios principios? Cmo se jerarquiza? Hay secciones separadas? Se debe poder desplazar slo por cada seccin? Cuntos y qu enlaces fuera de la seccin deben existir, y por qu?

Se est simplificando mucho el concepto de enlace, y quizs es un buen punto para volver a los principios: no hay slo "enlaces", sino que hay muchos tipos lgicamente distintos: Enlaces de significado (de explicacin, de completar el concepto). Enlaces de relacin (temas relacionados) Enlaces de contexto. Enlaces de secuencia de navegacin. Enlaces jerrquicos (estructurales). Enlaces especficos de la aplicacin

Un mapa de navegacin representa una opcin ms para que el usuario conozca dnde est, por dnde ha pasado, y qu le falta por ver y le permite desplazarse dentro del mismo. RECUERDA. Un mapa de navegacin puede representarse en forma textual, en forma grfica o una combinacin de ambas. Parecida a un organigrama o rbol genealgico.

EJEMPLO MAPA DE NAVEGACIN En la figura 1, se muestra el mapa de navegacin de un producto multimedia para aprender algoritmos, con el tema especfico de ciclos. De acuerdo con la planeacin de este proyecto, el producto multimedia est compuesto por cinco pantallas: - Men principal - Presentacin del tema: Ciclos - Crditos - Ejemplos - Ejercicios

SUGERENCIA. La definicin de los elementos en el mapa de navegacin deber realizarse de forma general. La descripcin a detalle de los elementos se realizar en la etapa de diseo detallado.

Definicin de las pantallas del ejemplo anterior

Bosquejo de Ventanas Una interfaz de usuario, permite al cliente visualizar el sistema, aclarar opciones sobre los requerimientos y especificar detalles a incluir en el sistema a desarrollar. Debe tener en cuenta los estndares de diseo entregados y el mapa de navegacin elaborado por el equipo de trabajo, para implementar la funcionalidad.

Mapa Conceptual El equipo de trabajo debe realizar un mapa conceptual diferenciando la necesidad, objetivo, problema del proyecto asignado

(Semana 9)
Portada Breve explicacin del proyecto, teniendo en cuenta el mapa conceptual (Video o animacin). Duracin del video mximo 3 minutos Revisin impactos por medio de un Mapa conceptual o mental Explicacin del mapa de navegacin Avance bosquejo de formularios en una herramienta de prototipado (Pencil, balsamik mockups, idoco, cacoo entre otros) NOTA: El material a utilizar en la socializacin, debe ser entregada mximo el da viernes de la semana 9, hasta las 11m. Equipo que no haga esta entrega se lo evaluar sobre 4.0.

TENER EN CUENTA
Presentacin en una herramienta ofimtica Redaccin, ortografa Legalidad en la informacin presentada (Referenciar documentos e imgenes) Tcnicas de exposicin

ENTREGABLE 2
Semana 17 EL ESTUDIANTE ES EL RESPONSABLE DE ENTREGAR Solucin a la lista de chequeo para verificar interpretacin de especificaciones Con base en la lista de chequeo entregada, usted debe terminar de diligenciar dicho documento. Aplicacin funcionando. De acuerdo a la interfaz ya diseada y teniendo en cuenta el mdulo asignado del proyecto Debe presentar: - La ventana de ingreso al sistema (indicando usuario y contrasea)

- Una ventana que indique la implementacin de alguna funcionalidad, con el CRUDL (CreateCrear, Recovery-Consultar, Update-Actualizar, Delete-Borrar List - Listar) - De la ventana desarrollada anteriormente se debe poder generar una consulta. NOTA. El Almacenamiento de la informacin se debe hacer en Arreglos. Las funcionalidades se deben implementar en Java. Avance de Prototipo de Manual de Usuario El estudiante debe entregar avance del manual de usuario de las funcionalidades desarrolladas del proyecto, acorde a los estndares entregados. PONER MANUAL TYT

(Semana 18)
Portada Breve explicacin del proyecto, teniendo en cuenta el mapa conceptual Aplicacin funcionando (Almacenamiento de la informacin en Arreglos) - La ventana de ingreso al sistema (indicando usuario y contrasea) - Una ventana que indique el funcionamiento con el CRUDL (Create-Crear, RecoveryConsultar, Update-Actualizar, Delete-Borra, List-listar) - De la funcionalidad desarrollada anteriormente se debe poder generar una consulta. NOTA: El material a utilizar en la socializacin, debe ser entregada mximo el da viernes de la semana 18, hasta las 12m. Equipo que no haga esta entrega no se le permitir exponer.

TENER EN CUENTA:
Redaccin, ortografa. Legalidad en la informacin presentada Dominio en la exposicin proyecto Presentacin en alguna herramienta ofimtica Validacin de datos Almacenamiento de la informacin en Matrices y Vectores

SEGUNDO SEMESTRE
Para desarrollar satisfactoriamente su PPI, tenga en cuenta los siguientes anexos, los cuales contienen los documentos necesarios para realizar los entregables: Estndar Diseo de Interfaz de Usuario (Anexo 3) Estndar para Codificar (Anexo 4) Estndar Manual de Usuario (Anexo 5)

El profesor del mdulo sol (Definicin de Requerimientos o Pensamiento Analtico y Sistmico II), realiza un conversatorio con sus estudiantes sobre el alcance de los proyectos.

ENTREGABLE 1
Semana 8 EL ESTUDIANTE ES EL RESPONSABLE DE ENTREGAR Diagrama de Gantt Con base en el diagrama de actividades anexo 1, el estudiante debe construir en una herramienta ofimtica el Diagrama de Gantt actualizado. Mapa de Navegacin Un mapa de navegacin sirve para forma parte del diseo y en este sentido es cada vez ms fundamental definir el mapa de navegacin o esquema detallado de las opciones que va a tener el usuario en cada parte del sistema. Esto supone responder a las siguientes preguntas: Hacia dnde se puede ir desde cada sitio? Siempre se puede volver al principio? Hay varios principios? Cmo se jerarquiza? Hay secciones separadas? Se debe poder desplazar slo por cada seccin? Cuntos y qu enlaces fuera de la seccin deben existir, y por qu?

Se est simplificando mucho el concepto de enlace, y quizs es un buen punto para volver a los principios: no hay slo "enlaces", sino que hay muchos tipos lgicamente distintos: Enlaces de significado (de explicacin, de completar el concepto). Enlaces de relacin (temas relacionados) Enlaces de contexto. Enlaces de secuencia de navegacin. Enlaces jerrquicos (estructurales). Enlaces especficos de la aplicacin

Un mapa de navegacin representa una opcin ms para que el usuario conozca dnde est, por dnde ha pasado, y qu le falta por ver y le permite desplazarse dentro del mismo.

RECUERDA. Un mapa de navegacin puede representarse en forma textual, en forma grfica o una combinacin de ambas. Parecida a un organigrama o rbol genealgico.

EJEMPLO MAPA DE NAVEGACIN En la figura 1, se muestra el mapa de navegacin de un producto multimedia para aprender algoritmos, con el tema especfico de ciclos. De acuerdo con la planeacin de este proyecto, el producto multimedia est compuesto por cinco pantallas: - Men principal - Presentacin del tema: Ciclos - Crditos - Ejemplos - Ejercicios

SUGERENCIA. La definicin de los elementos en el mapa de navegacin deber realizarse de forma general. La descripcin a detalle de los elementos se realizar en la etapa de diseo detallado. Definicin de las pantallas del ejemplo anterior

Mapa Conceptual El equipo de trabajo debe realizar un mapa conceptual diferenciando la necesidad, objetivo, problema del proyecto asignado Avance de Programacin El avance de programacin El docente del mdulo sol le asignar a cada equipo la funcionalidad a realizar, entre ellos puede estar: - Mdulo de seguridad: Creacin de Usuarios y perfiles (mnimo 3) - Maestros con el CRUDL (Create-Crear, Recovery-Consultar, Update-Actualizar, DeleteBorrar, Listar-list) - entre otros Almacenamiento de la informacin en: o Listas y archivos para estudiantes de demanda autnoma. o Listas y Bases de Datos para estudiantes articulados
Los estudiantes articulados deben continuar con su proyecto del semestre anterior desarrollado en web.

Nota. Usted debe tener en cuenta los estndares de diseo entregados.

(Semana 9 )
Portada Breve explicacin del proyecto, teniendo en cuenta el mapa conceptual por medio de un Video o animacin. Duracin 3 minutos Explicacin Mapa de Navegacin Avance de programacin
El avance de programacin se har en java. El docente del mdulo sol le asignar a cada equipo la funcionalidad a realizar, entre ellos puede estar: - Mdulo de seguridad: Creacin de Usuarios y perfiles (mnimo 3) - Maestros con el CRUDL (Create-Crear, Recovery-Consultar, Update-Actualizar, DeleteBorrar, Listar-list) entre otros Almacenamiento de la informacin en: Listas y archivos para estudiantes de demanda autnoma. Listas y Bases de Datos para estudiantes articulados Los estudiantes articulados deben continuar con su proyecto del semestre anterior desarrollado en web.

TENER EN CUENTA
Presentacin en una herramienta ofimtica Redaccin, ortografa Legalidad en la informacin presentada (Referenciar documentos e imgenes) Tcnicas de exposicin Almacenamiento de la informacin en listas y archivos para estudiantes de demanda autnoma. Listas y Bases de Datos para estudiantes articulados

ENTREGABLE 2 Semana 17 EL ESTUDIANTE ES EL RESPONSABLE DE ENTREGAR Aplicacin funcionando. De acuerdo al mapa de navegacin, debe implementar las funcionalidades del proyecto de acuerdo a las especificaciones y estndares entregados. Mdulo de seguridad: Parametrizado, indicando Usuarios, perfiles (mnimo 3) con sus respectivos permisos, stos deben poderse modificar. Maestros con el CRUDL (Create-Crear, Recovery-Consultar, Update-Actualizar, DeleteBorrar, List-listar) Un mdulo completo que solucione una funcionalidad. Reportes predefinidos Implementar diferentes parmetros de bsqueda Requerimientos de Infraestructura y Utilidades del Sistema Debe documentar: Cules son los requisitos mnimos de memoria y disco duro, para el correcto funcionamiento de la aplicacin. Adicionalmente debe: Implementar el About o Acerca de ste debe indicar Versin, Autores y correo Avance de Prototipo de Manual de Usuario El estudiante debe entregar avance del manual de usuario de las funcionalidades desarrolladas del proyecto, acorde a los estndares entregados. PONER MANUAL TYT

(Semana 18)
Portada Breve explicacin del proyecto, teniendo en cuenta el mapa conceptual Implementacin de las funcionalidades del programa planteado, el cual debe incluir - Mdulo de seguridad: Parametrizado, indicando Usuarios, perfiles (mnimo 3) con sus respectivos permisos, stos deben poderse modificar. - Un mdulo completo que solucione una funcionalidad. Explicacin detallada del proceso implementado. - Reportes predefinidos - Implementar diferentes parmetros de bsqueda TENER EN CUENTA:
Redaccin, ortografa. Legalidad en la informacin presentada Dominio en la exposicin proyecto Validacin de datos Almacenamiento de la informacin en listas y archivos para estudiantes de demanda autnoma. Listas y Bases de Datos para estudiantes articulados

TERCER SEMESTRE
ENTREGABLE 1 Semana 8 Funcionalidad implementada Debe implementar Mdulo de seguridad: Parametrizado, indicando Usuarios, perfiles (mnimo 3) con sus respectivos permisos, stos deben poderse modificar. Maestros con el CRUDL (Create-Crear, Recovery-Consultar, Update-Actualizar, DeleteBorrar, List-listar) Nota. Desarrollo web y almacenamiento de la informacin en Base de Datos Requerimiento de Infraestructura: Utilidades del Sistema Utilizar herramientas del sistema para administrar perfiles de usuario, para el aplicativo Mnimo dos roles. Manual de Usuario Construir manual de usuario con base en los avances en el desarrollo del software

(Semana 9)
Portada Descripcin del problema, explicacin global del proyecto. Con un Video o animacin. Duracin mxima 3 minutos Manejar perfiles con sus respectivo permisos Manejo de estndares web Manejo de sesiones Avance en conocimientos en BD Mdulo de seguridad: Parametrizado, indicando Usuarios, perfiles (mnimo 3) con sus respectivos permisos, stos deben poderse modificar. Maestros con el CRUDL (Create-Crear, Recovery-Consultar, Update-Actualizar, DeleteBorrar, List-listar)

ENTREGABLE 2 Semana 16 Aplicacin funcionando. De acuerdo a las especificaciones entregadas, el estudiante debe terminar de implementar las funcionalidades del proyecto en web. Mdulo de seguridad: Parametrizado, indicando Usuarios, perfiles (mnimo 3) con sus respectivos permisos, stos deben poderse modificar. Maestros con el CRUDL (Create-Crear, Recovery-Consultar, Update-Actualizar, Delete-

Borrar, List-listar) Un mdulo completo que solucione una funcionalidad. Reportes predefinidos Usted debe realizar el diseo para estadsticas, informes dinmicos Documentacin del Cdigo segn estndares El estudiante debe documentar su cdigo de acuerdo a los estndares de java y web respectivamente. Validacin de Datos El estudiante debe realizar pruebas bsicas al proyecto. Manual de Usuario y del Sistema El estudiante debe entregar el manual de usuario y del Sistema, de acuerdo a los estndares; teniendo en cuenta el cumplimiento del alcance del proyecto. Requerimiento de Infraestructura: Utilidades del Sistema A travs de un documento explicar paso a paso como: Generar un archivo de registro del Software, cuando ste se ejecute se debe validar la autenticacin; es decir el rango de la direccin IP. Utilizar Herramientas del sistema para generar informes en el momento de instalacin, es decir: - Cmo est el Disco duro - About: Versin, Autores y correo Reflexin o lecciones aprendida El estudiante debe entregar en un documento aplicando normas Icontec las lecciones aprendidas al desarrollar el proyecto.

Semana 18
Portada Toda la aplicacin funcionando Web y Escritorio Elaborar reportes definidos por el usuario Portabilidad del software Manejo de histricos Manual de usuario y del sistema Mdulo web terminado e integrado Diseo de ayuda y a cerca de Aplicacin de las reglas del negocio a la Base de Datos

IMPORTANTE. En la semana 18 el equipo debe entregar un CD con todo su proyecto terminado y debidamente

documentado incluyendo entregables desde el 1er semestre hasta la fecha y el software terminado e integrado (incluir cdigos fuente y archivos .war y .jar)

CUARTO SEMESTRE
ENTREGABLE 1 Semana 8 Software Escritorio y web Entrega de la aplicacin completa. Requerimiento de Infraestructura: Utilidades del Sistema Utilizar herramientas del sistema para administrar perfiles de usuario, para el aplicativo Manual de Usuario y del Sistema El estudiante debe entregar el manual de usuario y del Sistema, de acuerdo a los estndares; teniendo en cuenta el cumplimiento del alcance del proyecto. Descripcin Proyecto Asignado El equipo debe describir el estado actual del proyecto asignado Avance Pruebas realizadas a la fecha Avance de pruebas realizadas al proyecto asignado

(Semana 9)
Portada Software Escritorio y web Manual de Usuario y del Sistema integrado al proyecto Descripcin Proyecto Asignado Avance Pruebas realizadas a la fecha

ENTREGABLE 2 Semana 16 Pruebas Presentar pruebas de: - Top Down o Botton up - caja blanca - caja negra Aplicabilidad Explicar la aplicacin de cada una de las pruebas realizadas. Resultado Explicar los resultados obtenidos con las pruebas realizadas

(Semana 18)
Portada Presentar pruebas de: - Top Down o Botton up - caja blanca - caja negra Aplicacin de cada una de las pruebas realizadas. Resultados obtenidos con las pruebas realizadas

ANEXOS
Anexo 1. Esquema de Actividades
Nro. Act
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22

FASE

ACTIVIDADES

planificacin planificacin Leer del documento con las especificaciones del proyecto entregado Interpretar documento de especificaciones Construir en Gannt Projet el Diagrama de Actividades Elaborar los impactos del proyecto Diligenciar (Avance) lista de chequeo para verificar interpretacin de especificaciones Interpretar estndares de Diseo Interpretar estndares para codificar Interpretar documento Manual de Usuario Elaborar Mapa de Navegacin de la solucin (walkthrough) Desarrollar un prototipo navegacional (deseable funcional) Realizar primera entrega Realizar primera Socializacin Continuar diligenciando la lista de chequeo para verificar interpretacin de especificaciones Terminar de desarrollar el software con todos los componentes Documentar el cdigo del software elaborado Elaborar manual de usuario Realizar test de pruebas Realizar lista de autoevaluacin (Reflexiones o lecciones aprendidas) Terminar diligenciamiento lista de chequeo para verificar interpretacin de especificaciones Realizar Segunda entrega Realizar segunda Socializacin

Anexo 2. Lista de chequeo para verificar interpretacin de especificaciones


ID

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23

DESCRIPCION Considera que el alcance debe complementarse? Considera que el sistema propuesto soluciona los problemas detectados en el sistema actual? Los requisitos explican la funcionalidad a implementar? Necesita mejorar o complementar los requisitos planteados para cumplir satisfactoriamente con la solucin? (Si su respuesta es si, diligencie el Anexo al final del documento) El caso de uso tiene un nombre que corresponde a la descripcin del sistema? El caso de uso tiene una identificacin de acuerdo al estndar? Esta el caso de uso asociado a algn requisito? Tiene la descripcin el propsito del caso de uso? Est definido el alcance del caso de uso y del proyecto? Estn incluidas los pre-condicin de entrada? Estn incluidas las post-condiciones de salida? Los flujos alternativos son claros y completos? La descripcin est bien definida y es consistente con la secuencia normal? El caso de uso tiene una representacin grfica y consistente con la descripcin? El caso de uso indica los actores que intervienen y describe cada una de sus actividades? Indica el estado en que debe quedar el caso de uso al ser finalizado? Tiene una secuencia normal, donde describe paso a paso la ejecucin del caso de uso del proyecto? Se encuentran definidas las relaciones entre los casos de uso del negocio? (include, extend) El documento cumple con los estndares definidos para la presentacin de casos de uso? Los casos de uso aparecen descritos con expresiones claras y concretas? En los casos de uso que se extienden es clara la funcionalidad adicional? En los casos de uso es permitido crear dos veces el mismo registro? En los casos de uso, es posible crear datos, sin la necesidad de utilizar un estndar?

SI

NO

24 Existe al menos un requisito no funcional plasmado en el caso de uso? 25 En el caso de uso de autenticacin de usuarios, si la informacin digitada es
incorrecta, el usuario puede volver a ingresar al sistema?

26 Las relaciones del diagrama de clases son coherentes de acuerdo a la solucin


planteada?

27 El diagrama de clases incluye todas las operaciones necesarias para dar solucin
al problema?

28 La documentacin del diagrama de clase detalla adecuadamente la funcin que


van a cumplir los atributos?

29 La autenticacin se puede realizar despus de ingresar a alguna funcionalidad


especfica del sistema?

30 Es posible que un usuario tenga varios perfiles? 31 Es necesario haber iniciado sesin para gestionar la informacin de los
maestros?

32 Es necesario utilizar la informacin generada en los maestros para la creacin


de una tabla transaccional?

33 En el diagrama de secuencia se observan los mtodos que llevaran las clases del
sistema?

34 El documento cumple con los estndares definidos para la presentacin de 35 36 37


diagramas de secuencia? Se definen claramente las validaciones a realizar en caso de eliminar un registro? El documento es coherente y da claridad de cmo se dar solucin al problema planteado? Con la solucin descrita en el documento se cumplen todos los objetivos planteados

Anexo 3. Estndar Diseo de Interfaz de Usuario


INTRODUCCIN El diseo de sistemas de informacin comprende varias actividades que van desde el diseo de infraestructura hasta la interfaz de usuario. Para que el sistema tenga xito, es importante contar con un buen diseo de la interfaz de usuario. Una interfaz difcil de utilizar (Problemas de usabilidad), provocar que los usuarios cometan muchos errores, o los usuarios simplemente se rehusarn a utilizar el sistema del software sin tomar en cuenta su funcionalidad. Si la informacin se presenta en forma confusa, los usuarios no comprendern el significado de la informacin. La interfaz debe utilizar trminos familiares para los usuarios y los objetos que el sistema manipula, deben estar directamente relacionados con el entorno del usuario. CARACTERSTICAS DE LAS INTERFACES GRFICAS DE USUARIO

CARACTERSTICA Ventanas

Iconos

Mens Apuntador

Grficos
Fuente. Ingeniera de Software. Ian Somerville[1]

DESCRIPCIN Las ventanas mltiples permiten que se despliegue simultneamente informacin diversa en la pantalla de usuario. Los iconos representan diferentes tipos de informacin. En algunos sistemas, los iconos representan archivos; en otros, procesos Los comandos se seleccionan de un men en lugar de teclearse en un lenguaje de rdenes. Para seleccionar opciones de un men o para indicar elementos de inters en una ventana, se utiliza el mouse. Los elementos grficos se pueden mezclar con texto en el mismo despliegue.

INTERACCIN DEL USUARIO Para realizar la interfaz de usuario, el diseador se debe hacer dos preguntas: Cmo se introducir la informacin del usuario en el software? Cmo se presentar al usuario la informacin requerida?

Una interfaz de usuario debe ser coherente debe integrar la interaccin del usuario y la presentacin de la informacin. ESTILO DE INTERACCIN Manipulacin Directa PRINCIPALES VENTAJAS Interaccin rpida e intuitiva. Fcil de aprender. Evita errores del usuario. Se requiere digitar un poco. Introduccin de datos sencilla. Fcil de aprender. Flexible EJEMPLO DE APLICACIN Videojuegos.

Seleccin de Mens

Muchos software propsito general.

de

Llenado de Formularios

Lenguaje de Comandos

Lenguaje Natural

Control de almacn. Procesamiento de prstamos en una biblioteca. Sistemas bibliotecarios de recuperacin de la informacin. Accesible a usuarios Sistemas para el manejo de casuales. horarios. Fcil de ampliar. Sistemas www de recuperacin de informacin. DISEO DE LA INTERFAZ GRFICA

Fuente. Ingeniera de Software. Ian Somerville

El diseo de la interfaz que se describe toma como referencia el estndar propuesto por Sun Microsystems en el libro Look and Feel Design Guidelines [2] TAMAO Y COLOR DE LA LETRA Usted puede usar temas para redefinir tipos de letra tipo de letra, tamaos y estilos en su aplicacin. Por defecto en cuanto a la apariencia de Java define cuatro categoras de fuentes, "de tipo estilos ": La fuente de control, la fuente del sistema, la fuente del usuario y el tipo de letra pequea.

El tamao de la fuente es una consideracin importante para los usuarios con limitaciones visuales. La tabla 1, muestra los estilos definidos por defecto en java, para la apariencia de los componentes. Tabla 1. Estilos por defecto definidos para Java Defecto Uso 12 puntos - negrilla Botones, casillas de verificacin, ttulos de mens, etiquetas y ttulos de la ventana. 10 puntos - normal Atajos de teclado en los mens y la informacin sobre herramientas (tool tips). 12 puntos - normal rbol de componentes (Mapa navegacional) y la informacin sobre herramientas (tool tips) 12 puntos normal Campos de texto y tablas

Tipo de Estilo Control

Pequeo

Sistema

Usuario

Fuente. Look and Feel Design Guidelines

Para el proyecto que vamos a desarrollar, se debe tener en cuenta lo siguiente: El tipo de letra a usar en los textos y etiquetas debe ser Arial con un tamao de 12 o 11 puntos. Se recomienda no aplicar formato cursivo o subrayado. En cuanto al uso del color en la letra debe ser negro, sobre un fondo claro. El uso del color es un aspecto importante, ya que suministra estticamente un esquema agradable y confortable al usuario.

Los colores debe ser negro sobre un fondo blanco o gris. Solo debe utilizar una fuente de color para un propsito especial, considere negrita para hacerla ms fcil de leer y una fuente de color rojo debe ser usada para identificar los campos requeridos.

VENTANAS Una ventana es un rea visual, normalmente de forma rectangular, su tamao vara dependiendo de los estndares del lenguaje de programacin; contiene algn tipo de interfaz de usuario, mostrando la entrada de datos y la salida, para uno o varios procesos que se ejecutan simultneamente. Las ventanas se asocian a Interfaces Grficas de Usuario (GUI), donde pueden ser manipuladas con un puntero (mouse). La idea fue desarrollada en Xerox PARC. Siempre se deben mantener los usuarios enfocados en una sola ventana, si es requerido para la ejecucin de un proceso la apertura de varias ventanas debe hacer la apertura de estas en forma de cascada, tal como se muestra en la siguiente imagen.

NOMBRE DE LA VENTANA Cada Ventana debe tener un nombre nico descriptivo, alineado siempre a la izquierda, debe ser en letra blanca sobre fondo azul; como lo indica la figura 1 y 2. Figura 1. Contenido bsico de una Ventana Icono Ttulo de la ventana Controles

Contenido de la ventana

CARACTERSTICAS DE UNA VENTANA PRINCIPAL Las ventanas principales son contenedores de nivel superior para los elementos de la interfaz de usuario. Una ventana principal podra celebrar una serie de contenidos integrados de fcil uso. Por ejemplo, una ventana principal de su aplicacin podra tener esta organizacin: El marco de la ventana: Contiene una barra de men y un panel. La barra de mens: Contiene mens. El panel: Contiene una barra de herramientas y/o un panel de desplazamiento y/o barra de desplazamiento. La barra de herramientas: Contiene botones de la barra. El panel de desplazamiento: Contiene un panel del editor con un plug-in kit de editor de texto con estilo. Figura 2. Componentes de una ventana principal

Fuente. Look and Feel Design Guidelines

Tenga en cuenta la aparicin de los contenedores incrustados en una ventana principal y su relacin con la estructura subyacente, como se muestra en la Figura 3. Figura 3. Partes de una ventana principal

Fuente. Look and Feel Design Guidelines

TAMAO ESTNDAR DE LA VENTANA El tamao de la ventana vara dependiendo del contenido de la misma. Se debe tener en cuenta que botones se deben colocar en fila horizontal y su tamao, debe ser el necesario para que se vean estticamente con el contenido de la interfaz. Se recomienda como mnimo 800 x 600. As como lo indica la figura 4 Tenga en cuenta que no aplican stas dimensiones en el acceso al sistema.

Figura 4. Tamao de la ventana Width 800

Height 600

Botones SIMBOLOS Los smbolos incluyen cualquier grfico (normalmente de 48 x 48 pxeles o inferior) que representa un estado o un concepto, pero no tiene asociado directamente la accin o el objeto. Los smbolos pueden aparecer dentro de los cuadros de dilogo, cajas de estado del sistema de alerta, y registros de eventos. Los ejemplos en la figura 5, muestran los grficos de un cuadro de Informacin de alerta y una caja de preguntas de alerta y un smbolo de precaucin superpuesto a un icono de carpeta para indicar un estado hipottico.

Figura 5. Smbolos

Fuente. Look and Feel Design Guidelines

El smbolo de pregunta se utiliza en un cuadro de entrada de alerta, como se muestra en la figura 6. Se debe garantizar el correcto contraste entre un smbolo de precaucin o el icono y el contexto. Figura 6. Ejemplo smbolo de Pregunta

Fuente. Look and Feel Design Guidelines

Organizacin de la informacin dentro de una Ventana La informacin debe ser ubicada en la ventana de tal forma que el usuario pueda alcanzar un mejor desempeo en la ejecucin de la tarea. La informacin ms relevante debe estar ubicada en la parte superior izquierda, y el flujo para el diligenciamiento debe ser de arriba hacia abajo o de izquierda a derecha y los botones de accin de la forma deben estar ubicados en la parte inferior de la ventana, as como se indica en el siguiente ejemplo:

INGRESO DE USUARIOS

BARRA DE MEN La Barra de men debe contener algo as en todas las ventanas del proyecto

EJEMPLOS DE ALGUNOS PROYECTOS DE SOFTWARE Software bancario

Software contable

Software para compras y ventas

SOFTWARE PARA AEROPUERTOS


Software que se utiliza para la carga y centrado de aviones comerciales

SOFTWARE EDUCATIVO PARA NIOS

SOFTWARE PARA HISTORIAS CLNICAS (Datos Bsicos e Historias Clnicas)

CUADROS DE MENSAJES

LECTURA COMPLEMENTARIA
Es necesario adelantarse a los errores que el usuario puede cometer en el uso de una interfaz, desgraciadamente en muchos sitios no se utilizan las tecnologas adecuadas, ni se hace una definicin adecuada de las diferentes tipologas de errores a las que un usuario puede enfrentarse. Una de las mayores frustraciones que un usuario puede llegar a tener en el uso de una interfaz, es que sta, no est correctamente preparada para tolerar los errores ms comunes que un usuario pueda cometer en diferentes escenarios. No hay ms que darse una vuelta por Internet y ver las diferentes respuestas que dan algunos sistemas ante diferentes situaciones en las que un usuario comete un error de forma involuntaria, o peor an, provocado por una deficiente definicin. Una correcta gestin de los errores no suele ser una de las grandes prioridades en el desarrollo de un producto, ya que en la mayora de las ocasiones se da prioridad a otros conceptos, relegando a los errores a posiciones de menor importancia. Entonces, son los equipos de desarrollo los que definen los posibles errores y los mensajes que obtiene el usuario. GRAN ERROR. Este trabajo es tarea del Consultor de Definicin (o Analista) y del Diseador de Interaccin. Los desarrolladores deben desarrollar en base a las especificaciones dadas por ellos. Algunas guas bsicas a tener en cuenta y que pueden ayudar a prevenir y gestionar los errores de forma adecuada: 1. Tipificar los errores o mensajes creando grupos lgicos: Si identificamos varios tipos errores o mensajes que pueden considerarse similares, tipificarlos o agruparlos es una buena manera de dar consistencia y orientar al usuario cuando stos se producen. 2. Prevenir el error antes de que se produzca: Identificar todas aquellas situaciones en las que un usuario podra cometer un error y adecuar el diseo para que ste no se produzca. 3. Crear ayudas contextuales: Donde no sea posible prevenir un error, debe existir una ayuda o instruccin contextual que aclare cmo se ha de realizar la accin. 4. Contextualizar el mensaje de error: Los mensajes de error, cuando se produzcan, deben ser sensibles al contexto en el que el usuario se encuentre en ese momento, huyendo de mensajes genricos. Cuanto ms concreto, mejor. 5. Redactar el mensaje de error de forma adecuada: Utilizar un lenguaje directo, cercano y comprensible, huyendo de los mensajes abstractos o tcnicos, como por ejemplo Error 42845: no se ha encontrado el usuario.

6. Ofrecer alternativas cuando el error se produce: Si el error llega a producirse no hay que limitarse a dar un buen mensaje de error contextualizado, sino que tambin hay que ofrecer alternativas funcionales al usuario para que contine en su tarea y encuentre lo que busca. 7. Tolerancia de los motores de bsqueda a los errores tipogrficos: Uno de los errores ms frecuentes es que el usuario cometa un error involuntario al escribir una cadena de bsqueda. El sistema debera contar con la tecnologa adecuada para tolerar estos errores cometidos por el usuario de forma involuntaria y sugerir las alternativas ms probables.

La correcta gestin de estos errores es una de las claves para que los usuarios utilicen un sistema de forma eficiente y no abandonen una tarea por no tener alternativas o ayudas que le faciliten conseguir su objetivo.

Anexo 4. Estndar para Codificar


ESTNDARES DE CODIFICACIN EN JAVA PARA EL PPI Se definen estndares de codificacin porque un estilo de programacin homogneo en un proyecto permite que todos los participantes lo puedan entender en menos tiempo y que el cdigo en consecuencia sea mantenible. Puede ser que el estndar de documentacin definido no sea perfecto para todas las situaciones. Si esto es as y cree que debe salirse de la norma: Documente los motivos.

1. Nombres de ficheros
Sufijos de ficheros en Java1: Cdigo fuente: .java Cdigo compilado: .class Nombres de ficheros comunes: README: Resumen de informacin importante relativa al directorio en el que est ubicado

2. Organizacin de ficheros
1

Segn las convenciones de codificacin de SUN

Un fichero consta de secciones separadas por lneas en blanco y lneas de comentario, ningn fichero debe tener ms de 2000 lneas de cdigo.

2.1 Ficheros de cdigo fuente


Cada fichero contiene una nica clase o interface. Si hay una clase privada o una interfaz asociadas a una clase pblica se puede poner en el mismo fichero. La clase pblica debe ser la primera. Ordenacin de las secciones en un fichero de cdigo fuente Estas secciones deben ir separadas por una lnea en blanco Sentencia: package xxx.yyy; Sentencias de importacin. Ej: import java.util.ArrayList;. No hay lneas en blanco entre ellas Cdigo de la clase. Va precedido por comentarios tipo javadoc con la siguiente informacin: Prlogo explicativo de la clase (opcional),autor, versin, referencias a otros elementos de cdigo si se considera que debe haberlas.

3 Sangra
Las sangras son importantes para la organizacin del cdigo. Se establecen en bloques de sentencias.

1.3. Lneas largas


Cuando una lnea no quepa en una nica lnea se debe fraccionar atendiendo a estos principios generales: Fraccionar despus de una coma Fraccionar despus de un operador Es mejor romper unidades de alto nivel que de bajo nivel. Ejemplo: longName1 = longName2 * (longName3 + longName4 - longName5) + 4 * longname6; //Correcto longName1 = longName2 * (longName3 + longName4 - longName5) + 4 * longname6; // Incorrecto Si las reglas anteriores producen cdigo confuso utilizar la sangra de 8 caracteres. Ejemplo:

// Incorrecto if ((condition1 && condition2) || (condition3 && condition4) ||!(condition5 && condition6)) { doSomethingAboutIt(); // SE CONFUNDE CON LAS ANTERIORES } // Usar esta sangra if ((condition1 && condition2) || (condition3 && condition4) ||!(condition5 && condition6)) { doSomethingAboutIt(); } // Otra alternative correcta if ((condition1 && condition2) || (condition3 && condition4) ||!(condition5 && condition6)) { doSomethingAboutIt(); }

4 Comentarios
Normas generales a seguir en toda documentacin: 1. Los comentarios deben aadir claridad al cdigo. Deben contar el por qu y no el cmo. 2. Deben ser concisos. 3. Idealmente hay que escribir la documentacin antes que el cdigo. Hay dos tipos de comentarios: Comentarios de implementacin Comentarios de documentacin. a. Comentarios de implementacin: son del tipo: // ... o /* ... */. Describen el cdigo. b. Comentarios de documentacin: son del tipo: /** ... */. Describen una visin de ms alto nivel para gente que no tiene el cdigo a mano y que slo quiere usarlo. La informacin de los comentarios no debe ser evidente, deben ser cosas que no estn contenidas en el cdigo. Los comentarios no deben estar en cajas dibujadas con asteriscos o similar ni deben incluir caracteres extraos.

4.1. Comentarios de implementacin

Comentarios de bloque: Al comienzo de cada fichero o bloque. No se usan en este proyecto Comentarios de lnea: Son comentarios explicativos de una parte pequea del cdigo. Sintaxis: // ... o /* ... */

4.2. Comentarios de documentacin


Son los comentarios destinados a ser procesados por javadoc. Se puede ver informacin adicional sobre javadoc en: http://java.sun.com/products/jdk/javadoc/writingdoccomments.html http://java.sun.com/products/jdk/javadoc/ IMPORTANTE No se pueden usar comentarios de documentacin para bloques de cdigo dentro de mtodos, porque javadoc los asigna a la primera declaracin que encuentre detrs de ellos. La sangra correcta segn SUN es: /** * Comentario sobre la clase A */ public class A { ... } Otras normas son: No se documentar lo que sea evidente Siempre se usarn los tags de javadoc para documentar los parmetros y valores de retorno, aunque slo sea para poner su nombre.

5. Declaraciones
5.1. Nmero de declaraciones por lnea

Se debe declarar cada variable en una lnea distinta, de esta forma cada variable se puede comentar por separado. Ejemplo: int level, size; // Incorrecto int level; // Correcto int size; // Size of table

Los arrays se deben declarar de este modo: double[ ] table; // Correcto double [ ]table; // Incorrecto

5.2.

Inicializacin

Inicializar cada variable en su declaracin a menos que su valor inicial dependa de algn clculo.

5.3. Localizacin
En el comienzo de los bloques. La nica excepcin es el bucle for. No se deben declarar variables con el mismo nombre que otras en un mtodo.

5.4. Declaraciones de clases e interfaces


Se siguen estas reglas: No hay espacio entre el nombre del mtodo, el parntesis y la lista de parmetros. Se abre la llave { al final de la misma lnea que la declaracin. La llave de } debe aparecer en lnea aparte con la misma sangra que el mtodo o clase que cierra.

6. Sentencias
6.1. Sentencias simples
Cada lnea debe contener una sola sentencia. Ejemplos: argv++; // Correcto

argc++; // Correcto argv++; argc++; // incorrecto

6.2. Sentencias compuestas


Son las que estn entre llaves { y } Deben estar con sangra a un nivel superior que el precedente. Todas las sentencias del tipo if o for, while, do ... while debern tener llaves aunque slo contengan una sentencia, de esta forma se evita la introduccin accidental de errores si se aaden posteriormente sentencias.

6.3. Ejemplos: Sentencias if, for, while, do ... while, switch y try... catch
Sentencia if if (condition) { statements; } if (condition) { statements; } else { statements; } If ( condition) { statements; } else if (condition) { statements; } else { statements; } Sentencia for y su nueva versin for ( initialization; condition; update) { statements; } for ( initialization; condition; update); La nueva versin del for tiene el siguiente formato for (Declaration : List) { statements; } Ejemplo. Antes:

void cancelAl l(Collection c) { for (Iterator i = c.iterator(); i.hasNext(); ) { TimerTask tt = (TimerTask) i.next(); tt.cancel(); } } Despus: Void cancelAll (Collection c) { for (Object o : c) { ((TimerTask)o).cancel(); } } Sentencia while: while (condition) { statements; } while (condition); Sentencia do-while: do { statements; } while ( condition); La sentencia switch tiene este formato y con sangra switch ( condition) { case ABC: statements; /* El comentario tambin con sangra */ case DEF: statements; break; case XYZ: statements; break; default: statements; break; } La sentencia try ... catch try { statements;

} catch (ExceptionClass e) { statements; } Si est seguida por finally: try { statements; } catch (ExceptionClass e) { statements; } finally { statements; }

6.4. Sentencias de retorno


No se pondr la expresin de retorno entre parntesis a menos que con ello d mayor claridad.

7. Espacio en blanco
7.1. Lneas en blanco
Se deben usar dos lneas en blanco entre: Diferentes secciones de un fichero de cdigo fuente Entre clases y definiciones de interfaz Se debe usar una lnea en blanco: Mtodos Variables locales de un mtodo y la primera sentencia Antes de un bloque o un comentario de lnea (para que se sepa de un vistazo que es lo que comenta) Entre diferentes secciones lgicas dentro de un fichero (ms legibilidad)

7.2. Caracteres de espacio


Se deben usar en las siguientes circunstancias: Entre un parntesis cerrado y una llave. Despus de una coma en la lista de parmetros de un mtodo. Entre operadores binarios: +, -, =, etc. Nunca entre un operador uno-ario y su operando. La sentencia for y su parntesis. Ejemplo: for (expr1, expr2, expr3); Casts. Ejemplo: myMethod((int) (cp 5), ((int) (i + 3)) + 1);+

8. Asignacin de nombres

Esta es la seccin ms importante. Las normas genricas son: 1. Se usan descriptores en ingls que dejan claro el cometido de la variable, mtodo o clase. 2. Se usa terminologa aplicable al dominio. 3. Si se usan abreviaturas hay que mantener en algn sitio una lista de lo que significan. 4. Evitar en lo posible los nombres largos (menos de 15 letras sera lo ideal) 5. Evitar nombres que difieran en una letra o en el uso de maysculas. 6. Un nombre no debera constar de ms de dos palabras. 7. No usar siglas en los nombres a menos que queden muy largos o sean siglas conocidas por todos. Cada tipo de elemento debe nombrarse con una serie de reglas determinadas. Paquetes: Todo en minsculas. Cada palabra es ms especfica que la anterior. Clases e interfaces: Nombres. La inicial en mayscula. Mtodos: Deben ser verbos. La primera letra de la primera palabra en minsculas, el resto de las palabras empiezan por maysculas. Variables: Deben comenzar por minscula. No se utilizar en ningn caso el carcter "_" Constantes: Todo en mayscula. Si son varias palabras, unidas por el carcter "_"

NOTA. La adopcin de un estndar de codificacin, slo es viable si se sigue desde el principio hasta el final del proyecto de software.

Anexo 5. Estndar Manual de Usuario


Debe explicarle al usuario como instalar el Software abc. Se recomienda hacer pantallazos de cada paso para una clara explicacin, as como lo indica el ejemplo:

1. Haga doble clic en el icono del escritorio perteneciente al Software abc versin 1.0 2. Si la base de datos se encuentra totalmente vaca sin ingresar usuarios le aparece la siguiente pantalla la cual le permite ingresar los datos del administrador del Software abc

ABC Versin 1.0 3. Cuando inicie el Software abc se le pedir su nombre de Usuario y contrasea correspondiente como aparece en la pantalla:

Despus de digitar los datos respectivos puede elegir la opcin Aceptar para entrar al Men Principal, o presionar la opcin Cerrar para salir del sistema.

USO DE MENUS Una vez este dentro del Men Principal puede navegar a travs de la Barra de Mens, situada en la parte superior de la ventana de la aplicacin, como se muestra en la pantalla:

Haga clic en el nombre del men y elemento que desea utilizar o presione las teclas Alt + la letra que aparece en el nombre del elemento y a continuacin presione la tecla Enter.

NOTA. Debe explicar el contenido de la barra de men indicando que hace cada submen; para mayor claridad se recomienda explicar las funcionalidades del sistema en cada pantalla. Reportes Dentro de la Barra de Mens la pestaa Reportes genera una ventana en la cual debe seleccionar la identificacin del usuario y la fecha de la cual desea realizar el reporte y luego de clic en el botn Mirar.

NOTA: Debe explicar cada reporte que emita el software. Ayuda

El men Ayuda es el que aparece al final de la Barra de Mens. Cuando se selecciona el men en la barra aparecern los elementos funcionamiento del sistema, caractersticas del sistema y Acerca de, en el cual aparecer el Soporte Tcnico del SISTEMA MEDITUR Versin 1.0. y El nombre de sus desarrolladores.

REFERENCIAS BIBLIOGRAFCAS

RIAS Callejas Manuel. Estndares de Codificacin. 2009 Deitel y Deitel. Java Como Programar. Prentice Hall 5ta Edicin. 2004 http://www.dosmilmastres.com/blog/revisiones-de-cdigo-y-estndares-de-codificacin/ http://www.eetimes.com/design/embedded/4008320/The-best-coding-standards-eliminate-bugs http://fido.palermo.edu/servicios_dyc/encuentro2007/02_auspicios_publicaciones/actas_diseno/artic ulos_pdf/A6029.pdf [1] Ingeniera de Software. Ian Somerville [2] Look and Feel Design Guidelines (2nd Edition) de Addison-Wesley - Sun Microsystems Inc. (Editor)

S-ar putea să vă placă și