Académique Documents
Professionnel Documents
Culture Documents
Documento de Aseguramiento
Para la calidad del Proceso
1 INTRODUCCIN......................................................................................................3
2 ROLES Y RESPONSABILIDADES...............................................................................4
3 ESTNDARES DE DISEO........................................................................................4
3.1 Estndares de Estructura de Pgina......................................................................................... 4
3.2 Estndares de Documentacin Interna.....................................................................................7
3.2.1 Estndares de Documentacin del Cdigo Fuente............................................................7
3.2.2 Estndar de Documentacin para Objetos de la Base de Datos........................................9
3.3 Estndares de Diseo de Base de Datos..................................................................................9
3.4 Estndar de Estructura de archivos........................................................................................ 13
3.4.1 Estructura General de Archivos del Proyecto..................................................................13
4 ESTNDAR DE DOCUMENTACIN IMPRESA...........................................................14
4.1 Estndares de Prrafo y Ttulos.............................................................................................. 14
4.2 Estndares de Imgenes........................................................................................................ 14
4.3 Estndares de Tablas.............................................................................................................. 14
4.4 Ejemplo de Pagina Horizontal................................................................................................. 16
5 SOFTWARE DE DESARROLLO................................................................................17
5.1 Sistema Operativo.................................................................................................................. 17
5.2 Control de Versiones con Git.................................................................................................. 17
5.2.1 Configuracin global de Git.............................................................................................17
5.3 Versiones de Software............................................................................................................ 18
6 DOCUMENTACIN A ENTREGAR EN CADA SPRINT................................................18
7 DOCUMENTACIN PARA LA IMPLEMENTACIN......................................................19
7.1 Manual de Usuario.................................................................................................................. 19
7.2 Manual de instalacin y configuracin....................................................................................19
7.3 Manual Tcnico para mantenimiento de la aplicacin.............................................................19
8 REPORTE DE PROBLEMAS.....................................................................................20
8.1 Falla en Hardware................................................................................................................... 20
8.2 Errores en la aplicacin.......................................................................................................... 20
9 HERRAMIENTAS, TCNICAS Y METODOLOGAS.....................................................20
9.1 Herramientas de desarrollo.................................................................................................... 20
9.1.1 IDE de desarrollo............................................................................................................. 20
9.1.2 Gestor de base de datos................................................................................................. 20
Introduccin.
Universidad de El Salvador- DSI215
1 Introduccin.
Aseguramiento de la Calidad
3
Roles y Responsabilidades
Universidad de El Salvador- DSI215
2 Roles y Responsabilidades
3 Estndares de Diseo
3.1 Estndares de Estructura de Pgina.
Aseguramiento de la Calidad
4
Estndares de Diseo
Universidad de El Salvador- DSI215
el contenido que podrn visualizar los usuarios. Para facilitar el desarrollo de las pginas web se
establece el estndar que se observa en la Imagen 3-1: Estndar de Estructura de Pgina., lo
que permitir una interfaz de usuario amigable y fcil de utilizar manteniendo esta estructura y
diseo durante toda la navegacin por el sitio web.
Aseguramiento de la Calidad
5
Estndares de Diseo
Universidad de El Salvador- DSI215
Aseguramiento de la Calidad
6
Estndares de Diseo
Universidad de El Salvador- DSI215
Cuadro 3-1 Descripcin de los Elementos de la Estructura de Pgina.
Objetivo.
Estructura Ejemplo
/* /*
*Nombre del mdulo: * Nombre del mdulo: Gestin de departamentos.
*Direccin fsica: * Direccinfsica: src/Minsal/SimBundle/Entity/CtlDepartamento.php
*Objetivo: * Objetivo: Clase que permite realizar la persistencia con la tabla
**/ * ctl_departamento en la base de datos.
**/
Cuadro 3-2 Ejemplo de encabezado para documentacin de archivos.
b. Lmites de seccin: Se especificarn los lmites de cada seccin importante dentro del
cdigo fuente de cada archivo, estas secciones incluyen: mdulos, funciones, definicin de
variables o estructuras de datos, iteraciones (loops), algoritmos especiales y otras que el
desarrollador considere necesarias. En el Cuadro 3-3 se presentan ejemplos de este
estndar:
Lenguaje Ejemplo
HTML <!Inicio de Modulo o Funcin-->
Lnea de Cdigo 1
//
Lnea de Cdigo N
<!Fin de Modulo o Funcin-->
PHP /*Inicio de Modulo o funcin*/
Aseguramiento de la Calidad
7
Estndares de Diseo
Universidad de El Salvador- DSI215
Lnea de Cdigo 1
//
Lnea de Cdigo N
/*Fin de Modulo o Funcin */
Cuadro 3-3 Ejemplo de documentacin de lmites de seccin.
Lenguaje Ejemplo
PHP /* Inicio de Modulo o funcin
* Objetivo: calcular la prxima fecha de mantenimiento
*/
public function calcularFecha( ) {
Lnea de Cdigo 1
Lnea de Cdigo N
}
/*Fin de Modulo o Funcin*/
Cuadro 3-4 Ejemplo de documentacin de objetivos de funciones o mdulos.
Lenguaje Ejemplo
PHP $variable = valor; //almacena el valor de
Lnea de Cdigo 1
Lnea de Cdigo N //registra el nuevo cambio
Cuadro 3-5 Ejemplo de documentacin de otros comentarios.
Lenguaje de Comentario
programacin
PHP /* Este es un comentario
* de ms de una lnea para php
*/
Aseguramiento de la Calidad
8
Estndares de Diseo
Universidad de El Salvador- DSI215
de varias lneas para javascript */
// Este es un comentario de lnea para javascript
XML <!-- Este es un comentario en lenguaje de etiquetado -->
HMTL <!-- Este es un comentario en HTML -->
PostgreSQL (Scripts SQL) -- Este es el comentario estndar SQL.
/* Este es un comentario de varias lneas SQL */
Cuadro 3-6 Sintaxis de comentarios segn lenguaje de programacin.
Aseguramiento de la Calidad
9
Estndares de Diseo
Universidad de El Salvador- DSI215
Estndares para el Diseo de la Base de Datos
Consideraciones Generales Ejemplo
Deben tomarse en cuenta las siguientes consideraciones:
No usar espacios en blanco para los nombres de los
objetos.
No utilizar letras maysculas, ni tildes tampoco
caracteres especiales.
Usar guion bajo (_) para separar las palabras.
Nombre de la Base de Datos
El nombre usado para la base de datos debe ser definido sim
usando un nombre corto y se recomienda usar el nombre del
proyecto todo en minsculas.
Nombres de Tablas
Durante el nombramiento de las tablas de la base de datos Nombre de tabla:
se deben tomar en cuenta las siguientes recomendaciones: mnt_orden_trabajo,
Nombres auto-descriptivos: Los nombres ctl_establecimiento,
utilizados para definir las tablas deben de ser en lo ctl_especialidad
posible auto-descriptivos, y evitar el uso de
abreviaciones. Se recomienda ampliamente el uso de
nombres cortos. Nombre de tabla de
Nombres en singular: Los nombres de las tablas referencia:
deben de ser definidos en singular. En el caso de ctl_especialidad_establecimi
nombres de tablas con ms de una palabra ambas ento
deben estar en singular separadas por un guin bajo.
Prefijos: Dentro de la base de datos pueden existir
ciertas tablas que necesiten agruparse segn la
lgica del negocio. En estos casos puede ponerse un
prefijo de entre dos a cuatro caracteres para
identificar el grupo o modulo al que pertenecen.
Tablas de referencia: Los nombres de las tablas
que son usadas para guardar referencias deben de
definirse en lo posible usando el nombre de ambas
tablas.
Tablas catlogos: el nombre estar compuesto por
el prefijo ctl de la siguiente forma:
ctl_nombre_catalogo.
Aseguramiento de la Calidad
10
Estndares de Diseo
Universidad de El Salvador- DSI215
Nombres de Campos
Las columnas son atributos de la entidad, es decir, las
columnas describen las propiedades de la entidad por tanto
los nombres de las columnas deben ser representativos y
naturales.
El campo que ser llave primaria debe llamarse id y debe de
ser autoincrementable. Dicho estndar es necesario ya que
el Paquete de Doctrine lo requiere de esta forma como llave
primaria.
El nombre de la columna que contenga una llave fornea
hacia otra tabla dentro de la misma base de datos, deber de
ser la siguiente: id_nombre_tabla_padre sin incluir prefijos.
Usuario de la Base de Datos
Se debe crear un usuario dueo de la createuser -DRSP nombre_usuario
base de datos sin permisos de creacin
de base de datos, ni roles, ni ser sper D: No puede crear base de datos
usuario. Con permisos solo sobre la
R: No puede crear roles
base y sus objetos relaciones.
S: No es superusuario
P: Para que muestre un mensaje en donde se
pida la contrasea del nuevo usuario.
Llaves Primarias
Las llaves primarias es la columna que identifica cada fila en pk_pais
cada tabla. Para nombrarlas se utilizar:
pk_nombre_tabla
Nota: Si se trabajara con Symfony2 y Doctrine2 no se
pueden realizar llaves primarias compuestas; por ende crear
un campo auto-numrico como llave primario y se debe
crear un ndice para que los dos campos sean nicos.
Llaves Forneas
Por convencin estas pueden nombrarse de la siguiente fk_asignatura_estudiante
forma:
fk_nombre_tabla_padre_nombre_tabla_hija
Si las tablas padre e hija poseen prefijo, cuando se nombre
la llave fornea debe ir sin el prefijo que posee.
Vistas
Se nombran con un nombre significativo de la vw_estudiante
informacin que contienen utilizando el prefijo vw_
Aseguramiento de la Calidad
11
Estndares de Diseo
Universidad de El Salvador- DSI215
Procedimientos
Los procedimientos pueden nombrarse de acuerdo a lo que proc_calcular_nota_asignatu
ellos realizan dentro de la base de datos; puede utilizase un ra
verbo en infinitivo para describir dicha accin. Deben
comenzar con el prefijo proc_.
Triggers o Disparadores
Durante el nombrado de los triggers se deben tomar en tgr_actualizar_transaccion
cuenta las siguientes recomendaciones:
Prefijos: se usar prefijo trg, que es ampliamente
recomendado con el propsito de hacer saber que el
objeto en la base de datos es un trigger.
Nomenclatura: son procedimientos especiales que
se ejecutan luego de una determinada accin en una
determinada tabla. Para nombrarlos, al igual que los
procedimientos se puede utilizar un verbo en
infinitivo precedido del nombre de la tabla a la que
pertenece. Por ejemplo:
trg_accion_tabla
Excepciones: las funciones a las que hacen referencias los
triggers se deben llamar con el mismo nombre del trigger
agregando el prefijo fn_nombre_trigger.
ndices
Los ndices solo existen para una determinada tabla, para idx_numero_orden
uno o ms campos separados por guion bajo (_). Para
nombrase puede ser de la siguiente manera:
idx_nombre_campo(s)
Documentacin Interna
Se debe realizar un comentario para cada campo, tablas, /* ctl_departamentos, este
procedimientos, triggers o cualquier elemento que contenga es un catlogo de los
la base de datos; esto con el fin de tener claros las departamentos de El
funcionalidades de los elementos que constituyen la base de Salvador
datos. La documentacin debe de ser descriptiva y no */
redundante.
Aseguramiento de la Calidad
12
Estndares de Diseo
Universidad de El Salvador- DSI215
Directorio app: Contiene los archivos necesarios para configuracin del Sitio Web, adems
contiene un directorio cach que permite que el acceso a la aplicacin se realice de manera
ms rpida, un directorio logs en el que se registra los diferentes eventos que suceden
dentro del sistema, y un directorio resources, que contiene los diferentes archivos (recursos)
que pueden ser utilizados en todo el Sitio Web.
Directorio src: Contiene los diferentes Bundles, que se hayan creado dentro del sistema,
cada Bundle contiene el conjunto de directorios y archivos que almacenan la lgica del
sistema.
Directorio vendor: dentro de este directorio, se almacenan libreras (Bundles) con una
funcionalidad especfica a utilizar, que pertenecen a terceros. Los vendor no deben
modificarse. En caso de necesitar modificar la funcionalidad existente, Symfony brinda
maneras de sobreescribir dicha funcionalidades sin hacerlo directamente sobre el vendor.
Directorio web: Contiene archivos que necesitan ser accedidos de forma pblica, como por
ejemplo: imgenes, hojas de estilo y archivos JavaScript. Tambin es el lugar donde reside
cada Controlador Frontal.
Ejemplo de prrafo, sangra en la primera 1.25 cm de distancia, Espaciado superior 0.00 cm,
espaciado inferior 0.25cm, Interlineado: Proporcional 120%.
Aseguramiento de la Calidad
13
Estndar de Documentacin Impresa
Universidad de El Salvador- DSI215
Ejemplo de prrafo, sangra en la primera 1.25 cm de distancia, Espaciado superior 0.00 cm,
espaciado inferior 0.25cm, Interlineado: Proporcional 120%.
El texto debe de ser tipo Open Sans de tamao 9pt y en negrita, con alineacin centrada y
espaciado superior e inferior de 0.10 cm.
Para aplicar el estndar de formato de tabla dirigirse al men Tabla Formato Automtico,
se mostrar una ventana emergente de la Lista de Formatos disponibles elegir el que tiene por
nombre minsal-tabla1.
Las tablas al igual que las imgenes deben de ser etiquetados cuya estructura serealizar de
la siguiente manera:
Nombre de la Etiqueta: Puede usarse la Etiqueta Tabla o Cuadro, o ambas solo es de tener
Aseguramiento de la Calidad
14
Estndar de Documentacin Impresa
Universidad de El Salvador- DSI215
claro cuando se utilizar cada una. Se recomienda utilizar solamente una a la vez para no
generar confusin.
El texto debe de ser tipo Open Sans de tamao 9pt y en negrita, con alineacin centrada y
espaciado superior e inferior de 0.10 cm.
Aseguramiento de la Calidad
15
Estndar de Documentacin Impresa
Universidad de El Salvador- DSI215
Aseguramiento de la Calidad
16
Software de Desarrollo
Universidad de El Salvador- DSI215
5 Software de Desarrollo
5.1 Sistema Operativo
Se deber determinar qu requerimientos de tecnologa de informacin (hardware, software,
redes) y de recursos humanos sern indispensables para que el sistema opere correctamente. En
cuanto al software requerido para desarrollar el sistema y su posterior puesta en produccin, ste
necesariamente deber ser software bajo licenciamiento libre y gratuito.
Se deber utilizar Debian 8.0 Jessie tanto para desarrollo como produccin; pero tambin
puede utilizarse cualquier otra distribucin libre nicamente para desarrollo de los sistemas
garantizando que esta funcione en Debian 8.0 al momento de implementarla.
Velocidad
Diseo sencillo
Completamente distribuido
Desde su nacimiento en 2005, Git ha evolucionado y madurado para ser fcil de usar y an
as conservar estas cualidades iniciales. Es tremendamente rpido, muy eficiente con grandes
proyectos, y tiene un increble sistema de ramificacin (branching) para desarrollo no lineal.
3. Confirmas los cambios, lo que toma los archivos tal y como estn en el rea de preparacin,
y almacena esa instantnea de manera permanente en tu directorio de Git.
gitconfigglobaluser.name"Nombredelapersona"
Aseguramiento de la Calidad
17
Software de Desarrollo
Universidad de El Salvador- DSI215
gitconfigglobaluser.emailcorreoElectronico
gitconfigglobalcolor.uitrue
gitconfigglobalcore.editorvim#SloenelcasoquesedeseequeVIM
seaeleditorpredeterminado.
.
Aseguramiento de la Calidad
18
Documentacin a entregar en cada Sprint
Universidad de El Salvador- DSI215
Que se entregar al terminar el sprint (Clculo de la duracin del sprint)
Burndown chart
Carta de Aceptacin del usuario del segundo sprint. (Junto con atestados que
considere necesarios para verificacin, puede ser fotos, videos, etc)
Casos de Uso
Diseo Fsico
Diccionario de Datos
El Sprint Retrospective
Aseguramiento de la Calidad
19
Reporte de problemas
Universidad de El Salvador- DSI215
8 Reporte de problemas
8.1 Falla en Hardware
Al momento de la falla se enviar un correo a ..
2. Netbeans 8.2
Aseguramiento de la Calidad
20