Este documento trata sobre la importancia y técnicas de la documentación de sistemas de información. Explica que la documentación permite mantener y actualizar los sistemas, proporcionando una comunicación clara entre los usuarios y el sistema. También reduce los costos de almacenamiento, capacitación y adquisición de tecnología. Luego describe los elementos y características clave de la documentación como exhaustividad, pertinencia y economía.

1. INSTITUTO TECNOLÓGICO SUPERIOR
VICENTE LEÓN
INFORMÁTICA MENCIÓN ANÁLISIS EN SISTEMAS
FERNANDO CASTILLO
TÉCNICAS DE DOCUMENTACIÓN
ING. EULALIA CORRALES
TEMA: DOCUMENTACIÓN DE LOS SISTEMAS DE INFORMACIÓN

2. Técnicas y elementos de la documentación del software
Con la documentación
se puede mantener y
actualizar los sistemas
de información.
Se debe proporcionar una
comunicación clara y
precisa.
Así reducimos
el costo:
Almacenamiento Adiestramiento
del personal.
Adquisición de
tecnologías.

3. Documentación
Documentación en los sistemas de información
Es el conjunto de
elementos registrados
sobre cualquier
soporte.
Esto permite instruir o
informar acerca de algo
en función de las
necesidades especificas.
Es el conjunto de
información que nos
dice que hacen los
sistemas.
La documentación cosiste
en el material que explica:
Las características
Las técnicas
La operación de un sistema

4. Importancia de la documentación
Es esencial para
proporcionar
entendimiento
de un sistema.
Para mantenerlo.
Para permitir auditoria del sistema.
Para enseñar a los usuarios
a interactuar con el mismo.
Constituye el
respaldo formal de
la información.
Facilita el entendimiento
comprensión y
divulgación del sistema.
Es el elemento
integrador entre el
usuario y el sistema.

5. Campo de la documentación del sistema
Son aquellos que
esporádica o
periódicamente tiene
necesidad de
documentarse
Con motivo de:
Estudio
Trabajo
Investigación
Docencia
Formación permanente.

6. Característicasdeladocumentación
desistemas
Pertinencia
Los documentos que se proporcionan
deben responder a las necesidades
únicas de los utilizadores.
Exhaustividad
Los documentos que se proporcionan
deben responder a las necesidades
únicas de los utilizadores.
Rapidez
Los documentos que se proporcionan
deben responder a las necesidades
únicas de los utilizadores.
Economía
Los documentos que se proporcionan
deben responder a las necesidades
únicas de los utilizadores.

7. Permite• la comunicación humana.
Es• un medio muy valioso de formación y
enseñanza.
Puede• materializar todos los conocimientos
humanos, formando de este modo una memoria
colectiva.
Funciones de un documento
Un documento valido debe ser
• Original
• Fiable
• Utilizable
Documentos•
confidenciales
Es decir de primera mano, fruto de un
estudio o investigación.
Digno de crédito. Identificación de
autores y fuentes.
Con posibilidad de difusión. De fácil
acceso a los utilizadores.
Realizar un manual para usuarios
finales y uno para usuarios técnicos.

8. Funcionesdeladocumentación
Representa el conjunto
de documentos
recogidos para fines
determinados.
Consiste en el empleo de
técnicas documentales
La• selección.- recoge principalmente
documentos de tipo visual, auditivo y
audiovisual.
La• identificación.- consiste en la
aplicación de reglas de escritura y
representación gráfica.
El• análisis documental.- es un conjunto
de operaciones realizadas para
representar el contenido de un
documento.
El• almacenamiento (stockage).- es la
acumulación de documentos originales
o reproducidos.
La• difusión.- de los documentos o la
información recogida tratada y analizada
tiene en cuenta el ejercicio de las
técnicas de comunicación entre
personas.

9. Técnicasderecolecciónde
información
La Observación
La Entrevista
La Encuesta
Consiste en la indagación sistemática
dirigida a estudiar los aspectos más
significativos de los objetos, hechos o
situaciones sociales donde se
desarrollan.
Es una técnica de recopilación de
información mediante contacto
directo con las personas a través de
una conversación interpersonal
preparada con anticipación.
Es una técnica de recopilación de
información donde el investigador
interroga a los investigados los datos
que desea obtener.

10. Contenidos de los manuales de programas
(manual usuario técnico)
Diagramas1. UML
2. Flujogramas del proceso del sistema.
3. Codificación
• Diagramas de clases.
• Diagramas de interacción.
• Diagrama de secuencias.
• Diagrama de
comunicación.
• Diagrama de casos de uso.
• Diagrama de estados.
• Diagrama de actividades.

11. Reglas para documentar una arquitectura de software
1. La documentación debe ser escrita desde el punto de vista del lector, no
del escritor, debe ser escrita una sola vez de manera eficiente, cortés y
clara. Pensando en las personas para las cuales se esta escribiendo.
2. Evitar repeticiones innecesarias.
3. Evitar botones con palabras confusas, explicar claramente lo que haga
cada botón.
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 a través de el.
5. Registro razonado se deben documentar las rutas alternativas
6. Mantener la documentación actualizada.
7. Revisar y realizar la documentación, después de la implementación del
sistema y pruebas respectivas.