Documentos de Académico
Documentos de Profesional
Documentos de Cultura
Renuncia:
Usted puede descargar libremente y completar las plantillas de blog.cm-dm.com, para
producir documentación técnica. Los documentos producidos con el llenado de las plantillas
están fuera del alcance de la licencia. De cualquier manera, la modificación de la plantilla
para producir una nueva está en el alcance de la licencia y no está permitido por la misma.
Para cumplir con la licencia, le sugiero que mantenga la siguiente frase al menos una vez
en las plantillas que almacene, utilice o distribuya:
Esta plantilla es propiedad de Cyrille Michaud, Términos de la licencia: ver en http://blog.cm-
dm.com/post/2011/11/04/License
TABLA DE CONTENIDOS
1 Introducció n 3
1.1 Generalidades del Documento 3
1.2 Alcance 3
1.3 Abreviaciones y Glosario 3
1.4 Referencias 3
1.5 Convenciones 4
2 Gestión de Proyecto 5
2.1 Equipo – RRHH 5
2.2 Responsabilidades 5
2.3 Cliente -Usuario Involucrado 5
2.4 Tareas – Planificación - Hitos 5
2.5 Ambiente de Ingeniería 5
2.6 Otros Recursos 5
2.7 Modelo de Ciclo de Vida del Software 5
2.8 Revisiones 5
2.9 Gestión de la Configuración de Software 6
2.10 Gestión de la Documentación 6
2.11 Verificación 6
3 Especificaciones 7
3.1 Estados 7
3.2 Performance 7
3.3 Safety, security, and privacy protection 7
3.4 User maintenance 7
3.5 Usability and human-factors engineering 7
3.6 System environment 7
3.7 External interfaces 7
3.8 Resources 8
3.9 Internal data 8
3.10 Adaptation 8
3.11 Verification 8
3.12 Personnel and training 8
3.13 Packaging and installation 8
4 Architecture – Conception 9
4.1 Architecture 9
4.2 Conception 9
5 Verification 10
5.1 Test Plan 10
5.2 Tests Description 10
6 Tests Results 12
6.1 Rationale for decision 12
6.2 Results 12
7 Requirements traceability 13
1 Introducción
Resumen:
É sta es la plantilla all-in-one para el desarrollo de software
Esta plantilla no cubre la gestió n de riesgos
La misma es completada incrementalmente durante el proyecto.
Sugiero que incremente el nú mero de la versió n cuando un capítulo esté completo:
• Rev1: capítulo 1 & 2
• Rev2: capítulo 3 & 4
• Rev3: capítulo 5
• Rev4: capítulo 6
Capítulo 7 es completado en la revisió n 1 y revisió n 2.
1.2 Alcance
1.2.1 Identificación
Este documento aplica al desarrollo del proyecto del dispositivo XXX.
1.2.2 Introducción
Introducció n al Proyecto
1.3.1 Abreviaciones
Agregue aquí las abreviaciones
1.3.2 Glosario
Agregue aquí las definiciones
1.4 Referencias
1.5 Convenciones
Los requisitos listados en este documento son construidos de acuerdo con la siguiente
estructura:
Id del Requisito
Título del Requisito
Descripció n del Requisito
Ejemplo:
SRS-XXX-000
Título de requisito XXX-000
Descripció n del requisito XXX-000
Convenció n de la tipografía.
Cualquier otra convenció n.
2 Gestión de Proyecto
Para cada una de las sub-secciones, si usted ya posee una SOP en su SGC que cubra este tó pico,
agregue la referencia a la SOP, y una breve explicació n de ser necesario.
Esta secció n describe la estructura organizacional del Proyecto XXX.
2.2 Responsabilidades
El equipo posee las siguientes responsabilidades dentro del Proyecto:
Technical Manager: XXX
Project Manager: XXX
XXX
2.8 Revisiones
El proyecto comienza con la Revisió n de Lanzamiento y termina con la Revisió n Final.
Durante el proyecto ocurren dos tipos de revisiones:
Revisiones de Diseñ o
Revisiones de Ensayo
La Revisión de Lanzamiento es una reunió n formal, documentada, y sistemá tica durante la que
los miembros del equipo de Proyecto se familiarizan con los objetivos del proyecto, y toda otra
informació n contenida en el plan de gestió n.
Las Revisiones de Diseño son reuniones formales, documentadas, y sistemá ticas durante las
cuá les el diseñ o actual de un producto (sistema, sub-sistema, etc.) es revisado y comparado con
los requisitos. La Revisiones de Diseñ o está n agendadas en la planificació n del proyecto. Los
Objetivos de las Revisiones de Diseñ o son: valorar de manera crítica el diseñ o y desarrollo en
concordancia con los requisitos, y confirmar y aprobar los aspectos técnicos.
Las Revisiones de Ensayo son reuniones formales, documentadas, y sistemá ticas durante las
que cuáles el diseñ o actual de un producto es ensayado. La Revisiones de Ensayo está n
agendadas en la planificació n del proyecto.
La Revisión Final es una reunió n formal, documentada, y sistemá tica durante la cual el
Presidente/Project Manager/Otro valida el producto XXX (ver proceso de validació n en el plan
de aseguramiento de calidad de software ref. X). La revisió n contiene también una parte
dedicada a la realimentació n de experiencia sobre el progreso del proyecto y sobre los procesos
usados durante el proyecto.
2.11 Verificación
Describir có mo se realizan y gestionan las verificaciones. Revisiones, documentació n, … Ver
también capítulo 5
3 Especificaciones
Este capítulo es un extracto de la plantilla de las Especificaciones de Requisitos de Software (SRS
– Software Requirements Specifications). Revise la plantilla de SRS para ver algunos ejemplos de
requisitos.
3.1 Estados
El software XXX trabaja en N estados:
Inicio: El software carga sus componentes;
En uso: Todas las funcionalidades del software está n disponibles para el usuario;
Detenido: El software ha sido detenido;
Mantenimiento: El software está en modo mantenimiento;
Y así…
Agregue un diagrama con los estados y las transiciones si es necesario.
3.2 Desempeño
Este en el nú cleo de sus SRS. Contiene el propó sito de su software expresado en requisitos
técnicos.
Cuá les son sus funciones
Cuá les son los algoritmos utilizados
….
3.5.2 Ayuda
La guía de usuario es siempre muy importante para un dispositivo médico. Podría estar online,
en ese caso agregue aquí los requisitos para la ayuda online.
Una venta de “Acerca de” es una buena manera de identificar la versió n de software.
3.8 Recursos
En qué ambiente corre el software.
3.10 Adaptación
Si hay requisitos específicos de adaptabilidad de configuració n de software.
3.11 Verificación
Funciones especiales de ensayo de software, si es necesario. Por ejemplo, una funció n oculta
para activar el archivo de log durante el ensayo beta.
4 Arquitectura – Concepción
4.1 Arquitectura
No mandatorio para clase A
4.2 Concepción
Absolutamente no mandatorio para Clase A.
Pero, si usted quiere hacer un mejor trabajo:
Si hay algunas partes que merecen una concepció n má s detalladas, descríbalas aquí
Ej. un algoritmo específico, gestió n de memoria cache, detalles acerca del uso de un framework,
de una librería, de un protocolo de comunicació n, de un modelo de base de datos…
5 Verificación
Este capítulo es mandatorio.
Advertencia, este documento asume que hay solo una fase de ensayo.
Describa el set de datos utilizados durante los ensayos. Su identificació n, estructura, contenido,
localizació n, almacenamiento (la estructura y contenido podría estar ya descripto en los
documentos de concepció n)
• Archivo de entradas (input files),
• Archivos de datos (data files),
• Scripts para generar datos,
• Archivos de Salida (Output files), Historial (log files)
Describa qué documentació n es entregada para los ensayos (ej. Este documento, Instrucciones
de Uso…), si es impresa u online.
Si se require hardware específico: papel en formato exó tico, un cronó metro, una regla, un willy
waller 2006,
Y también pizzas, cervezas, RedBull, champagne….
ID Ensayo T-REQ-001
Descripció n del Breve descripció n
ensayo
Requisito que SRS-REQ-001 Método de verificació n: I,A,D,T
Verifica
Condiciones Iniciales El estado del software antes del Usted puede referenciar a un
ensayo procedimiento o podría ser el
resultado de un ensayo previo.
Entradas al Ensayo Datos de entrada de alguna Usted puede referenciar a un
herramienta de ensayo, nombre de procedimiento para utilizar la
archivo de entradas y localizació n herramienta de ensayo.
Acciones para Registro y post-procesamiento de Usted puede referenciar a un
Recolectar Datos los datos de salida. procedimiento para registrar los datos
con una herramienta de ensayo.
Salidas del Ensayo Nombre de los Archivos de Datos de Dar un nombre ú nico a los archivos de
Salida, localizació n, historiales, …. datos de salida.
Supuestos y De haberlos podrían ser: acceso
Limitaciones limitado a una herramienta,
licencias, ….
Resultados Liste aquí los resultados del ensayo Y los criterios para evaluar los
esperados y criterios resultados.
Procedimiento de
Ensayo
Número Paso Acciones del Operador Resultados Esperados y Criterios
de Evaluación
1 INICIO DEL SOFT SOFT ES INICIADO
6 Resultados de Ensayo
6.2 Resultados
Dar un poco de informació n acerca de los ensayos.
El software XXX (versió n x.y.z) ha sido ensayado en la plataforma de ensayoo xxx localizada en
xxx, desde el día dd/mm/aaaa dd/mm/aaaa. Los ensayos de la fase de pruebas (ref. plan de
ensayo de software) fueron ejecutados.
Los evaluadores fueron: John Doe, Marc Smith
Repita la lista de ensayos, con una o má s columnas llamadas “resultados”.
En resultados agregue OK, NOK, NO EJECUTADO. Si es NOK, agregue una identificació n a la falla.