Tecnicas de documentacion

1. Técnicas de elementos documentales de software:
Introducción:
Con la documentación se puedes mantener y actualizar los sistemas de
información de una empresa frecuentemente con el fin de brindar factibilidad en
el diseño de las estrategias.
Un buen sistema de documentación debe realizar un método único,
estandarizado que proporciona una comunicación.
Documentación de sistemas de información:
Es el conjunto de información que nos dicen que hacen en los sistemas como
lo hacen y para que lo hagan.
La documentación consiste en material que explica las características técnicas
y la operación de un sistema.
Importancia de la documentación en los sistemas de información:
Indica el correcto utiliza miento del sistema para el usuario:
Constituye el respaldo de información:

2. Facilita el entendimiento, compresión y divulgación del sistema:
Elemento integrado entre sistema y usuario:
Características de la documentación de sistemas:
 Pertinencia: los documentos deben responder a las necesidades.
 Exhaustavilidad: se debe proporcionar a los usuarios todos los
documentos para satisfacer sus necesidades.
 Rapidez: los documentos debe ser mínimo o incluirse debe ser un
agregado del sistema.

3.  Economía: El costo de la documentación debe ser mínimo o incluirse al
sistema.
Funciones de un documento:
 Permite la comunicación humana.
 Medio muy valioso de información.
 Materializar los conocimientos humanos.
Un documento válido puede ser:
 Original: de primera mano, fruto de investigación o un estudio.
 Fiable: de fácil acceso a los utilizadores.
 Documentos confidenciales: realizar manuales para usuarios finales.
 Funciones de la documentación:
 La selección: recoge principalmente documentos de tipo visual, audio,
audiovisual.
 La identificación: aplicación de reglas para una mayor comunicación.
 Análisis documental: conjunto de operaciones realizadas para presentar
el contenido.
 Stockage: acumulación de información para la consulta de información.
 Difusión: ejercicio de comunicación entre personas en tiempo y espacio.
Técnicas de recolección de información:

4. Tipos de documentación de sistemas de información:
De programas: que explica la lógica de un programa e incluye descripciones,
diagramas de flujo, listados de programas y otros documentos.
Ejemplo:
Diagrama UML en caso de uso:
Para usuarios finales: en forma general explican la naturaleza y capacidad del
sistemas y como usarlo.
1) Contenidos de los manuales de programas:
Diagramas UML.
Diagramas de clase.
Diagramas de caso.
Diagramas de interacción.
 Diagramas de secuencia.
 Diagramas de comunicación.
Diagramas de caso de usos.

5. Diagramas de estados.
Diagramas de actividades.
2) Flujo gramas del proceso de sistemas.
3) La codificación.
Reglas para documentar una arquitectura del software:
Para realizar una buena documentación se debe realizar 7 pasos:
1. Debe ser escrita desde el punto de vista del lector más no del escritor.
2. Evitar repeticiones innecesarias.
3. Evitar botones con palabras confusas.
4. Usar una organización estándar.
5. Registro razonado se debe documentar las rutinas alternativas.
6. Mantener la documentación actualizada.
7. Revisar y analizar la documentación después de las pruebas
implantadas.