Ingeniería en Sistemas Computacionales

604 – B

INGENIERÍA DE SOFTWARE
Docente: MTI. Montserrat Masdefiol Suárez

Integrantes:
Montserrat de los Ángeles Campos de Dios
Néstor Daniel Herrera Domínguez
Héctor Alejandro Morales Rodríguez
Lucia Isabel Polito Chagala

Loc. Matacapan Mpio. San Andrés Tuxtla, Ver.

DOCUMENTACIÓN
◎ La documentación es una
disciplina científica que trata de
recopilar, almacenar, analizar y
difundir información contenida en
documentos de distinto tipo para
hacerla accesible a cualquier
persona que pueda necesitarla.
◎ La Documentación es una
disciplina instrumental, ya que
sirve a todas las demás ciencias
para localizar información
necesaria para el avance del
conocimiento.
SISTEMA
◎ Un sistema es un conjunto de
partes o elementos organizados
y relacionados que interactúan
entre sí para lograr un objetivo.
Los sistemas reciben (entrada)
datos, energía o materia del
ambiente y proveen (salida)
información, energía o materia.
◎ Un sistema puede ser físico o
concreto (una computadora, un
televisor, un humano) o puede
ser abstracto o conceptual (un
software).
DOCUMENTACIÓN DEL
SISTEMA

◎ La Documentación de sistema consiste en un conjunto

de información relacionada a un sistema determinado
que explica las características técnicas, la
funcionabilidad del sistema, la parte lógica, los
diagramas de flujos, los programas, la naturaleza,
capacidades del sistema y cómo usarlo, en otras
palabras, la documentación de sistemas es el conjunto
de información que nos dice qué hacen los sistemas,
cómo lo hacen y para quién lo hacen
DOCUMENTACIÓN DEL SISTEMA
DEBE INCLUIR
◎ El documento de requisitos y una lógica
asociada.
◎ Un documento que describe la arquitectura
del sistema.
◎ Para cada programa en el sistema, una
descripción de la arquitectura de ese
programa.
◎ Para cada componente en el sistema, una
descripción de su funcionalidad y interfaces
◎ Listados de código fuente de los programas, que deben ser
comentados en los comentarios deben explicar las
secciones complejas de código y proporcionar una
justificación para el método de codificación utilizado.
◎ Documentos de validación que describen cómo cada
programa es validado y cómo la información de validación se
refiere a los requisitos. Estos pueden ser necesarios para los
procesos de aseguramiento de la calidad en la organización.
◎ Una guía de mantenimiento del sistema, que describe los
problemas conocidos con el sistema, se describe qué partes
del sistema son dependientes de hardware y software y que
describe cómo se ha tenido en cuenta la evolución del
sistema en su diseño.
 REQUISITOS ASOCIADOS
◎ Deben actuar como medio de comunicación entre los miembros del
equipo de desarrollo.
◎ Deben ser un repositorio de información para ser utilizado por los
ingenieros de mantenimiento.
◎ Deben proporcionar información para la gestión de cómo facilitar la
planificación, el presupuesto y programar el proceso de desarrollo de
software.
◎ Algunos de los documentos debe indicar a los usuarios cómo utilizar
y administrar el sistema.
◎ Pueden ser pruebas esenciales para ser presentado a un regulador
para la certificación del sistema. (Sommerville, Chapter 30
Documentation , 2010)
Sin embargo, la documentación producida durante un proyecto de
software normalmente se divide en dos clases:
◎ La documentación de procesos Estos documentos registran el
proceso de desarrollo y mantenimiento. Planes, programas,
documentos de procesos de calidad y las normas de organización
y del proyecto son la documentación de procesos.
◎ Documentación del producto Esta documentación describe el
producto que se está desarrollando. La documentación del sistema
describe el producto desde el punto de vista de los ingenieros de
desarrollo y mantenimiento del sistema; documentación del
usuario proporciona una descripción del producto que se orienta
hacia los usuarios del sistema.
DOCUMENTACION
DEL PROCESO
¿QUE ES ?
◎ La gestión eficaz requiere el proceso está gestionando
para que sea visible. Dado que el software es
intangible y el proceso de software implica tareas
cognitivas aparentemente similares, más que
obviamente diferentes tareas físicas, la única forma en
que esto se puede lograr la visibilidad es a través del
uso de la documentación del proceso.
CATEGORÍAS
◎ Los planes, estimaciones y horarios: Estos son los
documentos producidos por los administradores que se
utilizan para predecir y controlar el proceso de software.
◎ Informes: Estos son los documentos que informan de cómo
se utilizaron los recursos durante el proceso de desarrollo.
◎ Normas: Estos son los documentos que establecen cómo el
proceso se ejecutará. Estos pueden ser desarrollados a
partir de las normas de organización, nacionales o
internacionales.
◎ Documentos de trabajo: Estos son a menudo los principales
documentos técnicos de comunicación en un proyecto. En ellas se
registran las ideas y pensamientos de los ingenieros que trabajan
en el proyecto, son las versiones provisionales de la
documentación del producto, describen estrategias de aplicación y
establecidos los problemas que se han identificado.

◎ Mensajes de correo electrónico, wikis, etc.: Estos registran los

detalles de las comunicaciones diarias entre los gerentes y los
ingenieros de desarrollo. La principal característica de la
documentación del proceso es que la mayor parte de ella se
vuelve obsoleto. (Sommerville, Chapter 30 Documentation , 2010)
Documentación
del producto
◎ Documentación del producto se ocupa de describir el
producto software entregado. A diferencia de la
mayoría de documentación de procesos, que tiene una
vida relativamente larga. Se debe evolucionar en el
paso con el producto que se describe. La
documentación del producto incluye documentación
para el usuario, que indica a los usuarios cómo utilizar
el producto de software y documentación del sistema,
que se destina principalmente para ingenieros de
mantenimiento.
DOCUMENTACIÓN DEL USUARIO

◎ Los usuarios de un sistema no son todos

iguales. El productor de la documentación
debe estructurarlo para atender a las
diferentes tareas del usuario y diferentes
niveles de conocimientos y experiencia
Es particularmente importante distinguir entre los
usuarios finales y los administradores del sistema:
◎ Los usuarios finales utilizan el software para ayudar
con alguna tarea. Esto puede estar volando un
avión, la gestión de las pólizas de seguro, escribir
un libro, etc.
◎ Los administradores de sistemas son responsables
de la gestión de los programas informáticos
utilizados por los usuarios finales.
 TIPOS DE DOCUMENTACIÓN Y
DOCUMENTOS DE USUARIOS

Proporciona una descripción

Gerentes y
general del propósito del sistema y
evaluadores del Descripción del
una descripción de los servicios
sistema Sistema Funcional
más importantes del sistema

Describe cómo instalar el

Administradores Documento de
sistema en las plataformas
del Sistema Instalación
previstas

Describe brevemente cómo

Usuarios Manual
comenzar con el sistema
Novatos Introductorio

Proporciona una descripción

Usuarios Manual de
detallada de todas las
Experimentados Referencia
instalaciones del sistema
CALIDAD DEL DOCUMENTO

◎ La calidad del documento es tan importante

como la calidad del programa. Sin
información sobre el uso de un sistema o
cómo entender que, la utilidad de este
sistema se degrada.
 Componente Descripción
Los datos de Los datos tales como un título y el identificador que
identificación identifica de forma única el documento.
Tabla de contenido Nombres y números de página capítulo / sección.
Lista de Ilustraciones la figura números y títulos
Define el propósito del documento y una breve
Introducción
Resumen de los contenidos
Información para uso
Sugerencias para diferentes lectores sobre cómo
de el
utilizar la documentación de manera efectiva.
Documentación
Concepto de Una explicación de la base conceptual para el uso
operaciones del software.
Las instrucciones sobre cómo utilizar el software
Procedimientos para completar las tareas que está diseñado para
soportar.
Información en software Una descripción de cada uno de los comandos
comandos soportados por el software.
Los mensajes de error y Una descripción de los errores que pueden ser
resolución de problemas reportadas y cómo recuperarse de estos errores.
Glosario Definiciones de términos especializados utilizados.
fuentes de información Las referencias o enlaces a otros documentos que
relacionados proporcionan información adicional.
Funciones de Características que permiten a los lectores a encontrar su
navegación ubicación actual y se mueven alrededor del documento.
Una lista de términos clave y las páginas en las que se
Índice
hace referencia a estos términos.
En la documentación electrónica, una manera de
capacidad de búsqueda
encontrar términos específicos en el documento.
ESTRUCTURA DEL DOCUMENTO

◎ La estructura del documento es la manera en la que

el material en el documento está organizado en
capítulos y, dentro de estos capítulos, en secciones
y subsecciones. La estructura del documento tiene
un gran impacto sobre la legibilidad y facilidad de
uso, y es importante para diseñar esto con cuidado
al crear documentación. Al igual que con los
sistemas de software, debe diseñar estructuras de
documento a fin de que las diferentes partes son
tan independientes como sea posible
ESTILO DE ESCRITURA

◎ Normas y evaluación de la calidad son

esenciales para que una buena
documentación se ha de producir, pero la
calidad del documento depende
fundamentalmente de la capacidad del
escritor para construir la prosa técnica clara y
concisa. En resumen una buena
documentación, requiere la buena escritura
1. Utilice tiempos activos en lugar de pasivos
2. Utilice construcciones gramaticalmente correctas y ortografía
correcta
3. No utilice frases largas que presentan varios hechos diferentes
4. Mantenga los párrafos cortos
5. No sea prolijo
6. Sea preciso y definir los términos que utilice
7. Si una descripción es compleja
8. Hacer uso de los títulos y subtítulos
9. Detallar hechos siempre que sea posible
10. No se refiera a la información por número de referencia sola
 Normas de
documentación
1. Las normas de elaboración Estas normas definen el
proceso que se debe seguir para la producción de
documentos de alta calidad.
2. Normas de producto Estas son las normas que rigen
los propios documentos por ejemplo, su organización
y estructura.
3. Normas de intercambio Prácticamente todo los
documentos se almacenan en formato electrónico. Sin
embargo, estos pueden ser desarrollados en
diferentes momentos usando diferentes sistemas de
modo que se requieren normas de intercambio para
asegurar que todas las copias electrónicas de los
documentos son compatibles.
GESTIÓN DE DOCUMENTOS
DOCUMENTACIÓN EN LÍNEA
◎ La documentación en línea entregado con un
sistema de archivos puede variar desde
simples 'Léeme' que proporcionan una
información muy limitada sobre el software a
través de sistemas interactivos de ayuda a
una suite basada en la web completa de la
documentación del sistema, incluyendo
manuales de usuario, tutoriales, etc
ESTÁNDARES DE
DOCUMENTACIÓN
◎ Estándares del proceso de documentación.
Definen el proceso a seguir para la
producción del documento.

◎ Estándares del documento. Gobiernan la

estructura y presentación de los documentos.

◎ Estándares para el intercambio de

documentos. Aseguran que todas las copias
electrónicas de los documentos sean
compatibles.
◎
 MANUALES DE
DOCUMENTACIÓN
MANUAL DE USUARIO
◎ El Manual de Usuario expone los procesos
que el usuario puede realizar con el sistema
implantado, instruyéndolo en su uso y en la
solución de los problemas que puedan
suceder durante la operación
Para la elaboración de un manual de usuario se deberán de integrar los
siguientes apartados normativos:
◎ Nombre del Sistema
◎ Versión del Sistema
◎ Tipo de Manual
◎ Poner una Imagen
◎ Fecha de Elaboración
◎ Área donde fue elaborado
◎ Índice del Contenido del Manual
◉ Presentación
◉ Generalidades del Sistema
◉ Requerimientos Técnicos del Sistema, Instalación y Configuración
◉ Entrada y Salida del Sistema
◉ Uso de la Aplicación
◉ Manejo de Errores
◉ Contingencias y Soporte Técnico
◉ Glosario de Términos
◉ Anexos
◉ Encabezado y Pie de Página
MANUAL TÉCNICO

◎ El Manual Técnico, como su

nombre lo indica, contiene las
especificaciones técnicas más
importantes del sistema
desarrollado. Constituye una guía
especializada para la realización
de las operaciones de
mantenimiento de la aplicación.
Para la elaboración de un manual de técnico se deben de considerar los
siguientes apartados normativos:
◎ Nombre del Sistema
◎ Versión del Sistema
◎ Tipo de Manual
◎ Poner una Imagen
◎ Fecha de Elaboración
◎ Área donde fue elaborado
◎ Índice del Contenido del Manual
◎ Introducción
◎ Objetivos Generales y Específicos del Sistema
◎ Normas, Políticas y Procedimientos
◎ Definición de las Reglas del Negocio Implementadas
◎ Fundamentación de la Tecnología Utilizada
◎ Descripción de los Actores del Sistema
◎ Especificación de Requisitos
◎ Vista Funcional
◎ Modelo Lógico de datos
◎ Vista Lógica
◎ Modelo Lógico de Datos
◎ Modelo Físico de Datos
◎ Descripción Detallada de los Algoritmos
◎ Diseño de Pantallas y Reportes
◎ Descripción de Campos Requeridos por Pantalla
◎ Vista de Implementación
◎ Vista de Despliegue
◎ Diagrama de Navegación del Sistema
◎ Controles de Auditoría Implementados en el Sistema
◎ Glosario de Términos
ESTÁNDARES IEEE
PARA LA
DOCUMENTACIÓN
DE SISTEMAS
Tipo Descripción
IEEE Std 829-2008 documentación de prueba de software y sistema

IEEE Std 1063-2001 documentación de usuario

IEEE Std 1008-1987 pruebas de unidad de software

IEEE Std 1028-2008 pruebas de software estático

 CONCLUSIÓN

◎ La documentación de un sistema es esencial para proporcionar

entendimiento de un a quien lo vaya a usar para mantenerlo,
para permitir auditorias del mismo y para enseñar a los usuarios
como interactuar con él y a los operadores y administradores
como hacerlo funcionar.

◎ La documentación adecuada y completa, de una aplicación que

se desea implantar, mantener y actualizar en forma satisfactoria,
es esencial en cualquier Sistema de Información, sin embargo,
frecuentemente es la parte a la cual se dedica l menor tiempo y
se le presta menos atención.
 REFERENCIAS
◎ Documentando Sistemas. (01 de 06 de 2011). Obtenido de Documentando Sistemas:
http://documentandosistemas.blogspot.mx/2011/06/el-estandar-ieee-std-1063-2001.html
◎ IEEE Explore. (2017). Obtenido de IEEE Explore:
https://ieeexplore.ieee.org/document/7508560/
◎ IEEE Standards Association . (2016). Obtenido de IEEE Standards Association :
https://standards.ieee.org/findstds/standard/1028-2008.html
◎ Reyes, A. G. (03 de 2010). Soluciones Informaticas. Obtenido de Soluciones Informaticas:
http://cujae.edu.cu/index.php?option=com_k2&Itemid=941&id=77_efde092d01622d74e0c33a
3c9134db13&lang=es&task=download&view=item
◎ Reyes, A. G. (03 de 2010). Soluciones Informaticas. Obtenido de Soluciones Informaticas:
http://cujae.edu.cu/index.php?option=com_k2&Itemid=941&id=76_4cc93c8ac11adcb3093d8
7bafa85384f&lang=es&task=download&view=item
◎ Sommerville, I. (2005). Ingenieria de Software (7ma ed.). Mexico: Pearson.
◎ Sommerville, I. (2010). Chapter 30 Documentation . Obtenido de Chapter 30 Documentation :
https://ifs.host.cs.st-andrews.ac.uk/Books/SE9/Web/ExtraChaps/Documentation.pdf
◎ Sommerville, I. (2011). Ingenieria de Software (9na ed.). Mexico: Pearson .
◎ Wikipedia. (22 de 01 de 2018). Obtenido de Wikipedia:
https://en.wikipedia.org/wiki/Software_test_documentation