UNIVERSIDAD NACIONAL EXPERIMENTAL SIMN RODRGUEZ NCLEO SAN CARLOS

Facilitador: Ing. Lugo, Limett

San Carlos, Noviembre del 2004 TABLA DE CONTENIDO

INTRODUCCIN

PAUTAS ANTES DE LA REDACCIN DE MANUALES: .- Preparacin para la Escritura .- Valoracin de la Tarea .- Preparacin del Lector Previsto .- Nivel de Detalle .- Valoracin de la Informacin Disponible .- Recogida de la Informacin .- Comienzo de la Escritura

ORGANIZACIN MANTENIMIENTO: .-El Orden .- Preparacin .- Divisin en Prrafos .-Cabeceras

REQUERIDA

PARA

EL

ESTABLECIMIENTO

ESTILO EN LA REDACCIN DE LOS MANUALES

ILUSTRACIONES EN EL MANUAL

ESCRITURA DE PROCEDIMIENTOS

CONCLUSIN BIBLIOGRAFIA

INTRODUCCIN

Todo sistema posee entre su documentacin un manual, que no es ms que la explicacin detallada de la estructura del sistema, sus mdulos,

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

Es importante sealar que todo manual

posee una normativa para su

elaboracin, es por ello que a lo largo del presente informe se dar a conocer las pautas antes de la redaccin de manuales, organizacin, mantenimiento, estilo al texto, las

en la redaccin, as como las ilustraciones que deben acompaar

cuales deben ser escogida en forma tcnica y precisas, facilitando as la comprensin del lector.

PAUTAS ANTES DE LA REDACCIN DE MANUALES

Preparacin para la Escritura

La escritura tcnica es un trabajo de produccin.

Tiene un autor y un

usuario, 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 atencin 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 preparacin adecuada para la creacin de

buena escritura tcnica como para cualquier otra fabricacin.

Valoracin de la tarea

La primera etapa de la preparacin es la valoracin.

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 realizacin la realizacin de las dems fases de la preparacin.

Preparacin del lector previsto.

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

Esto ocurrira, por ejemplo, si un

texto bien escrito emplearse una

terminologa desconocida por el lector, o mtodos matemticos que excedieran de

sus conocimientos.

Por esto, antes de empezar a trabajar, el escritor tcnico

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 del lector. Esto depende de las necesidades del sistema: la funcin de cada documento es la de asegurar que se pone al lector en posesin de informacin que necesitar para cumplir con su responsabilidad en el esfuerzo del sistema. La determinacin eficaz del nivel de detalle apropiado para cada

documento exige una cuidadosa coordinacin entre las necesidades de comunicacin del esfuerzo del sistema y la produccin de documentacin 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 material de valorando al lector; en el segundo anlogo al que se encuentra

enseanza para el personal del usuario resulta evidente que el nivel de detalle exigido por el sistema excede de la probable capacidad real del lector previsto.

Valoracin de la Informacin Disponible

Entrada, en un trabajo de escritura tcnica esta constituida por informacin. Para que el trabajo pueda llevarse a cabo con xito, esta informacin puede ser la adecuada en clase y cantidad. Tras hacer un estudio de la naturaleza y alcance del trabajo de los lectores previsibles, el autor debe comparar stos resultados con la informacin de que disponga. Si la relacin es la adecuada puede

llevarse a cabo la escritura; si la informacin es insuficiente debe conseguir ms.

Recogida de Informacin

Para la recopilacin de informacin de entrada completa, el autor debe conservar los siguientes puntos: Debe decidir con precisin lo que quiere saber, antes de empezar a hacer preguntas. Si se han realizado a conciencia las fases previas de la preparacin, las omisiones resaltarn con claridad; Debe saber cul es la fuente apropiada para la informacin direcciones tiempo. Siempre que sea posible, debe concertar una cita con la persona que pueda darle la informacin que busca e informarle de las preguntas que se propone formularle. Comienzo de la escritura equivocadas es algo que aburre y malgasta que

necesita. El tener que dirigirse de uno a otro por una larga cadena de mucho

Cuando se han aprobado las notas, debe prepararse un esquema general del texto. A pesar de su carcter esquemtico, debe hacerse con cuidado, pues

el producir trabajo malo o descuidado en esta fase es perder el tiempo; el 90% del contenido de este esquema, realizado por autores competentes.

Las finalidades de este esquema son las siguientes:

se revelan las pequeas

deficiencias que pueden contener la

informacin de entrada. Al encontrarse deben tratar de corregirse. Si es preciso se dejan unos espacios en blanco en el esquema;

se comprueba la validez de la organizacin propuesta para el texto. Al redactar este esquema pueden aparecer razones que justifiquen pequeos cambios;

el esquema con nota sobre las deficiencias encontradas en la informacin de entrada y los cambios que se propagan en su organizacin, se presentan para aprobacin tcnica. Este procedimiento evita prdidas de tiempo en trabajos editoriales o de pulimiento. Dificultades para empezar

La frase ms

difcil es la primera. Las palabras surgirn con

facilidad cuando se venza la inercia inicial. Mirando la hoja en blanco; despus de unos minutos en esta posicin, en general la mente tan en blanco como el papel. Antes de llegar a esto debe hacerse tres preguntas: comprendo perfectamente la naturaleza del trabajo que voy a emprender? Tengo suficiente informacin tcnica para realizarlo? Comprendo la informacin tcnica? Para vencer la inercia frecuentemente es buena idea escribir algo en el

papel, interesante o no, una vez empezando, continuar escribiendo. Una vez est funcionando la mente, puede dirigirse al asunto en cuestin. Finalmente puede este mtodo tiene la ventaja de que el comienzo, que dar al lector la primera

impresin del trabajo, se escribe despus, cuando ya se ha calentado el escritor y est funcionando normalmente.

Cuando estn fluyendo las palabras, se suspende parcialmente la facultad critica. Es difcil conseguir simultneamente espontaneidad y precisin; as pues, hay que escribir con espontaneidad y editar con precisin. Para ello:

 escribir libremente y cubrir la materia de la forma tan completar exija el nivel de detalle;

como

repasar el texto, detectando toda palabra no esencial para el sentido o estructura de la frase y sustituyendo las frases complicadas por otras ms sencillas. ORGANIZACIN REQUERIDA PARA EL ESTABLECIMIENTO Y MANTENIMIENTO DE LA DOCUMENTACIN

Dentro de la organizacin existen tres aspectos de gran relevancia como son:

El Orden: El orden aumenta la eficacia con que la informacin puede ser transferido del documento al lector. Se garantiza con un pensamiento claro y una buena comprensin del asunto por parte del autor, y se pone de manifiesto en la preparacin de la notas.

En toda documentacin existen unas notas las cuales deben estar bien redactadas, asimismo, en base a la informacin disponible al terminar la fase de preparacin, deducir las principales cabeceras o epgrafes, luego escribirlas en maysculas y considerar una a una, cada cabecera. Preparacin: Organizacin Orden Prrafos Cabeceras Ilustraciones que llevara la documentacin Generalidades Contenido Finalidades Cantidad Dibujos Ejemplo:

Divisin en Prrafos

Un prrafo de ms de diez o doce lneas puede dificultar la visin del lector. Prrafos ms cortos, de longitudes variables, modelan la pgina y el lector tendr menos peligros de saltarse una lnea o de leerla dos veces.

La separacin en partes de una serie de sub materias relacionadas, dividas en prrafos y sucesivamente en otras divisiones subordinadas, facilita el examen del texto y da idea de la importancia relativa excederse en una serie de cada una, cabe la posibilidad de no se

de subdivisiones interminables. Normalmente

utilizan ms que cuatro niveles de importancia.

Si se necesitarn ms ser Se

preciso modificar ligeramente la jerarqua de las cabeceras de capitulo.

advertir, generalmente que hay alguna cabecera que debe pasar a un nivel inferior. Si no es ste el caso, lo indicado es realizar una redistribucin radical del texto.

Cabeceras

Cabeceras o epgrafes, deben ser cortas y expresivas, indicando las materias que se tratan en el prrafo que encabezan y no resumir la dilucin. Este sistema permite al lector revisar las cabeceras por orden para localizar un tema determinado, pero impide que este repaso le evite la lectura del texto,

consiguiendo un conocimiento superficial e inadecuado del material.

ESTILO EN LA REDACCIN DE LOS MANUALES DE DOCUMENTACIN

Una persona acostumbrada a leer puede identificar el estilo de un autor; es decir, al estilo en relacin con la escritura tcnica, esta clase de estilo personalizado no es exactamente lo que se entiende por tal. Realmente, un estilo

excesivamente personal es inadecuado en una buena escritura atrae la atencin del lector hacia si mismo.

tcnica, porque

El autor tcnico debe cultivar un estilo, empleando esta palabra en su sentido ms neutro. En la escritura tcnica, la palabra estilo se suele referir la forma en que el autor selecciona y organiza su material oral. Mientras que el estilo, en el sentido literario es algo imponderable, al hablar de escritura tcnica

tiene un significado ms limitado, pero ms preciso.

Es de destacar que la precisin formal y gramatical, el lenguaje acadmico es vital en los profesionales en escritura tcnica as como tambin evitar las ambigedades. Claridad. El objetivo de la escritura tcnica es la comunicacin; por ello la cualidad ms deseable es la de la claridad. Sencillez. El factor del estilo que ms afecta a la claridad es la sencillez. El empleo de Tcnicas literarias destruye la sencillez. Modismos. Desarrollar un dialecto compuesto de palabras y frases empleadas con extraos sentidos, que con seguridad tendrn significado distinto para cada lector. Su empleo debe evitarse en la escritura tcnica.

Brevedad. Las ms breves notas tcnicas pueden servirse para comunicarse de manera eficaz con individuos muy calificados. El escritor tcnico debe suponer

con frecuencia en su lector, aun a expensas de la brevedad, un nivel de comprensin ms bajo que el ideal.

Redundancia y relleno Las tres principales razones para la redundancia y el relleno en literatura tcnica son la falta de ideas claras, el deseo de producir, aparentemente, un gran volumen de trabajo y la falta de deseo de volver a leer y escribir.

Ideas poco claras Si el escritor no comprende totalmente la materia en estudio, es incapaz de tener ideas claras sobre la misma. aturullada, en la que el autor comprende. Produccin de volumen. Suele darse cuando el escritor advierte que se juzga su capacidad nica o principalmente, por su produccin diaria. Ejemplo: tantas pginas por hombre / mes de media. Este estado produce una escritura

va dando vueltas alrededor de los puntos que no

Falta de deseo de volver a escribir. Cuando un autor ha escrito un prrafo que, al releerlo, parece inadecuado para describir el punto que se intentaba, existe la tentacin de aadir otro prrafo ms en un invento de reparar la deficiencia. Si un pasaje no dice lo que debiera decir, debe volver a escribirse en lugar de enmascarado. Duda de s mismo. El autor ha escrito un prrafo perfectamente bueno y experimenta,

repentinamente la necesidad de perfeccionarlo. El sntoma ms comn es la abundancia de por ejemplo y es decir y en otras palabras. Escribir es decir o en otras palabras es admitir que se ha dicho dos veces la misma cosa.

El empleo de ejemplos el literatura tcnica es necesario ocasionalmente. La proliferacin de ejemplos oscurece el texto e impide el fluir del pensamiento. Puntuacin. Las reglas de la escritura han nacido de la necesidad de claridad. Los signos de puntuacin obligatorios ( ? ! ) deben colocarse correctamente de acuerdo con el conocimiento tcnico elemental. Longitud de las frases La escritura tcnica no debe constar exclusivamente de afirmaciones cortas y secas. Para evitar ambos extremos se construirn frases de longitud variable, que mantendrn el inters del lector y aumentaran la claridad de la escritura.

Tiempos de los verbos. El estilo se pone de manifiesto por el empleo permanente de los debidos tiempos de los verbos. La mayora de los documentos deben escribirse en presente. El uso del tiempo pasado es aconsejable a veces para comunicar

informacin bsica, como lo es el del futuro para discutir los resultados que se esperan de determinadas acciones. presente. En los casos de duda se debe emplear el

Voz pasiva. La voz pasiva es onerosa y lenta de manejar impide la comunicacin y dificulta la claridad.

Terminologa. La terminologa debe ser consistente en todo documento tcnico. explicar procesos complicados es inevitable repetir trminos. Para

La escritura tcnica sirve para describir y para explicar, pero no para alabar. La escritura tcnica sirve para describir y para explicar, pero no para alabar.

Frases sin significado. Todos los idiomas tienen numerosas palabras y frases sin significado Estas expresiones pasan generalmente inadvertidas para el lector aun cuando se utilicen correctamente.

Frases imprecisas. Las palabras y frases imprecisas deben evitarse en la escritura tcnica. La finalidad de un documento tcnico es la precisin. Evitar expresiones del tipo de al cabo de un corto tiempo, tan pronto como se pueda, casi al mximo. Dan al lector un aire de frustracin y le indican que el escritor no se halla en posesin de todos los datos necesarios.

Humor verbal. No tiene lugar en la escritura tcnica que ha de servir para comunicar, no para distraer.

Descripcin. Un buen mtodo es el de comenzar con una breve descripcin del sistema o proceso completo; seguir con una explicacin detallada terminar con un resumen. de cada elemento y la

En algunos casos ser ms adecuado dividir

descripcin ms de acuerdo con las funciones que con las partes fsica del sistema. Descripcin del ambiente.

Al describir ciertas funciones del sistema, ayuda a menudo incluir una breve descripcin del ambiente en que se realizan, con el fin de poner de manifiesto cmo faceta el ambiente al diseo del sistema en relacin con estas funciones.

Descripcin de conjunto del sistema La documentacin de sistemas, subsistemas, programas y procedimientos del usuario exige la inclusin de una pequea descripcin del sistema en su conjunto.

ILUSTRACIONES EN EL MANUAL

Las ilustraciones de un documento tcnico deben planearse conjuntamente con el texto y recibir la misma atencin. por lo general debe existir una estrecha relacin ilustraciones. La planificacin del contenido de la ilustracin tcnicos. Todo autor debe ser capaz de producir, aun grosso modo, una cierta representacin de la ilustracin que necesite. es responsabilidad del

entre el texto y as

autor, aunque puede admitir sugerencias de ilustradores e inspectores

Contenido de las Ilustraciones.

El nmero y tipo de las ilustraciones debe estar en relacin con las necesidades del lector previsible y con la naturaleza del asunto sobre el que verse. Con el fin de determinar el contenido apropiado de la ilustracin apreciar los objetivos que pueden cubrirse con las mismas. es necesario

El nivel de una ilustracin debe mantenerse paralelo al del texto correspondiente. Un pasaje que presenta una descripcin general del sistema

debe ir acompaado de una ilustracin que identifique solamente las principales funciones y subsistemas, mientras que la discusin detallada de la lgica de programas exige un ordinograma de flujo.

Redundancia de las ilustraciones. La existencia de demasiadas ilustraciones constituye una falta tan grave como la de su extrema escasez. El autor debe considerar la necesidad de cada ilustracin que se proponga utilizar. Tambin es malo intentar meter demasiadas cosas en una sola ilustracin. Un dibujo sobrecargado no cumple su principal misin, que es la de aclarar, porque es difcil leerlo. ESCRITURA DE PROCEDIMIENTOS

El trmino procedimiento significa aqu una instruccin para la realizacin de una tarea o conjunto de tareas especificas. Sus principales caracteres son

precisin, sencillez e integridad. Los verbos deber ir en modo imperativo y voz activa; no decir la tarjeta es retirada ahora sino retirar la tarjeta.

El conseguir que sea completo, preciso y sencillo impide crear un documento corto para un procedimiento largo. Un procedimiento no puede corto, pero debe serlo esenciales. tanto como sea compatible con sus caractersticas ser

Es muy conveniente que se d, al autor de un procedimiento, la

posibilidad de realizar por s mismo la tarea que describe.

CONCLUSIN

Despus de haber llevado a cabo el anlisis acerca de la pautas para la redaccin de manuales, se concluye:

.- La escritura tcnica es un trabajo de produccin.

Tiene un autor y un

usuario, y el autor debe considerar las necesidades y exigencias del usuario.

.-Asimismo, la primera etapa de la preparacin es la valoracin. Antes de empezar el trabajo, el autor debe tener una idea clara de la naturaleza y alcance de la labor que va emprender. .- Por su parte, el nivel debe venir determinado por la necesidad de conocer del lector. Esto depende de las necesidades del sistema: la funcin de cada documento es la de asegurar que se pone al lector en posesin de informacin que necesitar para cumplir con su responsabilidad en el esfuerzo del sistema.

.- Dentro de la organizacin existen tres aspectos de gran relevancia como son: El Orden: El orden aumenta la eficacia con que la informacin puede ser

transferido del documento al lector; Divisin en Prrafos: Un prrafo de ms de diez o doce lneas puede dificultar la visin del lector. Prrafos ms cortos, de longitudes variables, modelan la pgina y el lector tendr menos peligros de saltarse una lnea o de leerla dos veces; Cabeceras: o epgrafes, deben ser

cortas y expresivas, indicando las materias que se tratan en el prrafo que encabezan y no resumir la dilucin.

.-Por su parte, el estilo, en el sentido

literario es algo imponderable, al

hablar de escritura tcnica tiene un significado ms limitado, pero ms preciso. Es por ello que el estilo forma parte de la personalidad del autor, y a travs del l un lector puede determinar el autor que lo realiza.

.- Es importante acotar, las ilustraciones de un documento tcnico deben planearse conjuntamente con el texto y recibir la misma atencin. por lo general debe existir una estrecha relacin ilustraciones. la planificacin del contenido de la ilustracin tcnicos. es responsabilidad del

entre el texto y as

autor, aunque puede admitir sugerencias de ilustradores e inspectores

Para finalizar, el trmino procedimiento significa aqu una instruccin para la realizacin de una tarea o conjunto de tareas especificas. Sus principales

caracteres son precisin, sencillez e integridad, elementos esenciales para la elaboracin de los procedimientos en la redaccin de los manuales.

BIBLIOGRAFIA

Hartman / h. Mathis. A proeme. Manual de Sistemas de Informacin. 2da parte.