sistema dcumentacion

UNIVERSIDAD NACIONAL EXPERIMENTAL
SIMÓN RODRÍGUEZ
NÚCLEO SAN CARLOS

Facilitador: Ing. Lugo, Limett

San Carlos, Noviembre del 2004
TABLA DE CONTENIDO

INTRODUCCIÓN

PAUTAS ANTES DE LA REDACCIÓN DE MANUALES:
.- Preparación para la Escritura
.- Valoración de la Tarea
.- Preparación del Lector Previsto
.- Nivel de Detalle
.- Valoración de la Información Disponible
.- Recogida dela Información
.- Comienzo de la Escritura

ORGANIZACIÓN

REQUERIDA

PARA

EL

ESTABLECIMIENTO

MANTENIMIENTO:
.-El Orden
.- Preparación
.- División en Párrafos
.-Cabeceras

ESTILO EN LA REDACCIÓN DE LOS MANUALES

ILUSTRACIONES EN EL MANUAL

ESCRITURA DE PROCEDIMIENTOS

CONCLUSIÓN
BIBLIOGRAFIA

Y

INTRODUCCIÓN

Todo sistema posee entre su documentación un manual,que no es más
que

la explicación detallada de la estructura del sistema, sus módulos,

actividades, funciones, a fin de agilizar el proceso por parte del usuario en caso
de fallas, error, o desconocimiento del mismo.

Es importante señalar que todo manual

posee una normativa para su

elaboración, es por ello que a lo largo del presente informe se dará a conocer las
pautas antes de laredacción de

manuales, organización, mantenimiento, estilo

en la redacción, así como las ilustraciones que deben acompañar al texto, las
cuales deben ser escogida en forma técnica y precisas, facilitando así la
comprensión del lector.

PAUTAS ANTES DE LA REDACCIÓN DE MANUALES

Preparación para la Escritura

La escritura técnica es un trabajo de producción.

Tiene un autor y unusuario, y el autor debe considerar las necesidades y exigencias del usuario.
Tiene una entrada en la que se gastan horas/hombre con el fin de producir una
salida, y el autor o fabricante debe prestar atención a la cantidad y calida de la
entrada, así como a la calidad del trabajo realizado, si quiere conseguir una salida
aceptable.

Por ello se necesita una preparación adecuada para lacreación de

buena escritura técnica como para cualquier otra fabricación.

Valoración de la tarea

La primera etapa de la preparación es la valoración.

Antes de empezar el

trabajo, el autor debe tener una idea clara de la naturaleza y alcance de la labor
que va emprender.

La falta de este conocimiento no solo producirá un trabajo confuso, sino que
hará imposible la realización larealización de las demás fases de la preparación.

Preparación del lector previsto.

Es posible escribe con claridad y precisión, y fracasar totalmente en el
intento de comunicarse si no se ha consultado previamente las necesidades del
previsible lector.

Esto ocurriría, por ejemplo, si un

texto bien escrito emplearse una

terminología desconocida por el lector, o métodos matemáticos queexcedieran de

sus conocimientos.

Por esto, antes de empezar a trabajar, el escritor técnico

debe determinar quien será el lector, para escribir en el nivel apropiado y
utilizando el debido vocabulario.
Nivel de Detalle

No es suficiente asegurarse de que se escribe en el nivel que pueda
comprender el lector.

El nivel debe venir determinado por la “necesidad de

conocer” dellector. Esto depende de las necesidades del sistema: la función de
cada documento es la de asegurar que se pone al lector en posesión de
información que necesitará para cumplir con su responsabilidad en el esfuerzo del
sistema.

La determinación eficaz del nivel de detalle apropiado para cada

documento exige una cuidadosa coordinación entre las necesidades de
comunicación del esfuerzo delsistema y la producción de documentación de
sistemas.

Hay que considerar dos casos: en el primero el nivel de detalle se
desprende de consideraciones del sistema

no es otro que el se consigue

valorando al lector; en el segundo – análogo al que se encuentra material de
enseñanza para el personal del usuario – resulta evidente que el nivel de detalle
exigido por el sistema excede de la...