PLANTILLAS DE DOCUMENTO PARA

PROYECTOS ESCOLARES EN
INGENIERA DE SOFTWARE
Declan Brown y Stephen Delaney
Departamento de Ciencias de la Computacin,
Universidad Nacional de Irlanda, Maynooth
Fecha: Agosto 2002
Informe Tcnico: NUIM-CS-TR2002-05
Resumen
Este informe tcnico describe el contenido de un conjunto mnimo de
desarrollo de software documentos, adaptados para su uso por los estudiantes
en proyectos de ingeniera de software, y con firmeza sobre la base de
Estndares IEEE. El conjunto de documentos est diseado para apoyar las
actividades de desarrollo de software. Lo proporciona un marco para su uso en
proyectos de pregrado de ingeniera de software, tanto individual y en equipo,
que ayuda a los estudiantes a aprender las mejores prcticas. Un informe
complementario describe la contenido de cada documento con ms detalle.

1. Antecedentes.
Los proyectos son una parte importante de la educacin de los
ingenieros de software. Ellos forman una mtodo activo de enseanza, segn
lo definido por Piaget, dando lugar a una formacin "en la auto-disciplina y
esfuerzo voluntario "[1], que es importante para los profesionales de
ingeniera de software. Dos propsitos servido por estos proyectos son: la
educacin en la prctica profesional y los resultados basados en evaluacin,
como se seala en el Currculo ACM / IEEE Computing 2001 [2]. Una
infraestructura debe proporcionar a las estudiantes estn bien guiados en su
aprendizaje, sin embargo, tienen una oportunidad de mostrar sus logros
individuales a efectos de evaluacin. Esta corresponde a los "integrational'and
'differential'modes de la educacin segn lo descrito por Cook en
"Medicin Educativa" [11].
Proyectos de ingeniera de software, tal como se define por la IEEE /
EIA, consisten en un nmero de actividades de desarrollo [10]. Cada actividad
se caracteriza por un conjunto de productos, normalmente en forma de cdigo
o documentacin. Proporcionar un modelo estructurado para la
documentacin de software 2ayuda tanto a la educacin y los aspectos de la
evaluacin de un proyecto de ingeniera de software. Estos plantillas
proporcionan una gua para el formato esperado y el contenido de los
entregables de documentacin basado en las normas internacionales. Tambin
proporcionan un marco para la evaluacin de la proyecto de los estudiantes,

con base en los resultados finales. Tenga en cuenta que este informe no
especfica criterios de evaluacin: se describe la documentacin de
desarrollo. Adems, no cubre la documentacin del producto (manual, manual
de referencia, manual de instalacin, o interno documentacin) o el informe
del alumno proyecto.
Segn los estndares de la industria de la mayora de los proyectos de
los estudiantes que normalmente no se justifica la elaboracin de un
documentacin completa establecida. Sin embargo, como parte del proceso
educativo, es importante que los los estudiantes se les ensea a documentar su
trabajo de acuerdo a las mejores prcticas. No es necesario que todos los
proyectos de produccin de cada documento se describe aqu, pero desde un
punto de vista educativo, y teniendo en cuenta que los estudiantes se
embarcar en una carrera profesional, no son distintos beneficios de cada
estudiante para hacerlo. Revisin de entregas de actividad es una parte
fundamental de asegurar calidad de productos de software y el estado del
proyecto de seguimiento, y esto requiere una comprensin de lo documentos
son necesarios [15]. Otro aspecto importante de las mejores prcticas en la
documentacin, incluidos en estas plantillas, es la gestin del riesgo.
El conjunto de documentos mnimo, y el contenido de cada documento,
se ha derivado de la IEEE completo conjunto de documentos de ingeniera de
software, basada en la experiencia de los autores en desarrollo de software e
ingeniera de software profesional docente. Muchos otros las universidades
han elaborado directrices para la documentacin final de ingeniera de
software aos estudiantes (por ejemplo [12] y [13]); las plantillas descritas
aqu estn basadas en la ms reciente Estndares IEEE y los EE.UU. MILSTD-498 [14].
2. Vista general de la documentacin.
En la tabla siguiente se identifica el conjunto mnimo bsico de software, e
identifica las actividades que
producirlos.
Documento
Entregables
Descripcin
Actividades
(IEEE / EIA 12207.2 hasta 1.997) [10]
Proyectos de Software
Manejo
Plan (PAPS)
Descripcin del software
enfoque y asociado
hitos.
Sistema de anlisis de requerimientos
Software anlisis de necesidades
Software

Requisitos
Especificaciones
(SRS)
Descripcin de la esperada
caractersticas del software,
limitaciones, interfaces y
otros atributos.
Proceso de implementacin
Software de diseo
Descripcin
(SDD)
Descripcin de la forma de la
software cumpla con la
requisitos. Tambin
describe la justificacin de
decisiones de diseo tomadas.
Sistema de diseo arquitectnico
Software de diseo arquitectnico
Software de diseo detallado
Software de prueba
Documentacin
(STD)
Descripcin del plan y
especificaciones para verificar y
validar el software y el
resultados.
Pruebas de software calificacin
Sistema de pruebas de calificacin
IEEE trminos y abreviaturas que se han utilizado a lo largo, lo que
proporciona la exposicin a la
terminologa profesional de los estudiantes, y tambin reduce la ambigedad.
2.1 Propsito de cada documento
Documento Resumen del Propsito
SPMP
Para documentar los entregables acordados y fechas.
SRS
Para documentar los requisitos acordados con el supervisor del proyecto, para
proporcionan la base para el diseo, proporcionar la base para la prueba del
sistema.
SDD
Para documentar las decisiones de diseo y el diseo con el fin de
proporcionar la
base para la implementacin y prueba unitaria
STD

Para documentar cmo el software se pondr a prueba y registrar los

resultados.
Pgina 3

3
3. Secciones comunes para el conjunto de documentacin.
Cada documento dentro del conjunto recomendado tiene algunas
caractersticas comunes. El siguiente
pginas se incluyen en cada documento:
I. Cubierta de pgina (contenido y diseo)
Nombre del Documento
Ttulo del proyecto
Documento nmero de versin
Fecha de impresin
Ubicacin de la versin electrnica de los archivos
Departamento y la Universidad
II. Revisiones pgina (contenidos)
? Resumen
? Nuestro publico
? Los miembros del equipo del proyecto
? Historia de control de versiones:
Versin
Autor (s) principal
Descripcin de la Versin
Fecha de terminacin
Proyecto / final
? Firmas de Aprobacin
III. Material Adicional (contenidos)
CUESTIONES ADICIONALES?
DFINITIONS??, SIGLAS Y ABREVIATURAS
REFERENCIAS?
APNDICES?
4. El contenido de la documentacin.
Los siguientes cuatro pginas de identificar el contenido de cada
documento. Una descripcin detallada
de los contenidos sern proporcionados en un informe tcnico en el futuro. El
contenido no es un rgido
definicin, sino una gua en cuanto a las caractersticas ms relevantes de cada
documento. Estos deben estar
adaptado para reflejar la importancia de cada proyecto. Documentacin
producida durante
aplicacin no est cubierta; estos resultados son por lo general en forma de
cdigo ejecutable, el usuario

documentacin e implementacin de un diario / cuaderno de registro de la

ingeniera
la ejecucin del trabajo del estudiante. Las especificaciones y los resultados
de, las pruebas unitarias son tambin
considerado como parte de la aplicacin.
Page 4

4
Proyecto de Software de Gestin Plan (PAPS)
Pgina de tapa
Revisiones de la pgina
Tabla de contenidos
1
INTRODUCCIN
1,1
Descripcin del proyecto
1,2
Entregables del proyecto
2
ORGANIZACIN DEL PROYECTO
2,1
Modelo de Procesos de Software
2,2
Roles y Responsabilidades
2,3
Herramientas y Tcnicas
3
PROYECTO DE PLAN DE MANEJO
3,1
Tareas
3.1.n
Tarea n
3.1.n.1
Descripcin
3.1.n.2
Entregables e hitos
3.1.n.3
Recursos necesarios
3.1.n.4
Las dependencias y restricciones
3.1.n.5
Riesgos y Contingencias
3,2
Asignaciones

3,3
Calendario
4
MATERIAL ADICIONAL
Normas pertinentes de la IEEE: IEEE-1058 [8], IEEE-1540 [9]
Page 5

5
Requisitos Especificaciones de Software (SRS)
Pgina de tapa
Revisiones de la pgina
Tabla de contenidos
1
INTRODUCCIN
1,1
Descripcin del producto
2
REQUISITOS ESPECFICOS
2,1
Requisitos de interfaz externa
2.1.1
Interfaces de usuario
2.1.2
Interfaces de hardware
2.1.3
Interfaces de Software
2.1.4
Protocolos de comunicaciones
2,2
Caractersticas del software del producto
2,3
Atributos del sistema de software
2.3.1
Confiabilidad
2.3.2
Disponibilidad
2.3.3
Seguridad
2.3.4
Mantenibilidad
2.3.5
Portabilidad
2.3.6
Rendimiento

2,4
Requisitos de base de datos
3
MATERIAL ADICIONAL
Entre las normas IEEE: IEEE-830 [4]
Pgina 6

6
Descripcin del software de diseo (SDD)
Pgina de tapa
Revisiones de la pgina
Tabla de contenidos
1
INTRODUCCIN
1,1
Diseo Web Introduccin
1,2
Requisitos Matriz de Trazabilidad
2
SISTEMA DE DISEO ARQUITECTNICO
2,1
Sistema elegido Arquitectura
2,2
Discusin de los diseos alternativos
2,3
Descripcin del sistema de interfaz
3
DESCRIPCIN DETALLADA DE LOS COMPONENTES
3. N
Componente-n
4
DISEO DE INTERFAZ DE USUARIO
4,1
Descripcin de la interfaz de usuario
4.1.1
Imgenes de pantalla
4.1.2
Objetos y Acciones
5
MATERIAL ADICIONAL
Normas pertinentes de la IEEE: IEEE-1016 [7]
Page 7

Documentacin del software de prueba (STD)

Pgina de tapa
Revisiones de la pgina
Tabla de contenidos
1
INTRODUCCIN
1,1
Descripcin general del sistema
1,2
Ensayo de aproximacin
2
PRUEBA DE PLAN
2,1
Caractersticas que debe ser probado
2,2
Caractersticas del no a la prueba
2,3
Herramientas de prueba y Medio Ambiente
3
CASOS DE PRUEBA
3. N
Case-n
3. N .1
Propsito
3. N .2
Entradas
3. N .3
Resultados esperados y Pasa / Falla criterios
3. .4 N
Procedimiento de ensayo
4
MATERIAL ADICIONAL (incluyendo el apndice A)
APNDICE A. REGISTROS DE PRUEBA
Un
Inicie sesin para la prueba n
An1
Resultados de las pruebas
An2
Reporte de Incidentes
Normas pertinentes de la IEEE: IEEE-829 [3], IEEE-1008 [5], IEEE-1012 [6]
Page 8

8
Referencias

[1] HE Gruber & JJ Vonche [eds.], The Essential Piaget, Basic Books, 1977
[2] Computing Curricula 2001, La Fuerza de Tarea Conjunta sobre Planes de
Estudio Informtica,
Informe Final, IEEE Computer Society, Association for Computing
Machinery,
15 de diciembre 2001
[3] IEEE Std. Norma IEEE 829-1998 de Documentacin de pruebas de
software
[4] IEEE Std. 830-1998 IEEE Prctica recomendada para los requisitos de
software
Especificaciones
[5] IEEE Std. 1008-1997 Norma IEEE para Pruebas de Software Unidad
[6] IEEE Std. 1012-1998 IEEE estndar para la verificacin y validacin de
software
[7] IEEE Std. IEEE 1016-1998 Prctica recomendada para el diseo de
software
Descripciones
[8] IEEE Std 1058-1998 Norma IEEE para los Planes de Gestin de
Proyectos de Software
[9] IEEE Std 1540-2001 Norma IEEE for Life Cycle Software ProcesosRiesgos
Manejo
[10] IEEE 12207.2-1997 implementacin en la industria de la Norma
Internacional
ISO / IEC 12207: 1995 (ISO / IEC 12207) Norma para la Tecnologa de la
Informacin Software Procesos del Ciclo de Vida - Consideraciones de implementacin
[11] EF Lindquist (Ed.), Medidas para la Educacin, Consejo Americano de
Educacin, 1951
[12] R. McCauley y Jackson U., "Enseanza de Ingeniera de Software
Temprana Experiencias y resultados ", en Actas de los 1998 Frontiers in Education
Conferencia (FIE'98), IEEE, 1998.
[13] R. Thomas, G. Semeczko, H. Morarji, G. Mohay, "Ncleo de Ingeniera
de Software
Temas: Un Estudio de Caso ('86 - '94) ", en Actas de la Educacin Software
Conferencia de 1994, Pginas: 24-31, IEEE, 1995
[14] MIL-STD-498 estndar militar, Desarrollo de Software y la
Documentacin,
EE.UU. Departamento de Defensa, 05 de diciembre 1994
[15]
E. Yourdon, Rise
y
Resurreccin
del
programador
estadounidense, Yourdon
Press, 1996