unidad i€¦ · las referencias: conformadas por apéndices, fuentes e índices (analítico,...

13
Unidad I INTRODUCCIÓN

Upload: others

Post on 16-Jul-2020

12 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: Unidad I€¦ · Las referencias: conformadas por apéndices, fuentes e índices (analítico, tablas, figuras, autoridades, código, etc.). Si bien existen documentos que carecen

Unidad I INTRODUCCIÓN

Page 2: Unidad I€¦ · Las referencias: conformadas por apéndices, fuentes e índices (analítico, tablas, figuras, autoridades, código, etc.). Si bien existen documentos que carecen

Asignatura: Documentación Técnica

Licenciatura en Derecho 2

Unidad I: Introducción

Semana 2

A. PRESENTACIÓN

Existe un procedimiento y reglas específicas para elaborar documentos técnicos, según las características y

tipo de cada documento. Así, en principio es indispensable identificar la categoría del documento que se

escribirá. De esta forma pueden seleccionarse las opciones a utilizar, e iniciar la planeación del documento.

Para identificar de manera inicial los documentos es preciso especificar su objetivo o su función, su estilo de

presentación o su forma de distribución. Estos factores se integran en la estructura del documento a través de

una organización definida, con la finalidad de cubrir el propósito que se le ha fijado.

B. OBJETIVO ESPECÍFICO

El alumno conocerá la clasificación de los documentos, por su estilo, su función y distribución; así como la

estructura que debe de tener, con la finalidad de elaborar un buen documento.

Page 3: Unidad I€¦ · Las referencias: conformadas por apéndices, fuentes e índices (analítico, tablas, figuras, autoridades, código, etc.). Si bien existen documentos que carecen

Asignatura: Documentación Técnica

Licenciatura en Derecho 3

C. TEMA Y SUBTEMAS

1. INTRODUCCIÓN

1.4 Tipos de documentos por su objetivo o función.

1.5 Tipos de documentos por su estilo de presentación.

1.6 Tipos de documentos por su forma de distribución.

1.7 Estructura del documento.

D. MAPA MENTAL: UNIDAD I

Page 4: Unidad I€¦ · Las referencias: conformadas por apéndices, fuentes e índices (analítico, tablas, figuras, autoridades, código, etc.). Si bien existen documentos que carecen

Asignatura: Documentación Técnica

Licenciatura en Derecho 4

E. CONTENIDO

Un documento puede clasificarse:

Por su función.

Por su estilo de presentación.

Por su medio de distribución.

A continuación se explica y ejemplifica cada una de las categorías.

1.4 Tipos de documentos por su objetivo o función

Clasificación de documentos técnicos

En general, se pueden clasificar los documentos técnicos en seis tipos, de

acuerdo con su objetivo primordial:

Manuales: de usuario, de referencia, prontuarios, de procedimientos,

de organización. Un manual se escribe en forma imperativa, es decir,

da indicaciones precisas para formas de actuar.

Reportes: listados, formas, formatos, cuadros, machotes. Cabe señalar

que todo formato debe ser fácil de llenar, debe tener una estructura

lógica y bien definida. Los reportes deben brindar facilidad visual para

encontrar información importante.

Comunicados: oficios, circulares, memorándums, correos electrónicos.

Un comunicado debe ser atractivo, debe contener toda la información

relevante, en una secuencia lógica.

Presentaciones: material para cursos, apoyo didáctico, exposiciones,

ponencias. Lo que se presente en pantalla debe ser muy breve,

conciso y bien estructurado.

¿Cuál documento debe escribirse de forma imperativa?

Page 5: Unidad I€¦ · Las referencias: conformadas por apéndices, fuentes e índices (analítico, tablas, figuras, autoridades, código, etc.). Si bien existen documentos que carecen

Asignatura: Documentación Técnica

Licenciatura en Derecho 5

Ayudas en línea: archivos con documentación para uso de software,

que pueden ser utilizados en forma local o vía remota. Deben ser

cortos, fragmentados, con índice y glosario.

Documentos interactivos: sitios web, demostraciones, discos

compactos, formas electrónicas. En estos documentos no debe

abusarse de los elementos visuales. Pueden contener animaciones,

multimedia, etc., pero siempre de manera pertinente y cuidadosa.

1.5 Tipos de documentos por su estilo de presentación

Estilos básicos

Los documentos técnicos pueden presentarse de tres estilos básicos:

Sólo texto.

Texto e ilustraciones.

Sólo ilustraciones.

Aun cuando actualmente los programas de cómputo, escáneres, cámaras

digitales, etc., hacen muy sencilla la inclusión de ilustraciones en los

documentos, éstas sólo deben usarse cuando apoyan la comprensión del

contenido. De otro modo, no solamente serán inútiles, sino que harán más difícil

la lectura del texto. A continuación se muestran ejemplos de cada uno de ellos.

Sólo texto

Aun cuando no requiere figuras, debe tener una estructura perfectamente bien

definida y clara a simple vista para el lector.

¿Qué elementos se combinan en los tres estilos básicos de un

documento?

Page 6: Unidad I€¦ · Las referencias: conformadas por apéndices, fuentes e índices (analítico, tablas, figuras, autoridades, código, etc.). Si bien existen documentos que carecen

Asignatura: Documentación Técnica

Licenciatura en Derecho 6

Texto e ilustraciones

Cada uno de los gráficos o ilustraciones debe servir para facilitar la

comprensión del contenido, en forma adicional al texto.

Sólo ilustraciones

En este tipo de documentos prácticamente toda la información se explica a

través de ilustraciones, con poco o ningún texto. Es útil para ser comprendido

por niños o, para textos de aprendizaje de idiomas o para facilitar la

comprensión de personas que hablan distintas lenguas.

Page 7: Unidad I€¦ · Las referencias: conformadas por apéndices, fuentes e índices (analítico, tablas, figuras, autoridades, código, etc.). Si bien existen documentos que carecen

Asignatura: Documentación Técnica

Licenciatura en Derecho 7

1.6 Tipos de documentos por su forma de distribución

Medios de distribución

Es indispensable considerar la forma en que el documento se hará llegar a los

lectores. No es lo mismo un documento impreso que un documento electrónico.

Será distinto si se envía en original que si se sacan fotocopias, si se presenta a

través de un proyector o se ve directamente del monitor. Todo esto será

fundamental para definir el contenido, la tipografía y el diseño del documento.

En general, se tienen tres grandes medios de distribución:

Documentos impresos.

Documentos electrónicos.

Documentos para presentación en pantalla.

Impresos

Son los documentos impresos en algún tipo de papel. Entre ellos están las

hojas sueltas, cuadernos, engargolados, libros, etc. Este tipo de documentos

parece tender a disminuir puesto que su elaboración resulta más cara y

laboriosa que la de los documentos electrónicos. Sin embargo, cierta

información requiere de ser impresa para ser fácil de manejar y/o confiable. Por

ejemplo: facturas, libros, cartas, revistas, etcétera.

¿Qué formas de distribución conoces?

Page 8: Unidad I€¦ · Las referencias: conformadas por apéndices, fuentes e índices (analítico, tablas, figuras, autoridades, código, etc.). Si bien existen documentos que carecen

Asignatura: Documentación Técnica

Licenciatura en Derecho 8

Electrónicos

Los documentos electrónicos, tienen cada vez con mayor auge, ya que se

distribuyen rápidamente y ahorran papel. Entre ellos se encuentra el correo

electrónico y archivos adjuntos (Word y PDF), y las páginas web, entre otros.

Page 9: Unidad I€¦ · Las referencias: conformadas por apéndices, fuentes e índices (analítico, tablas, figuras, autoridades, código, etc.). Si bien existen documentos que carecen

Asignatura: Documentación Técnica

Licenciatura en Derecho 9

Proyecciones

Proyecciones para presentar el documento de manera simultánea a varias

personas. Entre ellas se encuentran las presentaciones con proyector, acetatos,

diapositivas, etc.

1.7 Estructura del documento

Partes del documento

Aun cuando sea muy breve, un documento técnico suele tener tres grandes

partes:

El preámbulo: es la parte inicial del texto, con la cual generalmente el

lector se da una primera idea del contenido. Está conformado por

elementos como: portada, tabla de contenido e introducción.

El contenido: conformado por elementos como la descripción del

entorno, desarrollo y conclusión.

Las referencias: conformadas por apéndices, fuentes e índices

(analítico, tablas, figuras, autoridades, código, etc.).

Si bien existen documentos que carecen de alguno de estos elementos, pero en

general es recomendable que aparezcan todos.

¿Cuándo realizas un documento académico usas las tres secciones

marcadas: preámbulo, contenido y referencias?

Page 10: Unidad I€¦ · Las referencias: conformadas por apéndices, fuentes e índices (analítico, tablas, figuras, autoridades, código, etc.). Si bien existen documentos que carecen

Asignatura: Documentación Técnica

Licenciatura en Derecho 10

La portada es esencial y no debe descuidarse, ya que genera la primera

impresión del lector acerca del documento. Puede depender de la portada si el

documento se lee o no.

En ocasiones se confunde el índice con la tabla de contenido. La enumeración

de los temas (capítulos, secciones, etc.) con sus respectivos números de

página es la tabla de contenido que se coloca al inicio del documento para que

el lector pueda tener una idea rápida y general sobre lo que encontrará en él.

Un índice, en cambio, es una lista de autores, palabras o temas. También se

conocen como índices analíticos, índices de temas o índices de autoridades.

Page 11: Unidad I€¦ · Las referencias: conformadas por apéndices, fuentes e índices (analítico, tablas, figuras, autoridades, código, etc.). Si bien existen documentos que carecen

Asignatura: Documentación Técnica

Licenciatura en Derecho 11

F. CONCLUSIÓN

Una vez que se ha identificado el objetivo de un documento y su clasificación según su función, ya sea que se

trate de un reporte, un comunicado, una presentación, ayudas en línea o documentos interactivos; así como

su estilo de presentación, como solo texto, texto e ilustraciones, o solo ilustraciones; y su medio de

distribución, ya sea impreso, electrónico, o como presentación en pantalla, es factible continuar con el

desarrollo del mismo.

Así, entonces se debe definir la estructura del documento, es decir, la forma en que se desarrollará tanto el

preámbulo, como el contenido y las referencias. De una elección adecuada dependerá el resultado del

impacto del artículo entre los destinatarios.

Page 12: Unidad I€¦ · Las referencias: conformadas por apéndices, fuentes e índices (analítico, tablas, figuras, autoridades, código, etc.). Si bien existen documentos que carecen

Asignatura: Documentación Técnica

Licenciatura en Derecho 12

G. LECTURAS COMPLEMENTARIAS

UADY (s/f) ¿Qué es una referencia bibliográfica? Consultado en diciembre de 2013 en http://www.tizimin.uady.mx/biblioteca/ReferenciasBibliograficas/

H. GLOSARIO

Término Significado

Índice analítico Listado por conceptos, los más relevantes del texto en

el que se indica los números de página en que cada

uno se encuentra a lo largo de la obra.

Índice de autoridades Listado de los autores consultados para realizar la obra.

Índice de temas Listado organizado según los temas generales

abordados en la obra.

Machote Término que se emplea al formato de un documento

que se emplea a modo de plantilla para hacer más del

mismo estilo.

Tipografía Arte o técnica de seleccionar y manipular tipos de letra

para reproducir la comunicación a través de la palabra

impresa, con el fin de transmitir de forma hábil, elegante

y eficaz las palabras.

Page 13: Unidad I€¦ · Las referencias: conformadas por apéndices, fuentes e índices (analítico, tablas, figuras, autoridades, código, etc.). Si bien existen documentos que carecen

Asignatura: Documentación Técnica

Licenciatura en Derecho 13

I. FUENTES DE INFORMACIÓN

a) Bibliográficas

González, M. (2005). Documentación Técnica. México. UNID.

b) Cibergráficas

Radford, R. (2013) Cómo escribir notas al pie, referencias electrónicas y bibliografías en un formato

adecuado. Consultado en diciembre de 2013 en http://www.imperialtometric.com/Edition/nota/