You are on page 1of 49

UNIVERSIDAD DE TALCA

FACULTAD DE INGENIERA
ESCUELA DE INGENIERA CIVIL EN COMPUTACIN

ESTNDARES DE CALIDAD

PROFESOR:
CURSO:

NARCISO CERPA
CONSTRUCCIN Y
VALIDACIN DE SOFTWARE

EQUIPO DE CONSTRUCCIN DE SOFTWARE


15 DE SEPTIEMBRE, 2010

Informe de Estndares de Calidad

NDICE

1.- Introduccin

2.- Estndares de Calidad

2.1.- Estndares de Calidad de Programacin

2.1.1.- Estndares de Calidad para Adobe Flex 3

2.1.2.- Estndares de Calidad para C#

2.2.- Estndares de Calidad de Documentacin

15

2.3.- Estndares de Calidad de Evaluacin del Proceso

20

2.4.- Estndares de Base de Datos

22

3.- Conclusin

26

4.- Referencias

27

5.- Anexos

28

Equipo de Construccin de Software

Pgina 2

Informe de Estndares de Calidad

1.- INTRODUCCIN
A continuacin se presenta el Informe de Estndares de Calidad para el Sistema de
administracin de Causas del Estudio Jurdico Chacabuco, el cual contiene informacin
necesaria para realizar las actividades requeridas en el proceso de construccin e
implementacin del software.
Cabe sealar que para este informe se definieron estndares de diverso tipo, tales
como estndares de programacin, estndares de documentacin y estndares de evaluacin
de los procesos desarrollados. Finalmente, cabe decir que este informe constituye una
herramienta fundamental para el desarrollo de las actividades por parte de los integrantes
del equipo de trabajo durante el semestre.

Equipo de Construccin de Software

Pgina 3

Informe de Estndares de Calidad

2.- ESTNDARES DE CALIDAD


2.1.- ESTNDARES DE CALIDAD DE PROGRAMACIN
2.1.1.- ESTNDARES DE CALIDAD ADOBE FLEX 3
Primero que todo vamos a ejemplificar algunos trminos que se utilizarn bastante
en estos estndares de calidad, de modo que quede ms claro lo que representa cada
trmino en particular.
Trmino
UpperCamelCase
lowerCamelCase
lower_case

Ejemplo
AgendaAdministrativa
agregarCliente
Direccin

Ahora pasaremos a detallar los estndares de Programacin enfocados para el


lenguaje de programacin Flex. En primer lugar vamos a mencionar el formato bajo el cual
tiene que regirse el cdigo que nosotros tendremos que crear en Flex.
Tipos de archivo
Las siguientes son las posibles extensiones que puede encontrar en el lenguaje Flex:

MXML code: .mxml


ActionScript code: .as
CSS code: .css

Estructura de un MXML:
Elemento

Observacin

Un encabezado igual para todos los archivos


<?xml version="1.0" encoding="utf-8"?>

Lo primero que debe tener el archivo MXML

Encabezado que refleje que tipo de layout se


est usando en el archivo. Por ejemplo:
<mx:Canvas
xmlns:mx="http://www.adobe.com/2006/mxml"
width="100%" height="100%">
WebService y operaciones correspondientes

Siempre trabajar con porcentajes a la hora de


establecer ancho y alto de un componente, en
ningn caso utilizar un nmero arbitrario

Equipo de Construccin de Software

En esta parte va declarado todo lo relacionado a


los WebServices que se van a usar en esa clase de
Flex. El cdigo para lograr esto es el siguiente:
<mx:WebService
id
wsdl
showBusyCursor="true">
Pgina 4

Informe de Estndares de Calidad

<mx:operation
name
result
nameResult(event)fault="ErrorFaultHandler(event,
'name')"/>
</mx:WebService>
<mx:Script>
<![CDATA[
//algn cdigo
]]>
</mx:Script>
Todos los estados posibles para una clase en
particular del proyecto
Todo referente a aquellos componentes que van a
ir ingresados en el layout escogido para ese
archivo

Scripts

Estados
Componentes Visuales

Convencin Nombres:
Nombre

Convencin

Idioma

Para nuestro sistema utilizaremos el idioma Ingls para


todos los nombramientos, tanto de variables o mtodos,
como para los comentarios. Si es que alguien no se
maneja mucho con este idioma ser necesario crear
algn diccionario con los trminos ms utilizados en el
sistema de modo de consultarlo al momento que tengan
dudas sobre alguna traduccin.
Para el caso de los nombres que tendrn las variables,
hay que establecer que van a ser escritas bajo
lower_case
En el caso de los mtodos que se usaran en Flex, estos
sern escritos en lowerCamelCase
Las clases en cambio serna escritas en UpperCamelCase
Los nombres de los distintos estados van a ser el
lower_case, pero estos van a estar enumerados. Por
ejemplo: estado0, estado1, etc.

Nombres Variables

Nombres Mtodos
Nombre Clases
Nombre Estados

Estilo

Las declaraciones de variables se deben realizar en lneas separadas, como por


ejemplo:
var a:int = 10;
var b:int = 20;
var c:int = 30;
Parntesis:
o No poner un espacio entre el nombre del mtodo y el parntesis y tampoco
entre el parntesis y el argumento que se le pasa al mtodo.

Equipo de Construccin de Software

Pgina 5

Informe de Estndares de Calidad

o No poner espacio entre el nombre del objeto y su tipo.


o Para un mtodo, el parntesis de llave se abre en una lnea nueva distinta a la
que est declarado el mtodo y se cierra en una lnea nueva tambin y a la
misma altura entre ambas.
Para la indentacin, utilizar la tecla tabuladora del teclado correspondiente,
dependiendo la cantidad de veces que se utilice de la distancia a la que se quiere
indentar.
Comentarios:
o Cuando los comentarios son una sola lnea o son bastante cortos, puede
usarse la doble barra paralela.
o Mientras que cuando son ms grandes, estos deben utilizar la notacin
siguiente /** y de ah para abajo, si quiere seguir comentando debe
anteponer un * a cada lnea que vaya escribiendo para terminar el
comentario con */
o Todos los comentarios deben hacerse sobre la lnea a comentar.

Informacin de clase
Cada clase debe contener las siguientes caractersticas comentadas previas al
desarrollo de cdigo:

Nombre de la clase.
Autor de la clase.
Fecha y hora de la clase.
Fecha ltimo testing realizado.

Informacin de los mtodos


Cada mtodo debe contener las siguientes caractersticas comentadas previas al
desarrollo de cdigo:

Una breve descripcin de no ms de 3 lneas de lo que realiza el mtodo.


Las entradas y las salidas del mtodo explicando en no ms de dos lneas por cada
uno lo que pide y lo que retorna.

Equipo de Construccin de Software

Pgina 6

Informe de Estndares de Calidad

Errores
Los errores que puede arrojar el cdigo van a ser manejados de la siguiente manera:
try
{
statements;
}
catch (e:Type)
{
statements;
}

Uso de ActionScripts (.as)


En el caso de tener que utilizar archivos del tipo ActionScripts en Flex, estos van a
tener la siguiente estructura:
Elemento
Comentario Inicial
Definicin del paquete en que se usar
Aquellas libreras que se importaran
La declaracin de la clase

Observacin

Por ejemplo:
import mx.controls.DateField;
public
class
myDateField
DateField

extends

Variables estticas
Constructor
Mtodos

Adems del hecho de crear los archivos .as en el proyecto de Flex, es necesario
crear una carpeta dentro de la carpeta src del proyecto, la que se llamar misClases y la
cual contendr en su interior todos aquellos que sea necesario crear por medio de un
ActionScript.

Anidacin de componentes
Debido a las caractersticas que presenta el lenguaje de Flex va a ser necesario
anidar los diversos componentes hijos que vaya teniendo algn componente en particular,
de modo de no perderse en cuanto al seguimiento y entendimiento del cdigo. Un ejemplo
de esto es lo siguiente:

Equipo de Construccin de Software

Pgina 7

Informe de Estndares de Calidad

<mx:TabNavigator>
<mx:Container>
<mx:Button />
</mx:Container>
</mx:TabNavigator>

2.1.2.- ESTNDARES DE CALIDAD C#


A continuacin se definirn estndares de calidad para C#, y as programar
homogneamente dentro del equipo de construccin. Para ello tenemos que tener en cuenta
los siguientes puntos:

Formato

Indentacin
Una buena indentacin, nos hace ver el cdigo ms ordenado y fcil de
seguir (debug) a simple vista. Por ello vamos a definir que la indentacin la
haremos con un tab o tabulacin luego de abrir una llave para entrar ya sea a una
sentencia de control o clase de la siguiente manera.
public class Usuario()
{
prvate string nombre;
public static string retornaNombre()
{
return nombre;
}
}

Al contrario de lo anterior, lo que no debemos colocar:


public class Usuario()
{
prvate string nombre;
public static string retornaNombre()
{
return nombre;
}
}

Equipo de Construccin de Software

Pgina 8

Informe de Estndares de Calidad

Informacin de clase (Nombre programador, fecha, descripcin)


Esto nos sirve para saber que integrante del equipo es el responsable de cada
clase, su fecha de modificacin y su descripcin. En una clase nos quedara algo as.
/*
Programador: Miguel Muoz
Fecha de modificacin: 18/09/2010
Descripcin: Esta clase nos permite crear un servicio que proporcionar
informacin desde la Base de Datos hacia el Sistema Interno del Estudio
Jurdico
*/
using System.IO;
public class Usuario()
{
prvate string nombre;
public static string retornaNombre()
{
return nombre;
}
}

Informacin de los mtodos (Descripcin, entradas y salidas)


Este nos permite ver claramente antes de recorrer el cdigo saber lo que hace
el mtodo que se implemente en una clase determinada, para que en caso de
seguimiento (debug) por bsqueda de algn error, saber si este hace lo que dice su
descripcin y no otra cosa.
/*
Descripcin: Este mtodo nos permite agregar un nuevo nombre al atributo de
la clase usuario.
Entradas: Recibe como entrada un dato o parmetro de tipo string, el cual
contiene el nuevo nombre que ser guardado en la variable privada nombre.
Salidas: Este mtodo no contiene ningn tipo de salida.
*/
public static void recibeNombre(string nuevoNombre)
{
this.nombre = nuevoNombre;

Equipo de Construccin de Software

Pgina 9

Informe de Estndares de Calidad

Comentarios
Los comentarios son importantes al momento de entregar informacin y
nosotros los definimos de la siguiente manera:
Todos los comentarios que tienen ms de una lnea van a quedar entre /* */ los que
irn solos uno en la primera lnea y el otro en la ltima. Los que son de una lnea
irn luego de // de la siguiente forma.
// Comentario
/*
Descripcin: Este mtodo nos permite agregar un nuevo nombre al atributo de
la clase usuario
Entradas: Recibe como entrada un dato o parmetro de tipo string, el cual
contiene el nuevo nombre que ser guardado en la variable privada nombre
Salidas: Este mtodo no contiene ningn tipo de salida
*/

Sentencias de Control
Para las sentencias de control (if, while, for, else, switch) vamos a
estandarizar el buen uso de ellas. Para un if que contenga solo una lnea usaremos
de igual forma las llaves {} para que se vea claro lo que se est haciendo
if (dato==1)
{
return dato;
}
Al momento de tener varias sentencias que utilicen if y else estos quedaran de la
siguiente forma:
if(dato==1)
{
return dato;
}else if(dato == 2)
{
return dato;
}else
{

Equipo de Construccin de Software

Pgina 10

Informe de Estndares de Calidad

return 0;
}
Forma incorrecta:
if(dato==1)
{
return dato;
}else {
if(dato == 2)
{
return dato;
}else
{
return 0;
}
}
Para el caso que se utilicen variables booleanas, estas quedarn de la siguiente
manera utilizadas en nuestras sentencias de control:
bool vacio = true;
if(vacio)
{
return dato;
}

Forma incorrecta:
if(vacio==true)
{
return dato;
}
De la misma forma para los while
while (vacio)
{
dato++;
}

Equipo de Construccin de Software

Pgina 11

Informe de Estndares de Calidad

Forma incorrecta:
while(vacio==true)
{
dato++;
}
En caso del uso de switch, este se debe dejar en claro para que se va a utilizar y al
final de cada case debe ir el default
switch(opcion)
{
case 1:
// se hace algo
break;
default:
/*
Se puede imprimir un mensaje de opcin no vlida
*/
}

Tipo de datos ( de clase )


Esto es sumamente importante a la hora de empezar a hacer un sistema
orientado a objetos y en nuestro caso servicios. Nosotros lo que buscamos es la
encapsulacin, reutilizacin y el menor acoplamiento, ya sea, entre componentes o
servicios. Para ello debemos declarar todos los atributos de la clase (int, string, char,
etc) como private, los nicos datos que son pblicos son los mtodos estticos
(static) que accedern a estos atributos as como el constructor de la clase con la que
se est trabajando.

Convencin de Nombres

Nombres de Variables
Los nombres de las variables van a ir completos para su mayor
entendimiento, no por parte y siempre en minscula, se utilizar mayscula en la
primera letra de la palabra cuando sta est compuesta por dos nombres y estos
nombres no contendrn tilde:
string nombre;
int rutCliente;
string nombrePasaje;
string arbol;

Equipo de Construccin de Software

Pgina 12

Informe de Estndares de Calidad

Forma incorrecta:
string Nombre;
int RutCliente;
string rbol;
string nomPje;

Nombres de los Mtodos


Al igual que los atributos, los nombres de los mtodos deben ser escritos con
letra minscula cuando es una palabra simple y con mayscula la primera letra de la
segunda palabra que la compone, y el nombre debe ir completo.
public static string retornarNombre()
{
return nombre;
}
Forma incorrecta:
public static string retNom ()
{
return nombre;
}

Nombres de las Clases


Los nombres de las clases siempre deben comenzar con mayscula y no con
minscula.
public class Usuario()
{
//atributos y mtodos
}
Forma incorrecta:
public class usuario()
{
//atributos y mtodos
}

Idioma (variables y mtodos)

Equipo de Construccin de Software

Pgina 13

Informe de Estndares de Calidad

Este punto es importante, puesto que, debemos ser claros con el idioma que
utilizamos al momento de declarar variables y mtodos, por ello, se definir que
utilizaremos 100% Ingls y no una mezcla entre espaol e ingls, o solo espaol.
Quedndonos as correctamente definido:
public class User()
{
prvate string name;
public static string returnName()
{
return name;
}
public static void receivesName(string newName)
{
this.name = newName;
}
}
Forma incorrecta:
public class Usuario()
{
prvate string nombre;
public static string getNombre()
{
return nombre;
}
Public static void setNombre(string name)
{
this.nombre = name;
}
}

Equipo de Construccin de Software

Pgina 14

Informe de Estndares de Calidad

2.2.- ESTNDARES DE CALIDAD DE DOCUMENTACIN


Estndares de Documentacin
Portada:
Universidad de Talca
Facultad de ingeniera
Campus Curic
Smbolo de la universidad de Talca, su nombre y Facultad a la que pertenecemos, adems
del lugar donde se encuentra el estamento mencionado.
PLANIFICACIN
Revisin: dia de MES

Cuadro de texto donde se encuentra a que revisin corresponde, realmente se enfoca el


producto a saber cuando la tarea fue realizada.
Ttulo y Subttulo:
El titulo posee un tamao de Letra n26 con el estilo de letra Times New Roman, y el
subtitulo asociado que posee similares caractersticas solo que el tamao de letra es 20.
Panel inferior derecha:
Este cuadro de texto posee la informacin necesaria para poder observar por quien fue
realizado el documento, en que fecha lo realizo y para quien lo realizo, es lo que le da la
autoridad al proyecto. Estos datos deben estar escritos con tamao de letra n 12
Todos estos cuadros, simbolos y lo que fue descrito se realizan con letra Times New
Roman.

Uso de SVN
Los pasos a seguir para la utilizacin de SVN son los siguientes:
SVN (manejador de versiones), pasos a seguir para instalar SVN:
1. Bajar tortoiseSVN desde esta direccin http://tortoisesvn.net/downloads
2. Instalar tortoiseSVN de la forma normal
Equipo de Construccin de Software

Pgina 15

Informe de Estndares de Calidad

3. Ingresar a la siguiente direccin http://code.google.com/p/estudio-juridico/, y


luego solicitar ir a Source.
4. Al mismo tiempo crear una carpeta en documentos que contendr los
archivos ( llamarla SVN o algo similar)
5. Haciendo click derecho sobre la carpeta ir a "SVN checkout."
6. En
la

checkuot-

"Url

of

repository"
pagina

copiar

la

direccin contenida en
/estudio-juridico/

https://estudio-juridico.googlecode.com/svn/trunk/
7. Pegar en el espacio y dar "ok"
8. Ahora pueden descargar los archivos de svn haciendo click derecho>SVN update

9. Luego sobre el archivo, click derecho->SVN commit,


contrasea que est en la pagina en "googlecode.com->password.

Equipo de Construccin de Software

ingresan

la

Pgina 16

Informe de Estndares de Calidad

10. El archivo estar subido,


archivo y no la carpeta.

es

importante

hacer

commit

sobre

el

Para este caso el SVN ha respondido de la mejor manera.


En el caso de que alguien modifique un archivo, el cargo que se lleve a cabo durante ese
tiempo, debe cubrir la situacin.
La forma de trabajar y obtener comentarios ser de la siguiente manera:
Existir un documento donde se lleven a cabo los comentarios relacionados a las
modificaciones del sistema en el colegio.
Adems todas las personas deben traer previamente el sistema con sus tablas
modificadas o algn problema (ojala mnimo).
En el caso de que alguien desee dejar comentarios en el SVN se debe realizar de la
siguiente forma:
.-Abrir Archivo de Texto
.-Setear el documento de la siguiente forma:
//Nombre de Estudiante
//Asunto del Comentario
//Comentario //

Equipo de Construccin de Software

Pgina 17

Informe de Estndares de Calidad

Una vez guardado este documento, se puede subir al SVN con las instrucciones
mencionadas con anterioridad.

Uso Bitcora
La bitcora lleva un formato similar, solo que se agregan campos con informacin extra.
Fecha:
Lugar:
Tareas (a realizar y/o pendientes)
Asistentes
Tarea Extra
Todos estos documentos con tamao de letra Times New Roman Tamao N12

Ejemplos de Bitcora
Minuta
Fecha: 1 Septiembre ao 2009
Lugar: Laboratorio ICC - Edificio Construccin
Tareas:
Organizacin Entrevista y recordatorio de tareas.
Javier Gonzlez: Analizador del entorno.
Cesar Ortiz: Entrevistador Asistente y Secretaria.
Felipe Venegas: Tomador de Notas
Alex Rojas: Captura de audio.
Mauricio Caroca: Entrevista Abogado
Tareas Pendientes:
.-Definicin de formato (documentos y presentaciones al ayudante)
.-Definir una fecha para organizacin de todo lo respecto a entrevista
.-Recopilacin de informacin con respecto a la entrevista.
.-Preparacin y asignacin en la entrevista del viernes.
.-Determinacin de reunin extra-programtica (mircoles 2 de
Septiembre 13:00 hrs).

Fecha: Mircoles 2 de Septiembre.


Lugar: Laboratorio Computacin
Asistencia:
Equipo de Construccin de Software

Pgina 18

Informe de Estndares de Calidad

Mauricio Caroca
Javier Gonzlez
Csar Ortiz
Felipe Venegas
Tareas:
- Subir formato para informes (estndar) @mcaroca
- Subir info de grupo pasado @cortiz
- Subir audios y fotos, etc. @TODOS
- Transcribir notas de entrevista @fvenegas
- Buscar templates de informe de requerimientos @fvenegas @cortiz
- Resto de las tareas tenerlas a ms tardar el Viernes.
- Se fija reunin para da Domingo 6 de Septiembre a las 12:00 en

Equipo de Construccin de Software

Pgina 19

Informe de Estndares de Calidad

2.3.- ESTNDARES DE CALIDAD DE EVALUACIN DEL PROCESO


Los estndares de calidad para la Evaluacin del Proceso se dividen principalmente
en tres grupos importantes, los cuales son Control Semanal, el cual conlleva un registro de
los avances semanales de los participantes del equipo de construccin. El Control de
Release se encarga de verificar y la calidad e integridad del producto final que se le har
entrega al usuario. Por ltimo, la Evaluacin Final conlleva la determinacin de los
productos finales que se realizaron por el equipo, tanto producto entregable al usuario como
productos entregables entre pares.

Control Semanal:

Bitcora: Registrar todos problemas, soluciones y cualquier informacin relevante


ocurrida en el equipo, con los usuario, en clases, etc.
Existir un encargado de bitcora durante el Release que incluir y mantendr la
informacin de la bitcora. Para esto, se utilizar una plantilla de actividades de la
bitcora, donde se incluir cada nueva informacin.

Evaluacin de progreso individual de la revisin semanal: Se evaluar la calidad


y cumplimiento general de los productos, determinando los resultados y sus causas.

Evaluacin del cumplimiento de la planificacin: Evaluacin del avance del


proyecto segn el progreso del equipo y el cumplimiento de las actividad. Se
establecer un porcentaje de avance en el proyecto.

Evaluacin de la planificacin: Se evaluara la calidad de la distribucin del trabajo


equitativo para cada semana, respecto de trabajo por integrante del equipo,

Control de Release:

Evaluacin del producto: Se evaluar la calidad y completitud del Release un 95%


de funcionalidades aprobadas es una cota aceptable

Evaluacin de la aceptacin del usuario: Se evaluar el porcentaje de


funcionalidades del release que fueron aceptadas por los usuarios. Un 95 % de
aceptacin es una cota aceptable.

Evaluacin Final:

Evaluacin del producto Final: Completitud y calidad del producto. 95% de las
funcionalidades es una cota aceptable.

Equipo de Construccin de Software

Pgina 20

Informe de Estndares de Calidad

Evaluacin del equipo: Progreso del equipo en el proceso. Se evaluara el trabajo


en conjunto para discriminar que tan bien se trabaj en el proceso de construccin.

Evaluacin de soluciones: Evaluacin de soluciones aplicadas a los problemas


presentados durante los controles de Release y controles semanales. Se identificara
cada problema y la solucin ejecutada para su resolucin y la fiabilidad o problemas
que produjo dicha decisin.

Equipo de Construccin de Software

Pgina 21

Informe de Estndares de Calidad

2.4.- ESTNDARES DE BASE DE DATOS


1. Nombres de archivos
a. Extensin de scripts
Los scripts desarrollados deben todos seguir el mismo formato de par el nombre, la
extensin debe ser la misma, en este caso .sql
Ejemplo: insercionCliente.sql
Este nombre debe ser representativo, formado por 2 o ms palabras, en donde todas
las palabras excepto la primera deben comenzar con mayscula, no se puede usar
signos de puntuacin o smbolos, y el todas las palabras sern en espaol.
b. Nombres comnmente usados
Algunos de los nombres frecuentemente utilizados son los siguientes:
crearUsuario.sql
crearCliente.sql
actualizarCausa.sql
2. Encabezado de los scripts
a. Todos los scripts deben contar con un encabezado, el cual permite conocer de
manera rpida algunos de los datos sobresalientes del archivo.
Ejemplo:
NAME:
craerUsuario.sql
VERSION
v1.0
DESCRIPTION
Crea una nueva base de datos
USAGE
% sqlplus user/password < crearBD.sql
or in the sql editor
sqlplus> start crearBD.sql
UPDATES
user date modification

Equipo de Construccin de Software

Pgina 22

Informe de Estndares de Calidad

En este ejemplo se muestra el nombre de la base de datos al que corresponde el script,


la descripcin de su funcionamiento as como el nmero de la versin del mismo.
3. Indentacin
Es importante que cada uno de los scripts desarrollados cuente con una estructura clara
y precisa con la cual el manejo y razonamiento del cdigo se lleve a cabo de una manera
rpida y son complicaciones, los puntos relevantes para ello son los siguientes.
a. Tamao de lnea
Una instruccin no debe exceder de 60 caracteres por lnea. Por ello se
recomienda apegarse a la sintaxis para las instrucciones SQL.
b. Indentacin general.
Se recomienda dejar 3 espacios o un tabulador para los elementos que
a una instruccin.

pertenecen

Ejemplo:
CREATE DATABASE AbogadosDB;
use AbogadosDB;
CREATE TABLE usuario (
apodo VARCHAR(50) NOT NULL ,
rut VARCHAR(8),
nombre VARCHAR(100),
apellido VARCHAR(100),
direccion VARCHAR(300),
PRIMARY KEY (apodo) ;
INSERT INTO usuario(id, rut, nombre, apellido, direccion)
VALUES(victor,Victor,Silva,casa 2);}
4. Comentarios
MySQL y otros manejadores de base de datos, soportan distinta sintaxis para anotar
comentarios, los cuales se muestran a continuacin:
Sentencia para una sola lnea comentada de principio a final:
#Sentencia que rescata todos los usuarios de la base de datos
Sentencia para varias lneas o espacios cortos
/* comentario dentro de la lnea */

Equipo de Construccin de Software

Pgina 23

Informe de Estndares de Calidad

5. Sentencias SQL
A continuacin se describe la sintaxis de los comandos o instrucciones ms usados
en SQL y la forma en cmo deben estructurarse.
SELECT
La estructura para recibir registros seleccionados desde una o ms tablas es la siguiente:
SELECT + campo(s) + FROM + Nombre_Tabla(s) + WHERE condicin;
Ejemplo:
SELECT nombre FROM usuario WHERE apellido = Silva;

INSERT
La sintaxis de INSERT se utiliza al momento de insertar nuevos registros en una
tabla existente en la base de datos. Sintaxis:
INSERT + INTO + NombreTabla () + VALUES ( (datos), (...), (...) );
Ejemplo:
INSERT INTO usuario(nombre, rut,) VALUES (Victor, 16166068-k);
DELETE
Se encarga de borrar los registros de la tabla seleccionada que satisfacen la
condicin dada por where_definition.

DELETE + FROM + NombreTabla + WHERE + condicin;


Ejemplo:
DELETE FROM usuario WHERE rut = 16166068-k;
UPDATE
El comando UPDATE actualiza columnas en registros de tablas existentes con
nuevos valores. La clusula WHERE, si se da, especifica qu registros deben actualizarse.
De otro modo, se actualizan todos los registros.
UPDATE
+
NombreTabla
+
SET
+
nombre_columna2=expresin,WHERE condicin;

Equipo de Construccin de Software

nombre_columna1=expresin,

Pgina 24

Informe de Estndares de Calidad

Ejemplo:
UPDATE usuario SET nombre = Claudio, nombreAntiguo, WHERE nombreAntiguo =
nombre;
6. Procedimientos almacenados
Con Mysql workBench se pueden definir procedimientos al interior de la base de
datos para evitar consultas tediosas desde c#,
Un procedure tiene la siguiente estructura:
-- --------------------------------------------------------------------------------- Routine DDL
-- -------------------------------------------------------------------------------DELIMITER $$
CREATE PROCEDURE `mydb`.`routine1` ()
BEGIN
END$$
Usos simples de estas estructuras es el realizar procedimientos genricos como bsquedas,
un ejemplo de esto sera el siguiente cdigo:
CREATE PROCEDURE `mydb`.`busquedaGenerica` (String tipobusqueda )
BEGIN
if(tipoBusqueda==1){
select * from usuario;
}else
if(tipoBusqueda==2){
select * from cliente;
} else
if(tipoBusqueda==3){
......
END$$
Luego la consulta necesaria para rescatar los datos que se deseen sera:
Call DB.busquedaGenerica(tipoBusqueda);

Equipo de Construccin de Software

Pgina 25

Informe de Estndares de Calidad

3.- CONCLUSIN
El informe de Estndares de Calidad muestra los distintos estndares creados, que
nos permiten controlar la calidad de las actividades que se realizan durante el semestre en la
etapa de construccin e implementacin del sistema.
Sin duda, este informe junto al Informe de Testing constituyen una parte
fundamental para la elaboracin de la etapa de construccin y validacin de Software.
Durante esta etapa, se debe seguir al pie de letra los estndares de programacin,
documentacin y evaluacin con motivo de que las clases construidas por los miembros de
un equipo queden similares entre unas y otras.

Equipo de Construccin de Software

Pgina 26

Informe de Estndares de Calidad

4.- REFERENCIAS
I. Sommerville, Ingeniera del Software. 7ma. Edicin.
7. R. S. Presuman, Ingeniera del Software Un enfoque prctico. 6ta. Edicin.
Documento de Especificacin de Requisitos, Equipo de Diseo 2010.

Equipo de Construccin de Software

Pgina 27

Informe de Estndares de Calidad

5.- ANEXOS
PLANTILLA DE CONTROL DE CALIDAD CRUZADO

Nombre Control
Fecha

/ 2010

Nombre Programador
Producto evaluado
ESTNDARES DE CALIDAD
Completitud de estndares

Formato

Buenas prcticas / Calidad

Programacin C#

Programacin Flex

Documentacin

Objetivo del producto

Cumplido:

No cumplido

Estndares incumplidos

Observaciones

Equipo de Construccin de Software

Pgina 28

Informe de Estndares de Calidad

PLANTILLA DE CONTROL DE CALIDAD ENCARGADO

Nombre Encargado
Fecha

Nombre Control

/ 2010

Nombre Programador
Producto evaluado
EVALUACIN CONTROL DE CALIDAD

Estndares de Calidad

Vlido

% Formato

% Buenas Prcticas / Calidad

Invlido

Vlido

% Sugerido

Invlido

% Sugerido

Programacin C#

Programacin Flex

Documentacin

Objetivo del Producto

Validado

Seccin de control de calidad a


re-evaluar

Equipo de Construccin de Software

No validado

Observaciones

Pgina 29

Informe de Estndares de Calidad

REDISEO DE INTERFAZ INTERNA Y EXTERNA

Tipografa
Tipografa escogida: Droid Sans (Descargada desde http://code.google.com/webfonts)
Datos Tipografa Seleccionada
Steve Matteson
Droid Sans
Apache License
26kb (.zip)

Diseador
Nombre de Fuente en la API
Licencia
Peso Asociado (kb)

Caracteres asociados: Una lista con todos los caracteres que posee la tipografa en cada
uno de sus tamaos.
!
/
=
K
Y
g
u

"
0
>
L
Z
h
v

#
1
?
M
[
i
w

$
2
@
N
\
j
x

%
3
A
O
]
k
y

&
4
B
P
^
l
z

'
5
C
Q
_
m
{

(
6
D
R
`
n
|

)
7
E
S
a
o
}

*
8
F
T
b
p

+
9
G
U
c
q

,
:
H
V
d
r

;
I
W
e
s

.
<
J
X
f
t

Lista de Estndares Tipogrficos a Seguir:


Estndar Tipogrfico
1. Botones con Icono
2. Botones sin Icono
3. MenuBar
4. Barra de Estado
5. Men de Herramientas (TabBar)
6. Mensajes de Alerta o Error
7. Mensajes Interno
8. rea de accin
9. Ttulo
Equipo de Construccin de Software

Tipo de Letra
Droid Sans
Droid Sans
Droid Sans
Droid Sans
Droid Sans
Droid Sans
Droid Sans
Droid Sans
Droid Sans

Tamao (px)
12
12
12
12
12
14
12
14
16

Tipo
Simple
Simple
Simple
Simple
Simple
Simple
Simple
Simple
Simple
Pgina 30

Informe de Estndares de Calidad

Droid Sans
Droid Sans
Droid Sans
Droid Sans
Droid Sans
Droid Sans

10. Subttulo
11. Zona de Texto
12. Tooltip
13. Ayuda Titulo
14. Ayuda Subtitulo
15. Ayuda Texto

14
12
08
16,14,12
14
12

Simple
Simple
Simple
Simple
Simple
Simple

Gramtica
Frases: Toda palabra que comience una sentencia de exposicin de informacin (ej,
Listado de clientes:) o solicitud de ellos (ej, Fecha de inicio:), debe llevar su primera letra
en mayscula.
Palabras: Todas las palabras del sistema, ya sea que estn en botones, tabBars, dataGrids,
etc., deben comenzar con mayscula. (ej, Buscar, Agenda, Tribunal).
Excepciones:
Los nombres de nuestros servicios o mdulos deben escribirse con mayscula en su
primera letra.
En la barra de mdulos, los nombres de stos deben ir en mayscula (toda la
palabra).
Lenguaje: En la interfaz de usuario, todo debe ir escrito en espaol.

conos
Color y tamao
A continuacin se muestra una tabla en la que se especifican, de acuerdo al tipo de
cono y la ubicacin de este dentro del sistema, el color y el tamao de los iconos a ser
diseados. Para el color solo se especifica la luminosidad, ya que el color depender del
diseo que quiera realizar, la luminosidad indicada como alta, media o baja solo indica que
iconos debern resaltar por sobre los dems en cuanto al color (los colores con luminosidad
alta debern resaltar por sobre los de luminosidad media y baja). Por otra parte, el tamao
viene dado en pixeles, y depende del espacio disponible en el lugar donde se quiera poner
los iconos.
Tipo de icono

Ubicacin

Tamao (px)

Color (luminosidad)

Accin
Accin

Barra de herramientas
MenuBar

24X24
16x16

Media
Baja

Equipo de Construccin de Software

Pgina 31

Informe de Estndares de Calidad


Accordion
Barra de herramientas
MenuBar
Accordion
Barra de herramientas
MenuBar
Accordion

Accin
Link
Link
Link
Modulo
Modulo
Modulo

24x24
24X24
16x16
24x24
24X24
16x16
24x24

Alta
Media
Baja
Alta
Media
Baja
Alta

conos para Mdulos

Barra de Herramientas, Acorden y MenuBar

Nombre Archivo
Modulo Externo
externo.png

Icono

Nombre Archivo
Modulo Cliente
cliente.png

Modulo Causa
causas.png

Modulo Agenda
agenda.png

Agenda Econmica
agendaecon.png

Modulo Usuarios
usuarios.png

Comunicacin
comunicacin.png

Modulo Privilegios
privilegios.png

Modulo Bitcora
bitcora.png

Mensaje Ayuda
ayuda.png

Icono

Iconos para Links

Barra de Herramientas,
Herramientas Acorden y MenuBar

Nombre Archivo
word.png

Icono

excel.png

internet.png

conos para acciones

Barra de Herramientas y Acorden

Equipo de Construccin de Software

Pgina 32

Informe de Estndares de Calidad


Nombre Archivo
agregar.png

Icono

Nombre Archivo
editar.png

Icono

eliminar.png

buscar.png

cortar.png

copiar.png

listar.png

mostrar.png

validar.png

asignar.png

enviar.png

abrirsesion.png

cerrarsesion.png

abrirarchivo.png

imprimir.png

guardar.png

deshacer.png

rehacer.png

herramientas.png

mover.png

adjuntar.png

estadstica.png

mensajera.png

actualizar.png

cambiarusuario.png

recados.png

bitacoraMI.png

bitacoraRecado.png

papelera.png

vaciar.png

restriccin.png

rmodulo.png

Restriccion General

Restriccion Informacion Modulo

rinstancia.png

msjeayuda.png

Restriccion informacion Instancia

msjeerror.png

msjeok.png

msjeadvertencia.png

salir.png

aceptar.png

Salir generico

cancelar.png

Equipo de Construccin de Software

Pgina 33

Informe de Estndares de Calidad

Diseo genrico de la Interfaz Interna


Pantalla principal

En la imagen superior, aparece reflejado el diseo pensado para el mdulo interno


del sistema (primera interfaz con la que se encuentra el usuario al momento de ingresar al
sistema). En ella, se pueden observar la
las siguientes secciones:
rea de Trabajo

La cual estar ubicada en el centro de la pantalla,


y que dependiendo de la seleccin que haga el
usuario en la barra de mdulos de la aplicacin,
van a desplegarse en ese sector, las interfaces
correspondientes a dichos mdulos, manteniendo
siempre visibles los paneles alrededor a esta rea.
Posee, al igual que las otras reas adyacentes, la
capacidad de ser arrastrada y ubicada en el lugar
que el usuario estime conveniente.

Barra de Mdulos

Equipo de Construccin de Software

Pgina 34

Informe de Estndares de Calidad

En sta, se encontrarn
ontrarn todos los nombres de los mdulos (o secciones) que nosotros
definimos para nuestro sistema. Es un elemento de barra de botones (ButtonBar) y al
hacer click en cualquiera de ellos, se podr acceder al mdulo escogido.
Barra de Accesos Directos

Aqu se encontrarn todos loc accesos directos a aplicaciones externas que el usuario escoja
(como por ejemplo Microsoft Word, Excel, PowerPoint, etc) y adems, aquellos que son de
ayuda, herramientas y control de eventos (atrs, adelante, actualizar, etc.) que son propios
del sistema.
Panel de Identificacin
Una vez que el usuario haya ingresado al sistema
mendiante la interfaz externa, podr ver en la parte
superior derecha un sector de identificacin en el cual
tendr la opcin de salir del sistema
ma mediante el cierre
de sesin.
Panel del Logotipo
En l, se mostrar la imagen del logotipo corporativo
de la empresa, en nuestro caso, el del Estudio Jurdico
Chacabuco.

Panel de Recados

 Carolina Cspedes Torres


llam a las 17:30 hrs.
 Alexis Fuentes Daz
necesita que lo llam
urgente a ms tardar a las
21:00 hrs.

Equipo de Construccin de Software

ste es uno de los cinco paneles (sin contar el area de


trabajo antes mencionada) que estarn siempre visibles.
En l, se mostrarn todos los recados que hayan sido
dejados paraa el usuario y su informacin proviene del
mdulo Comunicacin.
**Puede ser arrastrado y ubicado donde el usuario estime
conveniente.

Pgina 35

Informe de Estndares de Calidad

Panel de Mensajera Instantnea

Contactos
Eugenio Urrutia
Juan Pablo Pia

En este panel, se encontrar el rea de mensajera


instantnea o chat a travs de la cual los usuarios
conectados en el sistema podrn comunicarse sin tener
necesidad de utilizar otros programas de mensajera.
**Puede ser arrastrado y ubicado donde el usuario estime
conveniente.

Panel de Requerimientos

Juan Pia Informe de


comparendo Causa 2100
Progreso: En proceso.

ste, es un panel diseado para los usuarios de tipo


cuenta limitada (o en su defecto, los trabajadores del
Estudio Jurdico), en l, aparecern los requerimientos
requeri
que los usuarios administradores les soliciten realizar.
**Puede ser arrastrado y ubicado donde el usuario estime
conveniente.

Calendario
El calendario es uno de los componentes que
utilizaremos para los requisitos asociados al mdulo
Agenda. A travs de l, queremos dar a conocer al
usuario los eventos para un da en especfico,
permitiendo en lo posible, acceder desde este
componente al mdulo correspondiente.
**Puede ser arrastrado y ubicado donde el usuario estime
conveniente.

Equipo de Construccin de Software

Pgina 36

Informe de Estndares de Calidad

Panel de Avisos

Eventos para hoy:


9:30 Juicio Oral Causa
Andrs Salgado Fuentes
(Juzgado Oral en lo Penal)
14:00 Almuerzo con don
Javier Alcntara Seplveda
(Restaurante Comida China)

Al igual que componente anterior, este panel pertenece al


mdulo de agenda. En l, se detallarn los avisos para
eventos prximos que el usuario haya ingresado con sus
respectivas descripciones.
**Puede ser arrastrado y ubicado donde el usuario estime
conveniente.

Mdulo Clientes

El diseo de este mdulo del sistema contempla trabajar con pestaas para
aprovechar de mejor manera el espacio o rea de trabajo y permite al usuario hacer todas
las opciones que ofrece el mdulo Clientes, mantener a un cliente en particular, listar todos
los clientes, buscar alguno en particular y tambin se da la posibilidad de conectarse a las
diversas Causas que estn asociadas a l. Los elementos que utiliza el mdulo Clientes son
bastante bsicos para que no compliquen al usuario, como botones o listas y campos de
texto.

Equipo de Construccin de Software

Pgina 37

Informe de Estndares de Calidad

Mdulo Causas

Similar al mdulo Clientes, Causas tambin utiliza pestaas para trabajar con los
diversos elementos dentro de este mdulo, pero adems ofrece un componente de Flex
llamado acorden que tambin permite ahorrar espacio en el rea de trabajo
trabaj y da una mejor
visibilidad a la gran cantidad de opciones que contiene este mdulo. Adems, se puede ver
que utiliza componentes bsicos como listas y botones que hacen que el usuario no se vea
complicado a la hora de interactuar con alguno de estos elementos.
elem

Mdulo Agenda

Para este mdulo incorporamos varios componentes ms como: un calendario que


muestre grficamente las opciones que tenga ste como el de desplegar un da o un mes de
Equipo de Construccin de Software

Pgina 38

Informe de Estndares de Calidad

un ao en particular. Tambin incluye un rea de Eventos en que se pueden observar cules


son aquellos eventos que tiene asociado un usuario y trabajar con ellos, como agregar
nuevos o editar los que ya estn ingresados. Tambin da la posibilidad de buscar algn
evento dentro del calendario total y as mismo un panel en el cual se podrn observar todos
los eventos que estn asociados al da, semana y mes actual, para as no realizar demasiados
cambios en la pantalla.

Mdulo Usuario

Para el mdulo Usuarios es bastante simple la interfaz ya que solamente se necesita


necesit
conocer una lista con todos los usuarios registrados en el sistema y la posibilidad de
mantener alguno de estos usuarios, as como tambin de imprimir la informacin de alguno
en particular.

Equipo de Construccin de Software

Pgina 39

Informe de Estndares de Calidad

Mdulo Comunicacin

El mdulo comunicacin esta compuesto de 4 botones ubicados en la parte


izquierda del panel principal, a partir de cada uno de estos botones se cambia el estado, para
cada uno de los estados estn desarrolladas diferentes opciones, elementales en el uso de
tanto, mensajera instantnea,
tantnea, historiales de comunicacin o publicacin de requerimientos.
En el primer estado, se observan 2 paneles, el primero posee la lista de usuarios conectados
y el segundo los paneles de comunicacin. En el segundo estado, se observa el despliege de
2 botones, uno de estos es agregar y el siguiente es suprimir, para cada uno de estos, se
observan cambios de estado relacionados. En el tercer estado, se despliegan los distintos
historiales existentes en el sistema de abogados, estos encapsulados en un StackView,
St
y
dentro de este componente, tres TabNavigator, que se encargan de subdividir los distintos
tipos de historial. En el cuarto estado, se observa el despliegue de una tarea instantanea (o
ms prxima).

Equipo de Construccin de Software

Pgina 40

Informe de Estndares de Calidad

Mdulo Papelera

La papelera del sistema contiene las mismas opciones que tienen las papeleras de
los diversos sistemas operativos que existen en el mercado. Esta le da la posibilidad al
usuario de observar por medio de una lista todos aquellos elementos eliminados y
clasificados de acuerdo al mdulo en el que se elimin, as como tambin permite la
posibilidad de restaurar algn elemento en particular o de suprimirlo definitivamente.

Mdulo Privilegios

Equipo de Construccin de Software

Pgina 41

Informe de Estndares de Calidad

En la imagen anterior se muestra la interfaz que describe al mdulo privilegios


privileg dentro
del sistema. Esta cuenta con un Combo Box para la eleccin de un usuario con cuenta
limitada (UCL) al cual se le cambiarn los privilegios de acceso al contenido del sistema,
los cuales son mdulo que permite a un usuario acceder a un mdulo en particular, objetos
del mdulo que permite a un usuario en particular acceder a ciertas partes de algn mdulo
en particular.

Mdulo Bitcora

En esta imagen se puede observar los diversos componentes que se utilizaron para
armar el diseo del mdulo Bitcora. Se puede observar que se utiliza un acorden para
almacenar todas las opciones que se pueden hacer en este mdulo, as como un botn para
Limpiar las acciones y una lista en la que aparecen todas las acciones detalladas resultantes
de los filtros que se hicieron.

Equipo de Construccin de Software

Pgina 42

Informe de Estndares de Calidad

Mdulo Ayuda

Este diseo de la interfaz para la ayuda tiene relacin a la ayuda esttica, es decir,
para aquella ayuda a la que el usuario puede consultar y que es similar a la que tiene la gran
mayora de los software utilizados y que refleja solo una parte de lo que va a significar la
ayuda en el sistema. Este diseo lo que tiene es una barra de navegacin en la cual el
usuario puede acceder a las diversas pginas de consulta que vaya visitando, as como
tambin
in acceder a la lista de los contenidos que tiene el sistema para mostrar. Esta lista de
contenidos se despliega como un rbol en el que el usuario puede acceder a diversos temas
de ayuda. El diseo contempla un rea en la que se despliega los resultados de la bsqueda
as como tambin la explicacin de algn tema en particular que el usuario haya buscado.

Equipo de Construccin de Software

Pgina 43

Informe de Estndares de Calidad

Diseo genrico de la Interfaz Externa


Seccin Publicaciones

En el home de nuestra aplicacin, se mostrarn las publicaciones que los usuarios estimen
convenientes.
En ella, podemos identificar un banner en la parte superior de la interfaz, que contendr el
logotipo del Estudio Jurdico Chacabuco.

Seguido ms debajo de una barra con los diferentes tpicos que se presentarn en la interfaz
externa, como Quines somos?, Nuestra ubicacin, Enlaces de inters, etc.

Posteriormete se encuentra el rea de presentacin de la informacin, en donde se


despleganarn todos los contenidos de los tpicos antes mencionados.
Equipo de Construccin de Software

Pgina 44

Informe de Estndares de Calidad

Y finalmente,
ente, a su derecha, el rea de ingreso tanto para usuarios como para clientes, los
cuales ingresarn al sistema interno y de citas - envo de documentos respectivamente.

Equipo de Construccin de Software

Pgina 45

Informe de Estndares de Calidad

Seccin Quines Somos?

Equipo de Construccin de Software

Pgina 46

Informe de Estndares de Calidad

Seccin Nuestra Ubicacin

Equipo de Construccin de Software

Pgina 47

Informe de Estndares de Calidad

Seccin Enlaces de Inters

Equipo de Construccin de Software

Pgina 48

Informe de Estndares de Calidad

Seccin Cliente Externo

Equipo de Construccin de Software

Pgina 49

You might also like