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 de la Información
.- Comienzo de la Escritura
ORGANIZACIÓN REQUERIDA PARA EL ESTABLECIMIENTO Y 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
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 la redacció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 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 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 la creació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 la realizació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 que excedieran 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” del lector. 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 del sistema 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 probable capacidad real del lector previsto.
Valoración de la Información Disponible
Entrada, en un trabajo de escritura técnica esta constituida por información.
Para que el trabajo pueda llevarse a cabo con éxito, esta información 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 información de que disponga. Si la relación es la adecuada puede llevarse a cabo la escritura; si la información es insuficiente debe conseguir más.
Recogida de Información
Para la recopilación de información de entrada completa, el autor debe conservar los siguientes puntos:
Debe decidir con precisión lo que quiere saber, antes de empezar a hacer preguntas. Si se han realizado a conciencia las fases previas de la preparación, las omisiones resaltarán con claridad;
Debe saber cuál es la fuente apropiada para la información que necesita. El tener que dirigirse de uno a otro por una larga cadena de
“direcciones equivocadas” es algo que aburre y malgasta mucho tiempo.
Siempre que sea posible, debe concertar una cita con la persona que pueda darle la información que busca e informarle de las preguntas que se propone formularle.
Comienzo de la escritura
Cuando se han aprobado las notas, debe prepararse un esquema general del texto. A pesar de su carácter esquemático, 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 pequeñas deficiencias que pueden contener la información 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 organización propuesta para el texto. Al redactar este esquema pueden aparecer razones que justifiquen pequeños cambios;
- el esquema con nota sobre las deficiencias encontradas en la información de entrada y los cambios que se propagan en su organización, se presentan para aprobación técnica. Este procedimiento evita pérdidas de tiempo en trabajos editoriales o de “pulimiento”.
Dificultades para empezar
La frase más difícil es la primera. Las palabras surgirán con facilidad cuando se venza la inercia inicial. Mirando la hoja en blanco; después de unos minutos en esta posición, 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 información técnica para realizarlo?
Comprendo la información técnica?
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 cuestión. Finalmente puede este método tiene la ventaja de que el comienzo, que dará al lector la primera impresión del trabajo, se escribe después, cuando ya se ha calentado el escritor y está funcionando normalmente.
Cuando están fluyendo las palabras, se suspende parcialmente la facultad critica. Es difícil conseguir simultáneamente espontaneidad y precisión; así pues, hay que escribir con espontaneidad y editar con precisión. Para ello:
escribir libremente y cubrir la materia de la forma tan completar como exija el nivel de detalle;
repasar el texto, detectando toda palabra no esencial para el sentido o estructura de la frase y sustituyendo las frases complicadas por otras más sencillas.
ORGANIZACIÓN REQUERIDA PARA EL ESTABLECIMIENTO Y MANTENIMIENTO DE LA DOCUMENTACIÓN
Dentro de la organización existen tres aspectos de gran relevancia como son:
El Orden: El orden aumenta la eficacia con que la información puede ser transferido del documento al lector. Se garantiza con un pensamiento claro y una buena comprensión del asunto por parte del autor, y se pone de manifiesto en la preparación de la notas.
En toda documentación existen unas notas las cuales deben estar bien redactadas, asimismo, en base a la información disponible al terminar la fase de preparación, deducir las principales cabeceras o epígrafes, luego escribirlas en mayúsculas y considerar una a una, cada cabecera. Ejemplo:
Preparación:
Organización Ilustraciones que llevara la documentación Orden Generalidades
Párrafos Contenido Cabeceras Finalidades Cantidad Dibujos
División en Párrafos
Un párrafo de más de diez o doce líneas puede dificultar la visión del lector.
Párrafos más cortos, de longitudes variables, modelan la página y el lector tendrá menos peligros de saltarse una línea o de leerla dos veces.
La separación en partes de una serie de sub materias relacionadas, dividas en párrafos y sucesivamente en otras divisiones subordinadas, facilita el examen del texto y da idea de la importancia relativa de cada una, cabe la posibilidad de excederse en una serie de subdivisiones interminables. Normalmente no se utilizan más que cuatro niveles de importancia. Si se necesitarán más será preciso modificar ligeramente la jerarquía de las cabeceras de capitulo. Se advertirá, generalmente que hay alguna cabecera que debe pasar a un nivel inferior. Si no es éste el caso, lo indicado es realizar una redistribución radical del texto.
Cabeceras
Cabeceras o epígrafes, deben ser cortas y expresivas, indicando las materias que se tratan en el párrafo que encabezan y no resumir la dilución. 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 REDACCIÓN DE LOS MANUALES DE DOCUMENTACIÓN
Una persona acostumbrada a leer puede identificar el estilo de un autor; es decir, al estilo en relación con la escritura técnica, 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 técnica, porque atrae la atención del lector hacia si mismo.
El autor técnico debe cultivar un estilo, empleando esta palabra en su sentido más neutro. En la escritura técnica, 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 técnica tiene un significado más limitado, pero más preciso.
Es de destacar que la precisión formal y gramatical, el lenguaje académico es vital en los profesionales en escritura técnica así como también evitar las ambigüedades.
Claridad.
El objetivo de la escritura técnica es la comunicación; por ello la cualidad más deseable es la de la claridad.
Sencillez.
El factor del estilo que más afecta a la claridad es la sencillez. El empleo de “Técnicas” literarias destruye la sencillez.
Modismos.
Desarrollar un dialecto compuesto de palabras y frases empleadas con extraños sentidos, que con seguridad tendrán significado distinto para cada lector.
Su empleo debe evitarse en la escritura técnica.
Brevedad.
Las más breves notas técnicas pueden servirse para comunicarse de manera eficaz con individuos muy calificados. El escritor técnico debe suponer con frecuencia en su lector, aun a expensas de la brevedad, un nivel de comprensión más bajo que el ideal.
Redundancia y “relleno”
Las tres principales razones para la redundancia y el “relleno” en literatura técnica 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. Este estado produce una escritura
“aturullada”, en la que el autor va dando vueltas alrededor de los puntos que no comprende.
Producción de volumen.
Suele darse cuando el escritor advierte que se juzga su capacidad única o principalmente, por su producción diaria. Ejemplo: tantas páginas por hombre / mes de media.
Falta de deseo de volver a escribir.
Cuando un autor ha escrito un párrafo que, al releerlo, parece inadecuado para describir el punto que se intentaba, existe la tentación de añadir otro párrafo más 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 párrafo perfectamente bueno y experimenta, repentinamente la necesidad de perfeccionarlo. El síntoma más común 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 técnica es necesario ocasionalmente.
La proliferación de ejemplos oscurece el texto e impide el fluir del pensamiento.
Puntuación.
Las reglas de la escritura han nacido de la necesidad de claridad. Los signos de puntuación obligatorios (¿ ¡ ? ! ” ´ ) deben colocarse correctamente de acuerdo con el conocimiento técnico elemental.
Longitud de las frases
La escritura técnica no debe constar exclusivamente de afirmaciones cortas y secas. Para evitar ambos extremos se construirán frases de longitud variable, que mantendrán el interés 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 mayoría de los documentos deben escribirse en presente. El uso del tiempo pasado es aconsejable a veces para comunicar información básica, como lo es el del futuro para discutir los resultados que se esperan de determinadas acciones. En los casos de duda se debe emplear el presente.
Voz pasiva.
La voz pasiva es onerosa y lenta de manejar impide la comunicación y dificulta la claridad.
Terminología.
La terminología debe ser consistente en todo documento técnico. Para explicar procesos complicados es inevitable repetir términos.
La escritura técnica sirve para describir y para explicar, pero no para alabar. La escritura técnica 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 técnica. La finalidad de un documento técnico es la precisión.
Evitar expresiones del tipo de “al cabo de un corto tiempo”, “tan pronto como se pueda”, casi al máximo. Dan al lector un aire de frustración y le indican que el escritor no se halla en posesión de todos los datos necesarios.
Humor verbal.
No tiene lugar en la escritura técnica que ha de servir para comunicar, no para distraer.
Descripción.
Un buen método es el de comenzar con una breve descripción del sistema o proceso completo; seguir con una explicación detallada de cada elemento y terminar con un resumen. En algunos casos será más adecuado dividir la descripción más de acuerdo con las funciones que con las partes física del sistema.
Descripción del ambiente.
Al describir ciertas funciones del sistema, ayuda a menudo incluir una breve descripción del ambiente en que se realizan, con el fin de poner de manifiesto cómo faceta el ambiente al diseño del sistema en relación con estas funciones.
Descripción de conjunto del sistema
La documentación de sistemas, subsistemas, programas y procedimientos del usuario exige la inclusión de una pequeña descripción del sistema en su conjunto.
ILUSTRACIONES EN EL MANUAL
Las ilustraciones de un documento técnico deben planearse conjuntamente con el texto y recibir la misma atención.
por lo general debe existir una estrecha relación entre el texto y as ilustraciones.
La planificación del contenido de la ilustración es responsabilidad del autor, aunque puede admitir sugerencias de ilustradores e inspectores técnicos.
Todo autor debe ser capaz de producir, aun grosso modo, una cierta representación de la ilustración que necesite.
Contenido de las Ilustraciones.
El número y tipo de las ilustraciones debe estar en relación 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 ilustración es necesario apreciar los objetivos que pueden cubrirse con las mismas.
El nivel de una ilustración debe mantenerse paralelo al del texto correspondiente. Un pasaje que presenta una descripción general del sistema debe ir acompañado de una ilustración que identifique solamente las principales funciones y subsistemas, mientras que la discusión detallada de la lógica 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 ilustración que se proponga utilizar. También es malo intentar meter demasiadas cosas en una sola ilustración. Un dibujo sobrecargado no cumple su principal misión, que es la de aclarar, porque es difícil leerlo.
ESCRITURA DE PROCEDIMIENTOS
El término procedimiento significa aquí una instrucción para la realización de una tarea o conjunto de tareas especificas. Sus principales caracteres son precisión, 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 ser corto, pero debe serlo tanto como sea compatible con sus características esenciales. Es muy conveniente que se dé, al autor de un procedimiento, la posibilidad de realizar por sí mismo la tarea que describe.
CONCLUSIÓN
Después de haber llevado a cabo el análisis acerca de la pautas para la redacción de manuales, se concluye:
.- La escritura técnica es un trabajo de producción. Tiene un autor y un usuario, y el autor debe considerar las necesidades y exigencias del usuario.
.-Asimismo, 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.
.- Por su parte, el nivel debe venir determinado por la “necesidad de conocer” del lector. 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.
.- Dentro de la organización existen tres aspectos de gran relevancia como son: El Orden: El orden aumenta la eficacia con que la información puede ser transferido del documento al lector; División en Párrafos: Un párrafo de más de diez o doce líneas puede dificultar la visión del lector. Párrafos más cortos, de longitudes variables, modelan la página y el lector tendrá menos peligros de saltarse una línea o de leerla dos veces; Cabeceras: o epígrafes, deben ser
cortas y expresivas, indicando las materias que se tratan en el párrafo que encabezan y no resumir la dilución.
.-Por su parte, el estilo, en el sentido literario es algo imponderable, al hablar de escritura técnica tiene un significado más limitado, pero más preciso. Es por ello que el estilo forma parte de la personalidad del autor, y a través del él un lector puede determinar el autor que lo realiza.
.- Es importante acotar, las ilustraciones de un documento técnico deben planearse conjuntamente con el texto y recibir la misma atención.
por lo general debe existir una estrecha relación entre el texto y as ilustraciones.
la planificación del contenido de la ilustración es responsabilidad del autor, aunque puede admitir sugerencias de ilustradores e inspectores técnicos.
Para finalizar, el término procedimiento significa aquí una instrucción para la realización de una tarea o conjunto de tareas especificas. Sus principales caracteres son precisión, sencillez e integridad, elementos esenciales para la elaboración de los procedimientos en la redacción de los manuales.
BIBLIOGRAFIA
Hartman / h. Mathis. A proeme. Manual de Sistemas de Información.
2da parte.
