CONTROL DE DOCUMENTACIÓN.

Unidad 1

Clasificación de la documentación.

Propósito del modulo

Ordenará documentación de acuerdo con el contenido y origen de la información para mantener el flujo de la información y comunicación dentro de la unidad administrativa.

Resultado de aprendizaje 1.1

Identifica el tipo de documentación que se genera, recibe y despacha en la unidad organizacional de acuerdo con la información contenida para dar respuesta a los requerimientos de las áreas de trabajo.

Actividad de evaluación 1.1.1

Realiza una práctica en una empresa de su localidad recopilando los siguientes documentos con información alusiva a las actividades de la empresa o institución y clasifica los documentos en función de su contenido:

A. Descripción de la documentación interna y externa en una empresa

DOCUMENTACION INTERNA:

 La documentación interna son los comentarios que se encuentran junto con el programa fuente y son ignorados por el compilador. Se usan para describir cosas significativas para un programador: qué hace cada sección, quién lo programó, etcétera. Comentar a medida que se escriban el programa. Preparar una parte de la documentación antes de empezar. Modificar la documentación a medida que se modifica un programa. El primer elemento de documentación es el código. Un buen código ya es una guía, mientras una gran cantidad de comentarios no rescata un mal código.

Los comentarios generales de un programa son: a) Encabezado del programa o módulo. b) Convención utilizada para abreviaturas. c) Límites de cada sección importante. d) Variables, constantes, procedimientos y funciones. e) Funcionamiento y parámetros requeridos por cada módulo. f) Funcionamiento detallado de los truco

[pic 1]

Características;

 Es la documentación que va incluida con el codigo

– puede ser de dos tipos:

+ Complementaria sobre el codigo

Es util al estudiar el codigo permite comprender mejor su funciónamiento

+ Ayudas interactivas

Normalmente destinadas al usuario

Se puede considerar también de usuario las ayudas interactivas sofisticadas se pueden considerar como una

Función más del software (interfaz hombre–máquina)

DOCUMENTACIÓN EXTERNA:

Documentación localizada aparte del programa (en el sentido de que no forma parte del código)

[pic 2]

Características;  

 + Cómo usar el sistema (sin esto aún el sistema más simple resultaría inútil)

+ cómo instalar y operar con el sistema

+ los requisitos y el diseño de todo el sistema

+ la función del sistema y los procedimientos de prueba, para poderles

Dar el mantenimiento        

– la documentación habra de ser útil durante todo el tiempo de vida del

Sistema

– no tiene por qué producirse en el mismo orden que el sistema (pueden

Adelantarse trozos, aunque no es conveniente atrasarlos)

– necesita índices efectivos, para poder encontrar la información

– puede venir dada en distintos formatos:

+ escrito

+ informatico (base de datos, texto,...)

DOCUMENTACIÓN MIXTA :

Como su nombre lo indica la ordenación mixta consiste en la utilización de dos o varios métodos de ordenación.

Normalmente destinadas al usuario se puede considerar también de usuario.

 Las ayudas interactivas sofisticadas se pueden considerar como una función más del software (interfaz hombre–máquina).

IMPORTANCIA DE LA DOCUMENTACIÓN

La documentación de los programas es un aspecto sumamente importante, tanto en el desarrollo de la aplicación como en el mantenimiento de la misma. Mucha gente no hace este parte del desarrollo y no se da cuenta de que pierde la posibilidad de la reutilización de parte del programa en otras aplicaciones, sin necesidad de conocerse el código al dedillo. 

La documentación de un programa empieza a la vez que la construcción del mismo y finaliza justo antes de la entrega del programa o aplicación al cliente. Así mismo, la documentación que se entrega al cliente tendrá que coincidir con la versión final de los programas que componen la aplicación. 

• Interna: Es aquella que se crea en el mismo código, ya puede ser en forma de comentarios o de archivos de información dentro de la aplicación.
• Externa: Es aquella que se escribe en cuadernos o libros, totalmente ajena a la aplicación en si. Dentro de esta categoría también se encuentra la ayuda electrónica.

[pic 3][pic 4]

TIPOS DE DOCUMENTACIÓN:

Interna:

v  CIRCULAR

v  MEMORÁNDUM

v  CONVOCATORIA

v  ACTA DE JUNTA (MINUTA)

v  INFORMES

[pic 5][pic 6]

[pic 7]

B. Codificación de documentos mediante la técnica de su confidencialidad y orden de importancia

CODIFICACIÓN

Consiste en dar números, letras o ambos, a los distintos documentos o archivos que existen, esto permite un manejo rápido y adecuado de ellos.

• DEFINICIÓN

Es el proceso de dar el orden lógico en el que se deben colocar las palabras, números o símbolos que forman parte del nombre de un individuo, firma comercial, organización, institución o agencias gubernamentales.

• USO

Existen dos formas de uso:

1. Manual: es utilizado en forma mecanizada logrando identificar su uso.
2. Sistematizado: se puede llevar en forma electrónica, logrando una eficiencia en cuanto a rapidez.

• SISTEMAS DE CODIFICACIÓN

Procedimientos que permiten ordenar, identificar y seleccionar con mayor facilidad documentos o archivos de una empresa, lo cual permite unificar el registro, originando un control en toda la empresa u oficina, dicha codificación en conocida por las personas involucradas en esa área, facilita el manejo y permite que las personas clasifiquen y encuentren todo documento, archivo o expediente, sin mayor problema.

Diferenciar entre sistema manual y automatizado:

• MANUALES

Los sistemas de codificación manuales, son aquellos que asignan claves alfabéticas, numéricas o alfanuméricas en forma manual a los documentos enviados o recibidos.

...