DD

oo

cc

uu

mm

ee
DOCUMENTACIÓN
nn

SOPORTE AL tt

aa
DESARROLLO DE SOFTWARE cc

ii

óó
nn
 DD

Beneficios de la Documentación oo

cc

uu
• Conserva la historia de un proyecto
mm
de software.
ee
• Facilita la utilización del software por nn
parte del usuario final. tt

• Garantiza la permanencia aa

del software. cc

• Disminuye los costos de operación y ii

de ejecución del proyecto. óó

nn
 Alcance D
D

1/2 o
o

c
• Definir los diferentes tipos de c

u
documentación a desarrollar. u

m
• Establecer los registros m

e
e
físicos de las políticas
n
y normas. n

t
• Diseñar el sistema de
t

a
a
información administrativo.
c
c

i
i

ó
ó

n
n
 D
D

2/2 o
o

c
c

•Establecer los símbolos u

u

institucionales m
m

•Establecer los e
e

requisitos básicos. n
n

•Establecer las políticas t

t

de normalización para a
a

los estándares de c
c

documentación. i
i

ó
ó

n
n
 DD

Metodología oo

1/2 cc

uu
• Análisis de los diferentes
mm
tipos de documentación.
ee
• Establecer reuniones de
nn
evaluación de estándares.
tt
• Diseñar diferentes aa
alternativas de presentación cc
de la documentación. ii

óó
nn
 D
D

o
o
2/2
c
c

• Utilizar software especializado en u

u

consolidación de documentación. m
m

• Realizar actas de confirmación de e

e

aprobación de los estándares. n

n

• Realizar documento final de t

t

la metodología. a
a

c
c

i
i

ó
ó

n
n
 DD

¿Qué documentar? oo

cc

uu
En un proyecto de software deben
mm
existir documentos:
• Administrativos ee

• Manual Técnico nn

tt
• Manual de instalación
aa
• Manual de referencia o manual de
cc
mensajes y errores
ii
• Manual de capacitación
• Manual de usuario óó
nn
 DD

A nivel administrativo oo

cc

Todos los documentos de uu

manejo gerencial de un mm
proyecto de desarrollo de
ee
software:
nn
• Contratos
• Comunicaciones tt

• Actas aa

• Cronogramas cc

• Requerimientos básicos ii
del usuario final
óó
nn
 DD

oo
Manual Técnico cc

uu
• Maneja el alcance del aplicativo
• Relación con otros aplicativos mm

• Estándares de programación ee
• Herramientas de desarrollo de nn
software
tt
• Especificaciones del diseño
• Listado de programas fuentes aa

• Seguridad cc
• Infraestructura ii
• Política de backups
• Entre otros aspectos técnicos óó
nn
 DD

Manual de Instalación oo

cc

uu
En este manual se debe
detallar los pasos y puntos mm
a tener en cuenta para la ee
instalación del aplicativo
nn
desarrollado por la fábrica
de software tt

aa

cc

ii

óó
nn
Manual de referencia o manual DD

oo
de mensajes y errores cc

uu

En este manual se mm

describen ee
detalladamente todos nn
los mensajes y posibles tt
errores con su solución
aa
como guía de acción al
cc
usuario final.
ii

óó
nn
 DD

Manual de usuario oo

cc

Contempla todos los uu

procesos en los que el
mm
usuario final interactúa
con el sistema implantado ee

nn
Teniendo en cuenta:
• Preparación de datos de tt
entrada y de salida aa
• Navegación del aplicativo
cc
• Definición de funciones
• Y demás características ii
aplicables a la capacitación
e implementación. óó
nn
 DD

Manual de Capacitación oo

cc

uu

mm
En este manual se
manejan todo el ee

material utilizado para nn

todos los diferentes tt

aspectos a capacitar aa
a los diferentes tipos cc
de usuario.
ii

óó
nn
 DD
Recomendaciones oo

para capacitación cc

uu

• Idioma sencillo mm

• Material complementario eficiente ee

• Definir claramente el objetivo de la nn

tt
capacitación e identificar los logros a
aa
obtener
cc
• Ejercicios o parte práctica
ii

óó
nn
 Recomendaciones DD

oo
para Documentar cc

• Escribir en tercera persona uu

mm
• Siempre debe estar identificado quién
ee
realiza la acción, por ejemplo: el
nn
sistema, la opción, el módulo, la
tt
pantalla, la ventana, el botón….
aa
• No utilizar gerundios: (verbos cc
terminados en ando, endo) ii

• Utilizar los verbos en presente óó

nn
 DD

oo
2/2
cc
• No utilizar la palabra SE, o cualquier uu
muletilla por ejemplo:
…de que … mm
…cuales quiera que sea …

…puesto que …
ee
…y eso …
nn
…y todo eso

…a eso de la(s) ...

tt
... por así decir
… bueno, ... aa

cc
El uso de expresiones que alargan innecesariamente el texto como:
Dar por finalizado -- termina ii
De acuerdo al pensamiento de ... --- según ...
Debido al hecho que -- porque óó
En el momento actual -- actualmente
nn
 DD
Características básicas de oo

un escrito cc

Claro: es un texto fácil de entender. uu

mm
Conciso: es breve
ee
Preciso: expresa un solo sentido
e interpretación, no es ambiguo nn

Sencillo: en la redacción se utiliza tt

palabras simples, sin rebuscamiento
no tecnicismos excesivos y sin aa
expresiones coloquiales.
cc
Coherente: organización del texto a
través de estructuras lógicas, manejo ii
de párrafos y de capítulos, o a través
del orden cronológico, espacial, etc. y
de otros factores de acuerdo a cada óó
trabajo.
nn
 DD

¿Quién debe documentar? oo

cc

uu
Una persona con la visión de usuario
mm
dedicado a temas de documentación,
ee
que en lo posible no esté involucrado
nn
en las tareas técnicas del proyecto de
tt
software.
aa

cc

ii

óó
nn
 DD

Herramientas de apoyo oo

cc

uu
• Las herramientas de apoyo
mm
documental le permiten asegurar
ee
la integridad de la información.
nn
• Ayudas en línea, demos, manuales tt
impresos, guías rápidas, entre otras. aa

cc

ii

óó
nn
 Ejemplos de tipos de DD

oo
Documentación
cc

uu
Proyectos de documentación utilizando
mm
herramientas de apoyo:
ee
Con entidad oficial
nn
Sistema financiero tt

Sistema de apoyo para comunicaciones aa

Sistema para venta masiva cc

ii
Demos de productos Páginas
óó
en Intranet o Internet
nn
 DD

Conclusiones oo

cc

• Un proyecto de software exitoso está uu

apoyado en una buena documentación. mm

• El idioma de la documentación debe ser el ee

mismo del usuario final. nn

• Dentro de un sistema de gestión de calidad tt
la documentación garantiza el éxito del
aa
mismo.
• La documentación electrónica es una cc

herramienta de apoyo que garantiza el ii

aprovechamiento máximo del software. óó

nn