Este documento presenta información sobre las técnicas y elementos de la documentación de software. Explica que la documentación permite mantener y actualizar sistemas de información de una empresa de manera efectiva. Incluye diferentes tipos de documentación como la de programas, para usuarios finales, y de arquitectura de software. También describe la importancia de la documentación y algunas reglas para documentar proyectos de software.
1. TÉCNICAS Y ELEMENTOS DE LA COMUNICACIÓN DEL
SOFTWARE
NOMBRE:
JESSICA CALERO
CURSO:
3RO INFORMÁTICA “A”
ING:
ESTHER CORRALES
CARRERA:
INFORMÁTICA-MENCIÓN ANÁLISIS DE SISTEMAS
INSTITUTO TECNOLÓGICO SUPERIOR “VICENTE LEÓN”
2. INTRODUCCIÓN
Con la documentación se puede mantener y actualizar los sistemas de información de
una empresa frecuentemente, con el fin de brindar efectividad en el diseño de las
estrategias.
Un buen sistema de documentación debe desarrollarse utilizando un método único,
estandarizado que proporcione una comunicación clara y gráfica, ya que puede
reducir costos en el almacenamiento del personal y adquisición de tecnologías.
3. DOCUMENTACIÓN
La documentación es un conjunto de elementos registrados sobre cualquier soporte que
permita instruir o informar acerca de algo, en unción de las necesidades específicas de
aquellos que lo utilizaran.
DOCUMENTACIÓN DE LOS SISTEMAS DE INFORMACIÓN
Es el conjunto de información que nos dice que hacen los sistemas , como lo hacen y para
quien lo hacen.
La documentación consiste en material que explica las características, técnicas y la operación
de un sistema.
4. IMPORTANCIA DE LA DOCUMENTACIÓN
Es esencial para proporcionar entendimiento de un sistema a quien lo vaya usar, para
mantenerlo, para permitir auditoria del sistema y para enseñar a los usuarios como interactuar
con el mismo además como hacen funcionar los operadores.
FUNCIONES DE UN DOCUMENTO
• Permite la comunicación humana.
• Es un medo muy valioso de formación y enseñanza.
• Puede materializar todos los conocimientos humanos, formando de este modo una
memoria colectiva.
6. TIPOS DE DOCUMENTACIÓN DE LOS SISTEMAS DE INFORMACIÓN
LA 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 (crítico de comidas)
7. PROGRAMAS PARA USUARIOS FINALES
En forma general explica la naturaleza y capacidades del sistema y como usarlo.
CONTENIDOS DE MANUALES DE PROGRAMAS
1)DIAGRAMAS UML
• Diagramas de clase
• Diagramas de objetos
• Diagramas de interacción Diagramas de secuencias
Diagrama de comunicación
• Diagramas de casos de uso
• Diagramas de estados
• Diagramas de actividades
2)FLUJOGRAMAS DEL PROCESO DEL SISTEMA
3)CODIFICACIÓN
8. REGLAS PARA DOCUMENTAR UNAARQUITECTURA DE SOFTWARE
1) La documentación debe ser escrita desde el punto de vista del lector, no la del escritor ,debe ser
escrita una sola vez de manera eficiente por reciclaje ,cortes y claro pensando en las personas para
las cuáles está escribiendo.
2) Evitar repeticiones innecesarias.
3) Evitar botones con palabras confusas, explicar claramente lo que haga uno de los botones.
4) Usar una organización estándar, establecer una organización planeada y estandarizada de la
documentación ,ayuda al lector a navegar mas fácilmente atrávez de el.
5) Registro razonado, se debe documentar las rutas alternativas.
6) Mantener la documentación automatizada.
7) Revisar y realizar la documentación después de las pruebas respectivas