Documentacin

Dentro del desarrollo de Software

D o c u m e n t a c i n

Mara Fernanda Cez R

Beneficios de la Documentacin
Conserva la historia de un proyecto de software. Facilita la utilizacin del software por parte del usuario final. Garantiza la permanencia del software. Disminuye los costos de operacin y de ejecucin del proyecto.
Mara Fernanda Cez R

D o c u m e n t a c i n

Alcance
1/2

Definir los diferentes tipos de documentacin a desarrollar. Establecer los registros fsicos de las polticas y normas. Disear el sistema de informacin administrativo.

D o c u m e n t a c i n

Mara Fernanda Cez R

2/2

Establecer los smbolos institucionales Establecer los requisitos bsicos. Establecer las polticas de normalizacin para los estndares de documentacin.

D o c u m e n t a c i n

Mara Fernanda Cez R

Metodologa
Anlisis de los diferentes tipos de documentacin. Establecer reuniones de

1/2

evaluacin de estndares. Disear diferentes alternativas de presentacin de la documentacin.

D o c u m e n t a c i n

Mara Fernanda Cez R

2/2

Utilizar software especializado en consolidacin de documentacin. Realizar actas de confirmacin de aprobacin de los estndares. Realizar documento final de la metodologa.

D o c u m e n t a c i n

Mara Fernanda Cez R

Qu documentar?
En un proyecto de software debe existir documentos: Administrativos Manual Tcnico Manual de instalacin Manual de referencia o manual de mensajes y errores Manual de capacitacin Manual de usuario
Mara Fernanda Cez R

D o c u m e n t a c i n

A nivel administrativo
Todos los documentos de manejo gerencial de un proyecto de desarrollo de software: Contratos Comunicaciones Actas Cronogramas Requerimientos bsicos del usuario final

D o c u m e n t a c i n

Mara Fernanda Cez R

Manual Tcnico
Maneja el alcance del aplicativo Relacin con otros aplicativos Estndares de programacin Herramientas de desarrollo de software Especificaciones del diseo Listado de programas fuentes Seguridad Infraestructura Poltica de backups Entre otros aspectos tcnicos

D o c u m e n t a c i n
Mara Fernanda Cez R

Manual de Instalacin
En este manual se debe detallar los pasos y puntos a tener en cuenta para la instalacin del aplicativo desarrollado por la fbrica de software

D o c u m e n t a c i n

Mara Fernanda Cez R

Manual de referencia o manual de mensajes y errores

En este manual se describen detalladamente todos los mensajes y posibles errores con su solucin como gua de accin al usuario final.

D o c u m e n t a c i n

Mara Fernanda Cez R

Manual de usuario
Contempla todos los procesos en los que el usuario final interacta con el sistema implantado Teniendo en cuenta: Preparacin de datos de entrada y de salida Navegacin del aplicativo Definicin de funciones Y dems caractersticas aplicables a la capacitacin e implementacin.
Mara Fernanda Cez R

D o c u m e n t a c i n

Manual de Capacitacin
En este manual se manejan todo el material utilizado para todos los diferentes aspectos a capacitar a los diferentes tipos de usuario.

D o c u m e n t a c i n

Mara Fernanda Cez R

Recomendaciones para capacitacin

Idioma sencillo Material complementario eficiente Definir claramente el objetivo de la capacitacin e identificar los logros a obtener Ejercicios o parte prctica

D o c u m e n t a c i n

Mara Fernanda Cez R

Recomendaciones para Documentar

Escribir en tercera persona Siempre debe estar identificado quin realiza la accin, por ejemplo: el sistema, la opcin, el mdulo, la pantalla, la ventana, el botn. No utilizar gerundios: (verbos terminados en ando, endo) Utilizar los verbos en presente
Mara Fernanda Cez R

D o c u m e n t a c i n

2/2

No utilizar la palabra SE, o cualquier muletilla por ejemplo:

de que cuales quiera que sea puesto que y eso y todo eso a eso de la(s) ... ... por as decir bueno, ... El uso de expresiones que alargan innecesariamente el texto como: Dar por finalizado -termina De acuerdo al pensamiento de ... --segn ... Debido al hecho que -porque En el momento actual -actualmente
Mara Fernanda Cez R

D o c u m e n t a c i n

Caractersticas bsicas de un escrito

Claro: es un texto fcil de entender. Conciso: es breve Preciso: expresa un solo sentido e interpretacin, no es ambiguo Sencillo: en la redaccin se utiliza palabras simples, sin rebuscamiento no tecnicismos excesivos y sin expresiones coloquiales. Coherente: organizacin del texto a travs de estructuras lgicas, manejo de prrafos y de captulos, o a travs del orden cronolgico, espacial, etc. y de otros factores de acuerdo a cada trabajo.
Mara Fernanda Cez R

D o c u m e n t a c i n

Quien debe documentar?

Una persona con la visin de usuario dedicado al temas de documentacin, que en lo posible no est involucrado en las tareas tcnicas del proyecto de software.

D o c u m e n t a c i n

Mara Fernanda Cez R

Herramientas de apoyo
Las herramientas de apoyo documental le permiten asegurar la integridad de la informacin. Ayudas en lnea, demos, manuales impresos, guas rpidas, entre otras.

D o c u m e n t a c i n

Mara Fernanda Cez R

Ejemplos de tipos de Documentacin

Proyectos de documentacin utilizando herramientas de apoyo: Con entidad oficial Sistema financiero Sistema de apoyo para comunicaciones Sistema para venta masiva Demos de productos Pginas en Intranet o Internet
Mara Fernanda Cez R

D o c u m e n t a c i n

Conclusiones
Un proyecto de software exitoso est apoyado en una buena documentacin. El idioma de la documentacin debe ser el mismo del usuario final. Dentro de un sistema de gestin de calidad la documentacin garantiza el xito del mismo. La documentacin electrnica es una herramienta de apoyo que garantiza el aprovechamiento mximo del software.
Mara Fernanda Cez R

D o c u m e n t a c i n