Beruflich Dokumente
Kultur Dokumente
Junio 2008
Junio
Proyecto FÉNIX Guía de especificación de DAN Fecha
2008
DOCUMENTO/ ARCHIVO
REGISTRO DE CAMBIOS
INDICE
1 Introducción....................................................................................................................................4
2 Estilo de los DAN............................................................................................................................4
2.1 El contenido.............................................................................................................................4
2.1.1 Nombre del documento ....................................................................................................4
2.1.2 Objetivos ..........................................................................................................................5
2.1.3 Ámbito ..............................................................................................................................5
2.1.4 Módulo .............................................................................................................................5
2.1.5 Procesos ..........................................................................................................................8
2.1.6 Mantenimientos genéricos..............................................................................................11
2.1.7 Estilo y herramientas de redacción .................................................................................14
2.2 El continente..........................................................................................................................15
2.2.1 Carátula..........................................................................................................................16
2.2.2 Hoja de control ...............................................................................................................16
2.2.3 Índice..............................................................................................................................18
2.2.4 Cabeceras y pies............................................................................................................19
2.2.5 Módulo ...........................................................................................................................20
2.2.6 Apéndices.......................................................................................................................21
2.2.7 Estilos.............................................................................................................................21
2.2.8 Tablas ............................................................................................................................25
2.2.9 Ilustraciones y diagramas ...............................................................................................26
2.2.10 Actualización y grabación ...............................................................................................27
2.2.11 Ortografía .......................................................................................................................28
1 INTRODUCCIÓN
El presente documento tiene por objetivo describir la forma de redactar los documentos de Diseño de
Alto Nivel, indicando las mejores prácticas y las prohibiciones que se aplican a los documentos. Un
DAN es un documento técnico y como tal debe ser redactado y leído. Esta guía pretende determinar
las directrices a seguir a la hora de redactar un DAN tanto en su fondo como en su forma.
2.1 El contenido
El nombre del documento es el nombre que identifica al documento dentro del proyecto. El nombre
debe ser lo suficientemente descriptivo como para permitir identificarlo entre una cantidad
considerable de documentos. Por otro lado, la codificación del archivo seguirá la siguiente pauta:
FENIX-Sistema-Etapa-XX-Nombre-Vv.r.doc
Donde
o Requisitos.
o Análisis.
o Diseño.
o Manual.
• XX: número identificador del fichero en el caso de que el documento se componga de varios
ficheros. Se comienza a contar por 01 con incrementos de una unidad. El contador se aplica a
la terna (FENIX, Sistema, Etapa).
• Vv.r: versión del documento, con formato versión.release (v.r), comenzando en 1.0 e
incrementando la release cada vez que se entrega una versión al cliente del proceso. Los
cambios de versión se informarán.
2.1.2 Objetivos
2.1.3 Ámbito
Se ubicará el documento en el ámbito del proyecto, indicando qué documentos están relacionados con
el presente documento.
2.1.4 Módulo
Se realizará una descripción del módulo explicando los conceptos funcionales implicados y ámbito de
la ejecución. Todos los módulos (abstrayéndolo como un proceso de orden superior) se componen de
entradas y salidas, por lo que habrá que definir las mismas: entradas (pantallas, ficheros,…) y salidas
(objetivo) conjuntamente con el módulo en sí.
Apartado Descripción
3 Módulo
Descripción Descripción realizada al principio del
apartado. Si es necesario incluir algún
diagrama que refleje la relación entre
Común para cada módulo
módulos se incluirá.
Uno por módulo
Apartado Descripción
controles de la pantalla o subproceso y los
efectos que tiene.
3.1.3.3 Validaciones
Descripción Se definirán todas las validaciones que se
deben realizar para garantizar la integridad
referencial y la consistencia de la base de
datos.
3.1.3.4 Resultados
Descripción Se especificará cómo se genera el resultado
esperado, en qué consiste, formato, tablas
afectadas, informes generados.
3.2.3.1 Mantenimiento de X
Descripción Se describirá la entidad a mantener, haciendo
referencia a las entidades físicas implicadas.
En caso de mantenimiento genérico
3.2.3.1.1 Búsqueda de X
Descripción Se describirá qué elementos están implicados
en la búsqueda de ítems de la entidad X.
3.2.3.1.2 Consulta de X
Descripción Se describirá qué elementos se muestran en
la consulta de un ítem de la entidad X.
3.2.3.1.3 Modificación de X /
Nuevo X
Descripción Se describirá qué elementos están implicaos
en la modificación o creación de un nuevo
elemento de la entidad X.
La explicación de todo el módulo se realiza en el apartado Tema a tratar, que deberá tener un título
que identifique el módulo que se trata. Se realizará una descripción funcional del mismo, explicando
los conceptos empleados y el objetivo del módulo. Cada módulo se divide en procesos, y a
continuación se explican los distintos apartados que componen los módulos.
2.1.5 Procesos
Cada proceso que componga un módulo se explicará en este apartado. Se comenzará con una
descripción funcional del mismo. Un proceso se compone de:
Subproceso / Pantalla Para cada subproceso o pantalla que componga el proceso se definirán
una serie de características descritas en 2.1.5.3 Subproceso / Pantalla.
El mapa de navegación que se incluya seguirá los patrones establecidos previamente mediante la
plantilla Visio creada a tal efecto. Se incluirá el mapa de navegación como imagen (ver 2.2.9
Ilustraciones y diagramas) y nunca como objeto Visio.
Se incluirá el diagrama de datos de las entidades implicadas en el proceso y de las que estén
relacionadas directamente, sin mostrar las de niveles siguientes. Así, por ejemplo, si una entidad A
tiene una FK a B y ésta una FK a C, en el diagrama se mostrarán las entidades A y B con la relación
que les une. Si la entidad C estuviera relacionada directamente con el proceso se incluiría en el
diagrama.
El diagrama se incrustará como imagen para evitar sobrecargar el peso del documento e irá centrado
en la página. Si no cupiera por el número de entidades se dividirá en dos partes.
Después del diagrama se explicarán las entidades implicadas aclarando qué se almacena en cada
entidad y en cada columna, mapeando cada campo con el concepto funcional que representa, con el
objeto de no tener que mapear en la descripción de los procesos los controles de la pantalla con las
columnas de la base de datos.
Se evitará la operación de cortar-y-pegar, ya que el significado o rol de cada entidad en cada proceso
puede variar, por lo que la copia de una descripción de otro documento puede no ser apropiada para
el que se esté redactando.
En el caso de que este subproceso maneje conceptos funcionales distintos a los definidos en la
descripción del proceso, se deberán incluir en este aparado
Se incluirá el prototipo generado en Visio y se detallarán todas las particularidades que sean
necesarias y no estén incluidas en el DAN general.
Teniendo en cuenta de que un proceso se compone de entradas, proceso y salidas, lo que se deberá
definir de cada proceso (en este caso subproceso) será lo mismo. El siguiente diagrama ilustra el
mapeo entre los componentes básicos enumerados y las partes que componen la descripción de un
subprocesos. Los componentes equivalentes se colorean del mismo color y las flechas claras ilustran
la relación.
2.1.5.3.1 Pantalla
En el caso de una pantalla, se definirá cómo se realizará la carga inicial de la pantalla, indicando las
excepciones no cubiertas en la descripción del diagrama de datos, indicando cómo se ordenan los
controles, alienaciones, tamaños y formatos, afectando a todos los controles, de forma que quede
claro por qué campo(s) ordenar las listas, anchos de las columnas, filas previstas, formatos de los
combos, controles complejos empleados y cualquier otro aspecto que deba ser contemplado por el
constructor.
En el caso de un subproceso se definirá de dónde se toma la información y cómo está (o debe estar).
2.1.5.3.3 Interacciones
En el caso de una pantalla se definirá cómo interactúa el usuario con los controles de la pantalla y los
efectos que tiene cada operación.
En el caso de un subproceso se definirá qué realiza el proceso, especificando todos los cálculos que
fueran necesarios
2.1.5.3.4 Validaciones
Se definirán todas las validaciones que se deben realizar y satisfacer, indicando qué hacer en caso de
no satisfacerse y los mensajes de error a mostrar. Se especificará qué campos son obligatorios,
formatos, chequeos y dependencias.
Se especificará cómo se genera el resultado esperado, en qué consiste, formato, tablas afectadas,
informes generados.
Los mantenimientos genéricos son aquellos que afectan a una sola entidad aunque ésta tenga
relación con otras. No aplica a las tablas Maestro-Detalle ni otras estructuras de datos compuestas.
Para la definición de estos procesos de mantenimiento genéricos se emplearán una serie de tablas
descritas a continuación.
Se deberá indicar qué tabla es la que se está manteniendo con la descripción de sus campos con las
siguientes salvedades:
• Tabla tipo (las que tienen ID, CODIGO y FECHA_BAJA): se indicará únicamente que es una tabla
tipo, por lo que se deduce que tiene la estructura especificada ID, CODIGO, FECHA_BAJA.
• Tabla tipo internacionalizable (las que tienen ID, CLAVE y FECHA_BAJA): se indicará únicamente
que es una tabla tipo i18n, por lo que se deduce que tiene la estructura especificada ID, CLAVE,
FECHA_BAJA.
2.1.6.1.1 Búsqueda de X
Se divide la pantalla de búsqueda en dos partes: filtro y lista de resultados. Para cada parte se
empleará una plantilla distinta.
• Filtro: tiene una cabecera común y una lista de controles. Para cada control perteneciente al
filtro se especificará:
Filtro
Etiqueta Control Campo Observaciones
Lista de resultados
Columna Campo Observaciones
2.1.6.1.2 Consulta de X
Para cada campo que se visualice en la pantalla de consulta se especificará una línea de la siguiente
tabla con los siguientes datos:
• Etiqueta: literal que identifica el campo. Se especificará el texto que deba mostrarse.
Las pantallas de modificación y alta se describen con la siguiente plantilla, con funcionamiento similar
al del filtro de la búsqueda: tiene una cabecera común y una lista de controles. Para cada control se
especificará:
• Etiqueta: se indicará qué literal identifica al control de de la pantalla. Se deberá especificar tal y
como se deba mostrar en la pantalla.
A la hora de describir el módulo, proceso, pantalla, subproceso, entradas, salidas u otros aspectos se
deberán seguir los siguientes preceptos:
• Se realizará una escritura impersonal, evitando frases como “cuando pulsamos el botón”, “nos
lleva a…”. Siempre se puede traducir a impersonal: “cuando se pulsa el botón”, “se va a…”.
• Se evitará emplear los verbos “meter” y “sacar” salvo que sean propios del lenguaje funcional
del sistema.
• El objetivo final del documento es el entendimiento, por parte de construcción, de las tareas a
realizar, por lo que en caso de que el redactor se vea incapacitado para explicar claramente el
objetivo por medio de un párrafo, siempre lo puede reestructurar con:
Cuando se tenga que referir a otro apartado del documento se realizará mediante un comentario al
apartado correspondiente por medio de referencias cruzadas, (Insertar | Referencia | Referencia
cruzada) que muestra un índice de los apartados del documento:
• Acto seguido se modifica el valor del combo “Referencia a:” y se selecciona “Texto del párrafo”
y se vuelve a insertar y se cierra el diálogo con el botón Cancelar .
2.2 El continente
El continente es el formato y aspecto del documento, capítulo, apartado, párrafo, tabla o figura.
2.2.1 Carátula
• Logo de AENOR.
o Título: Título del documento compuesto de las propiedades Título y Asunto (Archivo |
Propiedades | Resumen). Una vez especificadas las propiedades, se pulsará F9 sobre
estos campos para actualizarlos.
• Control del documento: indica quién ha elaborado el documento, quién lo revisa y aprueba. El
recuadro último indica quién lo acepta como responsable final.
2.2.3 Índice
El índice del documento se genera automáticamente, por lo que habrá que actualizarlo justo antes de
grabar en disco para ello, habrá que posicionarse sobre el índice y pulsar sobre “Actualizar campos”.
Una vez seleccionada la opción, se muestra un diálogo en el que se podrá especificar una de dos
opciones. Se seleccionará “Actualizar toda la tabla” y Aceptar .
Las cabeceras y pies no se actualizan automáticamente por lo que habrá que actualizarlas una a una.
Una vez realizada la actualización de la cabecera, se hará lo mismo con el pie, actualizando
únicamente el nombre del sistema, ya que el número de página es estándar.
2.2.5 Módulo
Ya se ha descrito cómo atender al contenido de los módulos. Para la forma de los mismos se
emplearán los estilos referidos en 2.2.7 Estilos convenientemente.
Se evitará introducir saltos de página, líneas en blanco, tabuladores y otros caracteres especiales de
formateo de documentos dejando a los estilos definidos el formateo del mismo.
Si se desea introducir una página apaisada se deberá insertar un salto de sección y posteriormente
configurar la nueva sección como orientación apaisada. Además habrá que insertar las cabeceras y
pies de página respetando los de las secciones anteriores.
Se crearán tantos apartados como sea necesario, con el nivel de anidamiento conveniente, pero se
tratará de realizar grupos con un único elemento, por ejemplo:
1.1.1.1 Prerrogativas
1.1.2 Apéndices
En el ejemplo se ve que el apartado 1.1.1 sólo tiene una división (1.1.1.1) de nivel inferior, que no
tiene sentido. Ocurre lo mismo con las listas (numeradas o no), por ejemplo:
• Del ingreso:
o Del ingresado:
Nombre.
Apellido 1.
Apellido 2.
• Del alta:
Se ve que “Del ingreso” y “Del ingresado” es lo mismo ya que una unidad se divide en otra unidad, lo
que hace que sean equivalentes.
2.2.6 Apéndices
En el caso de incluirse apéndices en el documento se hará al final, indicando para cada apéndice el
nombre que le corresponde. Por ejemplo “Apéndice 1. Lista de valores posibles”.
En el caso de los apéndices se incluirán todos dentro de un capítulo denominado “Apéndices” que
tendrá estilo “Título 1” y situado al final del documento. Cada apéndice será de nivel 2, con
numeración occidental, un punto y el nombre del apéndice, por ejemplo “Apéndice 1. Lista de valores
posibles”.
2.2.7 Estilos
Título 5 Alt + 5
Título 6 Alt + 6
Título 7 Alt + 7
Título 8 Alt + 8
Título 9 Alt + 9
2.2.7.1 Títulos
Los títulos nunca se escribirán en mayúsculas y por tanto se seguirán las normas ortográficas
descritas en el apartado 2.2.11 Ortografía. No hay que sorprenderse porque al escribir en minúsculas
el texto se convierta a mayúsculas. No se incluirán espacios en blanco ni tabuladores al principio ni al
final de los títulos.
Después de los títulos no se debe dejar ninguna línea en blanco, ni antes de ella. El espaciado
correspondiente ya está incluido en el estilo.
2.2.7.2 Texto
Para todo el texto del documento se empleará el estilo Normal ( Alt + N ) salvo las listas (enumeradas o
sin enumerar), código fuente, nombres de tablas y campos (estilo Fuente), botones (estilo Botón),
tablas (estilo Tabla RFEF).
A los puntos y aparte no se les añadirá ningún retorno de carro adicional. El estilo Normal ya tiene
preparado un espaciado antes y después de cada párrafo.
Los estilos tienen ya están configurados para dar un aspecto al texto, por lo que:
• No se emplearán resaltadores de color salvo que se quiera marcar algo, y nunca deberá estar
en la versión entregable.
2.2.7.3 Viñetas
Las viñetas son listas no numeradas para enumerar elementos de una colección
Se empleará el estilo “Estilo Con viñetas” ( Alt + V ), el cual tiene la estructura ya prefijada, como se
muestra a continuación:
Para cambiar entre los órdenes, se sitúa el cursor sobre la línea o párrafo a cambiar y se pulsa
Ctrl + Alt + para incrementar el orden (1º2º3º…) o Ctrl + Alt + para decrementar el orden
(3º2º1º). Si esto no funcionase se deberá copiar el estilo de otro existente, por medio del botón de
copia de formato ( ).
Todos los párrafos de las viñetas comienzan con mayúscula y acaban con un punto y aparte. En caso
de necesidad se podrá comenzar con minúscula, siempre que se trate de un literal que deba ser
escrito así y trasladado textualmente a un proceso.
Automáticamente, al pulsar el retorno de carro, se genera otro párrafo con el mismo estilo que el
anterior. Si se desea cancelar las viñetas, se pulsará la tecla de borrado hasta que el cursor se
situé en el margen izquierdo del documento o Alt + N para poner el estilo Normal.
Las listas numeradas se emplearán cuando se requiera enumerar una lista con un orden determinado
y deban estar clasificadas. Se empleará para las listas numeradas el botón ( ) y para cambiar de
nivel se usarán las mismas teclas que en las viñetas. Se prohíbe alterar el orden de numeración
proporcionado por la plantilla.
2.2.7.5 Fuentes
Las partes de los textos que se refieran a nombres técnicos se escribirán en formato Fuente. Los
nombres de las tablas, de los campos, los valores de los mismos también se detallarán en estilo
Fuente. Por ejemplo: “se accede a la tabla SOLICITUDES y se busca la correspondiente al club y que el
estado sea ‘estados.club.cerrado’”.
Para aplicar el estilo, se seleccionará el fragmento de texto al que aplica y se pulsará Alt + F .
Si por error se pone como estilo Fuente un fragmento no deseado y ya no se puede deshacer, se
seleccionará el texto a corregir y se establecerá como estilo Normal ( Alt + N ).
2.2.7.6 Botones
Cuando el texto se refiera a un botón de la aplicación, al nombre de éste se le aplicará el estilo Botón
( Alt + B ), evitando así comillas u otros estilos. Al igual que el estilo de las fuentes, el estilo Botón aplica
a los caracteres seleccionados. No se incluirán espacios delante ni detrás del nombre. Dentro del
botón se incluirá el texto del mismo, por lo que cualquier carácter al que se aplique el estilo
conformará la etiqueta del botón. También se puede aplicar a las teclas que haya que pulsar Por
ejemplo:
• Ctrl + 1 : realiza…
El estilo Tabla RFEF ( Alt + T ) se aplica a todas las tablas que se incluyan.
2.2.8 Tablas
Los títulos de las columnas irán en negrita. En el caso de que haya muchas columnas se podrá optar
por poner el nombre de las columnas con el texto girado 90º en sentido contrario a las agujas del reloj.
Conviene configurar la tabla para que el encabezado se repita si hay un salto de página en mitad de la
tabla. Para ello:
• En la pestaña Filas se marca como activo el check “Repetir como fila de encabezado en cada
página.
Las ilustraciones se incrustarán como “Mapa de bits independiente del dispositivo” o “Imagen
(metarchivo mejorado)”.
Irán centrados ( ). Es obligatorio hacer que el párrafo anterior se mantenga junto a la imagen, para
ello se situará el cursor en el párrafo anterior a la imagen y se ejecutarán las siguientes acciones:
Formato | Párrafo | Líneas y saltos de página | Conservar con el siguiente (se marcará como activo)
En el caso de que la imagen sea tan grande que no quepa en una página se reducirá manualmente
según el criterio del analista, evitando composiciones con mal aspecto.
Antes de almacenar una versión en el repositorio hay que actualizar todas las referencias e índice.
Para ello se hará triple clic en el margen izquierdo del documento y se seleccionará todo.
Con todo el texto seleccionado se pulsará F9 y se actualizarán todas las referencias cruzadas. Si el
índice se debe actualizar, se solicitará el diálogo de forma de actualizar el índice y se procederá a
actualizar toda la tabla.
Conviene echar un vistazo al documento por si hubiera algún error de referencias cruzadas. Un error
muy típico es que la imagen inmediatamente posterior a un título tenga el mismo estilo que el título por
lo que podría aparecer en el índice. Basta con cambiar el estilo de la imagen y actualizar el índice.
El error “¡Error! No se encuentra el origen de la referencia.” indica que el destino de una referencia
ha sido eliminado y Word es incapaz de actualizarla.
Habrá que revisar que no hay páginas en blanco ni en medio ni al final del documento. Si esto sucede
puede ser debido a la inserción de saltos de página o líneas en blanco.
2.2.11 Ortografía
Se escribirá en mayúsculas:
• Los atributos divinos (Creador, Redentor), los títulos y nombres de dignidad (Sumo Pontífice,
Duque de Osuna...), los nombres y apodos con que se designa a determinadas personas (el
Gran Capitán, Alfonso el Sabio).
• Los tratamientos, especialmente si están en abreviatura (Sr. D., Sra. Dña.). Usted, señor o
don, cuando se escriben con todas sus letras, deben ir en minúscula.
• Los sustantivos y adjetivos que compongan el nombre de una institución (Instituto Cervantes,
Ministerio de Educación y Cultura, Real Academia Española).
• Los nombres y adjetivos que entran en el título de una obra (Tratado de Esgrima, Ortografía
Española, La Sonrisa Etrusca), aunque esta regla no se observa cuando el título es largo (Del
rey abajo, ninguno, y labrador más honrado, García del Castañar).
• En las leyes, decretos y documentos oficiales, suelen escribirse con mayúsculas todas las
palabras que expresen poder público (Rey, Príncipe, República, Regente...).
• La numeración romana se escribe con letras mayúsculas (Juan Carlos I, Juan Pablo I,
Fernando III...).
• Las letras Ch y Ll, cuando deben escribirse en mayúsculas, sólo se escribirá en mayúscula la
primera parte de estas letras compuestas o dobles: Chinchilla (nunca *CHinchilla), o Llerena
(nunca *LLerena).
• Después de dos puntos, se ha de escribir en letra minúscula, excepto en los siguientes casos:
• Los nombres de métodos, variables, palabras reservadas u otros elementos de cada lenguaje
se especificarán según la notación propia de cada lenguaje.
• Los nombres de las pantallas y procesos llevarán en mayúscula la primera letra del nombre y
sólo la primera, “Consulta de la licencia”, “Búsqueda de equipos”.
• Cuando se hace referencia a una entidad funcional se escribirá en minúsculas: “Los datos del
club se obtienen directamente de…”, “Si el federado no tiene…”, “…cuando la licencia tiene
contrato activo y deudas activas no se podrá…”.
• La palabra SISTEMA irá en mayúsculas cuando satisfaga los criterios expresados en este
apartado.
Acento: relieve que en la pronunciación se da a una sílaba de la palabra, distinguiéndola de las demás
por una mayor intensidad o por un tono más alto
Tilde: virgulilla o rasgo que se pone sobre algunas abreviaturas, el que lleva la ñ, y cualquier otro
signo que sirva para distinguir una letra de otra o denotar su acentuación.
En función de la ubicación de la sílaba fuerte o acento, las palabras se dividen en cuatro grupos:
• Abiertas: a, e, o.
• Cerradas: i, u.
• Los adverbios modales formados añadiendo el sufijo -mente a un adjetivo son una excepción,
ya que sólo llevan tilde si el adjetivo sobre el cual se forman también la lleva. Así,
“fuertemente” no lleva tilde mientras que “hábilmente” sí la lleva.
• Los monosílabos no llevan tilde, a no ser que ésta sea diacrítica. Por ejemplo “Soy de
Teruel”/“Espero que me dé negativo”.
• Los pronombres llevan tilde para diferenciarlos de los artículos: “Tú eres el mejor”/”Tu casa es
grande”, “Él vino a casa”/”El vino está picado”, “Mi coche no tiene seguro”/”¿Estás segura de
mí?”.
• Los siguientes pronombres no llevan tilde: “Te”, “Si”, “Se”. “Te has quedado fuera”/”Quiero una
taza de té”, “Si el valor es inferior a cero…”/”Sí, el valor es inferior a cero”, “Se empleará un
combo”/”Sé que es imposible”.
• La conjunción “o” tiene tilde si se incluye entre cifras: “El jueves o viernes”/”5 ó 6”.
• Sentido interrogativo y exclamativo: las palabras “qué”, “cuál”, “cuáles”, “quién”, “quiénes”,
“cuándo”, “dónde”, “cuántos”, “cómo” llevan tilde si tiene sentido interrogativo o exclamativo:
“Habrá que ver qué valores se cargan de forma que no se pierda la integridad”, “¿Cuándo
tendrás el código?”, “Son tal para cual”.
Diptongo es la reunión de dos vocales en la misma sílaba que se pronuncian en un solo golpe de voz.
Ejemplo: “aire”, “causa”, “aceite”, “deuda”, “boina”.
Triptongo es la reunión de tres vocales que se pronuncian en un solo golpe de voz. Ejemplo: “limpiáis”,
“acariciéis”, “averiguáis”, “buey”, “miau”.
Un hiato es un encuentro de dos vocales que se pronuncian en sílabas distintas. Hay tres tipos de
hiatos:
• Vocal abierta y vocal abierta que son distintas: “caen”, “ahogo”, “teatro”, “meollo”, “héroe”,
“coartada”.
• Vocal abierta átona y vocal cerrada tónica o viceversa: “caímos”, “día”, “aúllan”, “púa”, “reís”,
“líe”, “reúnen”. Son también hiatos de este tipo los que afectan a las sucesiones de tres o
cuatro vocales, siempre que sea tónica una cerrada. Ejemplos: “sa - lí - ais”, “ca - í - ais”.
• Formados por dos vocales iguales o por vocal abierta (a, e, o) + vocal abierta llevan tilde de
acuerdo a la orientación de usos generales de la acentuación de las palabras agudas, llanas o
graves y esdrújulas, tanto si alguna de las vocales es tónica como si ambas son átonas.
• Formados por vocal abierta (a, e, o) átona + vocal cerrada (i, u) tónica, llevan tilde,
independientemente que lo exijan o no las reglas generales de la acentuación ortográfica.
• Formados por vocal cerrada (i, u) tónica + vocal abierta (a, e, o) átona llevan tilde,
independientemente de que lo exijan o no las reglas generales de la acentuación ortográfica.
• La “h” intercalada entre dos vocales no implica que estas formen un hiato (ver diptongos).
Tampoco impide que el hiato con h intercalada lleve tilde si es preciso.
Las mayúsculas llevan tilde cuando así lo requiera según las normas generales.
2.2.11.3.1 La coma
La coma “,”, marca una pausa breve en un enunciado. Se utiliza en los casos siguientes:
• Para separar los elementos de una enumeración: “Se almacenarán los campos NOMBRE,
APELLIDO 1, APELLIDO 2, FECHA DE NACIMIENTO y SEXO”.
• Para aislar el vocativo: “Se guardará en LICENCIAS, la tabla maestra, y se procederá a…”
• En los incisos que interrumpen una oración, para aclara o ampliar lo que se dice, o para
mencionar el autor u obra citados. “Todos los controles, incluido el botón Guardar , se
inhabilitarán”.
• En las cabeceras de las cartas se escribe coma entre el lugar y la fecha: “Madrid, 24 de
noviembre de 2008”
2.2.11.3.2 El punto
El punto marca una pausa al final de un enunciado. Después de un punto siempre se escribe
mayúscula y debe haber un espacio blanco entre el punto y la mayúscula.
• Punto y seguido: separa enunciados que integran un párrafo. “Con el disco en la mano, ya sólo
falta que funcione. Atrás han quedado un año y medio de trabajo e incertidumbres. ”
• Punto y aparte: separa dos párrafos distintos con dos contenidos diferentes. “Un año después
de salir el disco al mercado, prácticamente todos saben ya quién es.
El segundo single ha comenzado a sonar. ”
Nunca se usa el punto en los títulos y subtítulos de libros, artículos, capítulos, obras de arte. "Las
Meninas", "Cien años de soledad", “Signos de puntuación”.
• Para separar los elementos de una enumeración cuando se trata de expresiones que incluyen
comas. “Había que estar en contacto con la naturaleza; dejar entrar el cielo, el mar y el viento;
dormir sobre tablones, sobre el suelo; sentarse en sillas medio rotas. ”.
• Delante de las conjunciones o locuciones como pero, mas, aunque, sin embargo, por tanto por
consiguiente, cuando los periodos tienen cierta longitud. “Trabajamos como locos en ese
proyecto porque teníamos confianza; sin embargo, los resultados no fueron los que
esperábamos. ”.
Nunca se deja un espacio antes de los dos puntos, pero sí después. Se usan los dos puntos en los
siguientes casos:
• Delante de una enumeración anunciada con un verbo. “Los puntos cardinales son: norte, sur,
este y oeste. ”.
• Después de las fórmulas de saludo en las cartas y documentos. “Estimado Sr. López: “,
“Querido amigo: ”.
Después de los dos puntos no se escribe mayúscula salvo que sea dos puntos y aparte.
Suponen una interrupción en la oración o un final impreciso. Se usan en los casos siguientes:
• Al final de una enumeración cuando tiene el mismo valor que la palabra etcétera. “Todo lo malo
estaba por venir: la anexión de Checoslovaquia, el asalto por sorpresa a Polonia, el ataque a
Rusia, el Holocausto…”
• Para expresar un momento de duda. “Tuve un asunto con el profesor de violín y con la niñera,
con un oficial y con un actor, y yo no tenía ni 16 años… ¿No les estaré aburriendo? “
• Para dejar un enunciado incompleto y en suspenso. “En cuanto a lo del otro día fue algo
inesperado, muy violento, muy desagradable…”
• Cuando se omite una parte de una cita textual. “Las primeras líneas del Quijote las aprendí en
la escuela: ‘En un lugar de la Mancha de cuyo nombre no quiero acordarme…’ “
Después de los puntos suspensivos se dejará un espacio en blanco y comenzará una palabra nueva
en mayúsculas.
Está prohibido su uso de los puntos suspensivos en los documentos de análisis y diseño.
• Nunca se deja un espacio después del signo de interrogación de apertura o antes del de cierre.
• El signo final de interrogación entre paréntesis indica duda o ironía. “El Señor Botín es el
director (?) del Banco de Santander. ”.
• Nunca se deja un espacio después del signo de exclamación de apertura o antes del de cierre.
• El signo final de exclamación entre paréntesis indica sorpresa o ironía. “Un señor de 70 años
(!) ha sido el ganador del Maratón de Nueva York. ” .
• Cuando se interrumpe el sentido de un discurso con una aclaración, sobre todo si ésta no tiene
mucha relación con lo anterior. “Marta Panceta (la novia del futbolista) se presenta a las
próximas elecciones. “.
• Para intercalar un dato o precisión (fechas, autores…). “Se obtiene la licencia (tabla
LICENCIAS) y se calcula el… ”.
• Para evitar una opción en el texto. “Un(a) constructor(a) debe saber Dojo. “.
• En la transcripción de textos para señalar la omisión de una parte del texto, se ponen tres
puntos entre paréntesis (…). “El uso de las pestañas comunes (…) en todas los módulos
necesarios. “.
Incorporan información complementaria como los paréntesis. Se usan en los casos siguientes:
• Dentro de un enunciado que va ya entre paréntesis para introducir una precisión. “Una de las
obras de Antonio Muñoz Molina (algunos la consideran como su mejor novela [1997]) es
“Plenilunio. “.
• Cuando en un texto transcrito el editor quiere introducir una nota complementaria al texto. “Y
Don Quijote, con el dolor de las suyas, tenía los ojos abiertos como liebre.
[como liebre] Alusión a la creencia vulgar que las liebres duermen con los ojos abiertos”
• Como los paréntesis, cuando se omite una parte del texto transcrito. (Ver ejemplo de
paréntesis).
Se utilizan para:
• Reproducir citas textuales. “Me dijo muy claramente: “No quiero aceptar esta proposición
porque pienso que no está a la altura de mis ambiciones”. “.
• Para indicar que una palabra o expresión es impropia, vulgar, de otra lengua o con un sentido
especial o irónico.
2.2.11.3.11 La raya
• Para encerrar aclaraciones que interrumpen el discurso. Se pueden sustituir por paréntesis.
“Se creará un registro –como se comentó en el párrafo anterior– por cada entidad creada.”.
2.2.11.3.12 El guión
Se utiliza:
• Para separar (en determinados casos) los dos elementos que integran una palabra compuesta.
“Tienda on-line. “.
• Para dividir una palabra al final del renglón cuando no cabe en el completa.
2.2.11.3.13 La diéresis
Se utiliza para señalar la pronunciación de la vocal u en las combinaciones gue, gui. “pingüino”,
“vergüenza”.
2.2.11.3.14 La barra
2.2.11.3.15 El asterisco
Sirve para:
• Señalar una nota al margen o a pie de página dentro de un texto. A veces, estos asteriscos se
encierran entre paréntesis. (*)
Ejemplos:
• Edad = INT((SYSDATE()-FECHA_NACIMIENTO)/365)
• Edad = INT((SYSDATE()-FECHA_NACIMIENTO)/365)
2.2.11.5 Otros
2.2.11.5.1 A, ha y ah
• Ha: presente del verbo haber. Se usa como verbo auxiliar. “Si el resultado ha sido par… “.
• ¡Ha!: ah.
• Ah: interjección.
• Porque: conjunción causal (o final). Es átona, por lo que no lleva tilde. “Se inserta un registro
porque es necesario tener inventariado el artículo. “.
• Por que: secuencia formada por la preposición por y el pronombre relativo (que); equivale a por
el cual, por la cual, por los cuales o por las cuales. “Estas son las razones por que he querido
venir.”. También “que” puede ser la conjunción subordinante: no tiene un valor casual, sino que
la preposición por está exigida por el verbo. “Inclinarse por: Me inclino por que no vendrá.”.
• Por qué: secuencia formada por la preposición por y el pronombre o adjetivo interrogativo qué,
con el que se pregunta la causa o motivo de una acción: “¿Por qué has venido?”.
Las oraciones interrogativas también pueden aparecer en el discurso indirecto, como una oración
subordinada. “Me gustaría saber por qué has venido”.
Algunos gramáticos consideran incorrecto el uso del artículo delante de las interrogativas indirectas.
Es incorrecto “Me gustaría saber el por qué has venido” pero es correcto “Me gustaría saber el porqué
de tu venida.”.
• Así mismo: se considera una locución adverbial afirmativa y se usa con dos sentidos:
o También.
• A sí mismo: se trata de una locución, en donde se unen una preposición (a), un reflexivo (sí) y
un adjetivo de identidad (mismo). El adjetivo, por su propia naturaleza, admite variaciones de
género y de número.
• Ay: interjección utilizada para expresar muchos y muy diversos movimientos del ánimo, y más
ordinariamente aflicción o dolor.
2.2.11.5.6 Sino y si no
“Sino” es:
• Tiene también el valor de más que, otra cosa que. “La carta no hizo otra cosa sino confundirla.
“Si no” se trata de la conjunción si, en frases condicionales o concesivas, y el adverbio tónico de
negación no precediendo a cualquier tipo de sintagma o frase. “Si es par, se tomará el valor, si no, se
multiplicará por dos y…”.
Los indefinidos cualquiera y quienquiera se han formado gracias a la unión del relativo cual y quien y
el elemento quiera. De esta manera, los plurales se han de realizar en la forma pronominal y no en el
elemento compositivo, que es invariable. Así, se debe escribir:
• Cualesquiera.
• Quienesquiera.
En lugar de:
• Cualquieras.
• Quienquieras.
El verbo satisfacer se conjuga exactamente igual que el verbo hacer. De esta forma la tercera persona
del singular del futuro de indicativo será “satisfará” en lugar de “satisfacerá”, la tercera persona del
singular del pretérito perfecto de indicativo es “satisfizo” y no “satisfació", la tercera persona del
singular del presente de subjuntivo es “satisfaga”.
• Solo: sustantivo o adjetivo relacionado con la soledad. “Se queda el control solo. “.
• Sólo: adverbio que significa (y se puede sustituir por) solamente. “Sólo se almacenará un
registro por… “.
El verbo imprimir tiene dos participios: uno regular, “impreso”, y otro irregular, “impreso”. Ambos
participios son válidos. La palabra “impreso” es la única de las dos que se puede emplear como
sustantivo.
2.2.11.5.11 El agua
El artículo definido femenino singular la toma la forma del masculino (el) cuando se emplea delante de
un sustantivo femenino que comience por a- o ha- tónica; no así cuando el sustantivo comienza por a-
o ha- átona.
• La agua. (Incorrecto).
• El agua. (Correcto).
• La antena. (Correcto).
• El antena. (Incorrecto).
No ocurre esto cuando entre el artículo y el sustantivo se introduce un adjetivo. Además, este adjetivo
debe ir siempre en femenino, pues concuerda en género con el sustantivo.
Del mismo modo, los indefinidos una, alguna y ninguna aparecen bajo su forma apocopada cuando
van delante de un sustantivo femenino que comienza por a- o ha- átona, si bien la norma académica
no considera incorrecto el empleo de las formas plenas.
De igual forma que sucede con el artículo definido, este cambio no se produce cuando entre el
indefinido y el nombre ser inserta un adjetivo.
Por otro lado, es incorrecto el empleo que se hace por analogía de los demostrativos masculinos
(este, ese, aquel) ante estos sustantivos femeninos. De esta manera, deben emplearse las formas del
femenino (esta, esa, aquella).
Del mismo modo, tampoco es correcto el uso de las formas masculinas de adjetivos determinativos
del tipo todo, mucho o poco.
Los nombres de las unidades tienen el plural acabado en -s (salvo si terminan en -s, -x o -z), pero no
así sus símbolos:
Los símbolos de las unidades del SI se han de escribir con minúscula si proceden de nombres
comunes y con mayúscula si se derivan de un nombre propio:
• 40 newtons.
Existen, sin embargo, algunos nombres cuya grafía ya está castellanizada y aceptada por la Real
Academia Española:
• 40 hercios.
• 40 amperios.
2.2.11.5.13 Anglicismos
No se considerará escritura distinta para marcar los anglicismos en los documentos de análisis y
diseño.
2.2.11.5.14 Varios
Siempre que haya duda se puede recurrir al Diccionario de la Real Academia en http://www.rae.es
para la búsqueda de significados (diccionario de la lengua) o dudas en la construcción (diccionario
panhispánico de dudas).