Você está na página 1de 11

DOCUMENTACIÓN TÉCNICA

Sesión 3 Planeación y Principios del


MI

Lección 3.1 Introducción

Objetivo
En algunas ocasiones la urgencia de entregar un documento ocasiona que no se
destine tiempo a su planeación. Se cree -erróneamente- que resultará más efi-
ciente ponerse a escribir de inmediato, sin efectuar antes una revisión cuidadosa
de aspectos tan importantes como el objetivo, el destinatario y el medio de en-
trega. El descuido (o la omisión) de la planeación puede provocar que el docu-
mento no cumpla su objetivo, que resulte de mala calidad o, peor aún, que se
cometan errores o daños irreparables por su incorrecta interpretación. Por otro
lado, una vez que se ha planeado un documento, te será muy útil considerar en
su elaboración los siete principios del Mapeo de Información, ya que facilitan la
producción rápida de documentos con excelente calidad. En esta sesión identifi-
carás las etapas que debes cubrir en la planeación y elaboración de un documen-
to técnico, así como los principios del Mapeo de Información y la forma de apli-
carlos.

Contenido
de la sesión

Figura 3-1 Contenido de la sesión

MAESTRÍA EN TECNOLOGÍAS DE INFORMACIÓN - PÁGINA 35 


DOCUMENTACIÓN TÉCNICA

Lección 3.2 Planeación de los documentos

Importancia de
la planeación
No importa si el documento es urgente o si se trata de un sencillo correo electró-
nico o mensaje en línea, la planeación de un documento técnico es un proceso
indispensable. En muchas ocasiones, contrariamente a lo que suele pensarse, el
proceso de escribir un documento sin la planeación adecuada puede resultar más
lento e ineficiente que hacerlo con una metodología rigurosa. Planear un docu-
mento te permite:

• Reflexionar acerca de la conveniencia de comunicar la información a través


de un documento.
• Escribir el documento desde la perspectiva de un lector bien definido.
• Seleccionar el tono, lenguaje y estilo adecuados a este lector.
• Definir el medio apropiado para hacer llegar la información al lector (correo
electrónico, circular, oficio, manual, etc.).
• Recabar con anticipación la información necesaria para elaborar el docu-
mento.
• Conformar, si es necesario, un equipo de documentación.
• Decidir la presentación correcta del documento.
• Elegir el software para desarrollar el documento.

Pero, sobre todo, la planeación te da la mejor garantía de que el documento:

• Cumpla con su objetivo.


• Esté listo en la fecha programada.

MAESTRÍA EN TECNOLOGÍAS DE INFORMACIÓN - PÁGINA 36 


DOCUMENTACIÓN TÉCNICA

Etapas de la
planeación
Las etapas que se sugieren para la creación de documentos técnicos son:

A continuación se describe cada una de ellas, las actividades que implican y sus
productos resultantes.

MAESTRÍA EN TECNOLOGÍAS DE INFORMACIÓN - PÁGINA 37 


DOCUMENTACIÓN TÉCNICA

Lección 3.3 Análisis

Descripción
En la etapa de análisis el escritor técnico o equipo de escritores, deben involu-
crarse con la organización en la cual se trabaja y determinar con precisión los
objetivos a lograr a través del documento técnico.
Esta etapa puede requerir de entrevistas y revisiones de documentos anteriores
y/o relacionados con el tema. De acuerdo con las necesidades y recursos dispo-
nibles se forma el equipo de trabajo y se determina la estrategia a seguir.

Actividades
Durante el análisis debes realizar las siguientes actividades:

• Define con precisión los objetivos de la documentación y las necesidades a


satisfacer.
• Identifica el perfil de tus lectores.
• Selecciona el medio de entrega.
• Establece una estrategia de documentación.
• Conforma el equipo de escritores técnicos.

A continuación se detalla cada una de ellas.

Objetivos y
necesidades
Antes de elaborar un documento, por pequeño o sencillo que éste sea, es indis-
pensable determinar cuál es su objetivo. En algunas ocasiones puede ser conve-
niente, incluso, escribir este objetivo. Si el documento es breve, bastará con te-
nerlo en mente de manera clara.
Para definir los objetivos y necesidades a satisfacer, conviene hacerse las si-
guientes preguntas:

1. ¿Qué se pretende lograr con el documento?


2. ¿Qué tipo de necesidades se pretenden satisfacer con el documento?
3. ¿Lo mejor para lograr el objetivo es un documento o tal vez conviene
una conversación telefónica o una reunión personal?

MAESTRÍA EN TECNOLOGÍAS DE INFORMACIÓN - PÁGINA 38 


DOCUMENTACIÓN TÉCNICA

Objetivos
frecuentes
Algunos de los objetivos generales más frecuentes son:

• Informar.
• Solicitar información.
• Pedir que se realice una acción.
• Documentar un proceso, procedimiento, hecho, etc.
• Hacer un llamado de atención.
• Agradecer o felicitar.
• Pedir disculpa.

Escribir o no
escribir...
Al definir el objetivo puede ocurrir que llegues a la conclusión de que no es ne-
cesario o adecuado comunicarte a través de un documento. En algunos casos
puede ser más eficiente buscar a la persona o hacer una llamada telefónica.
Habrá otros casos en los cuales lo mejor es abstenerse de la comunicación o es-
perar un momento de mayor tranquilidad.
Debes recordar siempre que la comunicación escrita (ya sea una tarjeta, un co-
rreo electrónico, un oficio, etc.) tiene una trascendencia diferente a la palabra
hablada. Un documento puede llegar a manos distintas de su destinatario original
o puede ser leído sin la presencia del autor y, por lo tanto, sufrir una interpreta-
ción diferente a la intención original de quien lo elaboró. Sin duda, un documen-
to escrito implica mayor responsabilidad y cuidado.
Por ello es un paso indispensable, sea cual sea el caso, reflexionar cuidadosa-
mente antes de escribir un documento. El breve espacio de tiempo que dedicarás
a la definición del objetivo puede ahorrarte una gran cantidad de problemas pos-
teriores.

Perfil del
lector
Deberás definir qué clase de destinatario leerá tu documento. De manera muy
general, el destinatario puede ser:
• Superior
• Par
• Subordinado
• Externo

Continúa en la siguiente página

MAESTRÍA EN TECNOLOGÍAS DE INFORMACIÓN - PÁGINA 39 


DOCUMENTACIÓN TÉCNICA

Asimismo, describe cómo son tus lectores en cuanto a:

• Nivel educativo: ¿Son suficientemente claras tus explicaciones? ¿Resultan


excesivas para el nivel educativo de la mayoría de los lectores?
• Experiencia sobre el tema: ¿Puedes incluir términos técnicos porque son fa-
miliares para los lectores? ¿Puedes dar por sabidos los antecedentes?
• Heterogeneidad: ¿Tus lectores tendrán un perfil semejante o hay diversidad
en ellos? ¿El mismo documento debe funcionar para el directivo y el opera-
dor?
• Vocabulario: ¿Es necesario definir términos? ¿Se requerirá un glosario?
• Cultura: ¿Puedes usar referencias a cuestiones típicas o lenguaje de cierta
región? ¿Es mejor utilizar ejemplos universales? ¿Conviene usar ejemplos
futbolísticos o gastronómicos?
• Actitud hacia el tema: ¿Los lectores están predispuestos en contra o a favor
del tema? ¿Debes usar sentido del humor o ser formal?

De acuerdo con el tipo de destinatario deberás definir la forma de documento y


la manera en que te dirigirás a la persona, de manera congruente con el objetivo
planteado.

Medio de
distribución
Todo documento, desde un sencillo post-it hasta un libro, debe ser cuidadosa-
mente pensado y organizado. Una vez que has definido el objetivo y el destinata-
rio, estos dos aspectos te ayudarán a elegir la mejor forma de hacer llegar el do-
cumento a la persona a quien va dirigido.
Entre los principales tipos de documentos pueden citarse:

• Nota, memorándum
• Oficio, carta
• Circular
• Informe, reporte
• Correo electrónico
• Manual
• Reglamento
• Libro

Continúa en la siguiente página

MAESTRÍA EN TECNOLOGÍAS DE INFORMACIÓN - PÁGINA 40 


DOCUMENTACIÓN TÉCNICA

Como supondrás, cada uno de estos tipos de documentos tiene una estructura es-
pecífica. En un correo electrónico sabemos que los elementos son el destinatario,
el asunto, el remitente, el cuerpo del mensaje, etc. En cambio, en un reglamento
puede haber capítulos, títulos y artículos.
De esta forma, saber qué tipo de documento se elaborará es un paso fundamental
para definir posteriormente la estructura adecuada.

Estrategia
de documen-
tación
En cuanto tengas definidos el objetivo, el destinatario y el medio de distribución,
debes programar la elaboración del documento. Si bien en algunos casos puede
ser una actividad sencilla e inmediata, mientras más complejo e importante sea
un documento, más necesario será programar su desarrollo. El programa se
plasma en un plan de trabajo que incluye

• Etapas
• Actividades
• Responsables
• Requerimientos
• Fechas límite

Equipo de
escritores
Por supuesto, habrá escritos que no requieran de un equipo de escritores sino de
un solo autor. Sin embargo, cuando es necesario que varias personas participen
en un documento debe cuidarse especialmente la planeación ya que, de otra ma-
nera, se corre el riesgo de caer en repeticiones, omisiones o falta de un estilo
homogéneo.

Productos
A partir del análisis se generan dos productos:

• Plan de trabajo
• Reporte de avance.

MAESTRÍA EN TECNOLOGÍAS DE INFORMACIÓN - PÁGINA 41 


DOCUMENTACIÓN TÉCNICA

Lección 3.4 Diseño

Descripción
La segunda etapa es el diseño. Una vez realizado el análisis, se crea el esqueleto
del documento, es decir, la estructura principal que lo conformará, todavía sin el
contenido en detalle. Se trata de un esquema general. También en esta etapa se
crea la guía de estilos, que debe diseñarse tomando en cuenta a los lectores po-
tenciales y la cual contendrá las indicaciones en cuanto a lenguaje, vocabulario,
tipografía, colores, etc., que se usarán a lo largo de todo el documento. Una vez
fijados dichos estándares, todos los escritores deberán utilizarlos en la misma
forma.

Actividades
Durante el diseño debes realizar las siguientes actividades:

• Define las especificaciones de contenido.


• Desarrolla la estructura detallada de los documentos.
• Establece los componentes de la guía de estilos.
• Diseña documentos prototipo.
• Revisa el plan de trabajo.

Productos
A partir del diseño se generan tres productos:

• Estructura detallada de los documentos.


• Borrador de la guía de estilos.
• Reporte de avance.

MAESTRÍA EN TECNOLOGÍAS DE INFORMACIÓN - PÁGINA 42 


DOCUMENTACIÓN TÉCNICA

Lección 3.5 Desarrollo

Descripción
Como tercer paso, una vez realizadas las etapas anteriores, se procede al desa-
rrollo del contenido del documento, con lo cual se “rellena” la estructura, la cual
será una especie de “esqueleto” del documento. De esta forma, al seguir al pie de
la letra la guía de estilos, se obtendrá un documento homogéneo y fácil de modi-
ficar o actualizar.

Actividades
Durante el desarrollo debes realizar las siguientes actividades:

• Crea documentos prototipo.


• Obtén la aprobación de los prototipos.
• Completa la guía de estilos.
• Crear las ilustraciones.
• Crear y revisar borradores.

Productos
A partir del desarrollo se generan tres productos:

• Documentos prototipo.
• Guía de estilos.
• Reporte de avance.

MAESTRÍA EN TECNOLOGÍAS DE INFORMACIÓN - PÁGINA 43 


DOCUMENTACIÓN TÉCNICA

Lección 3.6 Evaluación

Descripción
En cualquier trabajo resulta indispensable realizar una evaluación, antes de dar-
lo a conocer. En esta etapa se revisará la forma, el contenido, la presentación, la
ortografía, redacción, etc., del documento. Se sugiere que esta revisión sea hecha
por personas distintas a los escritores, en un formato semejante al de distribu-
ción, con el fin de que se evite todo tipo de errores o descuidos. Adicionalmente,
en esta etapa se crean las referencias del documento.

Actividades
Durante la evaluación debes realizar las siguientes actividades:

• Crea los apéndices.


• Crea los glosarios.
• Crea los índices y tablas de contenido.
• Revisa los documentos terminados.
• Obtén la aprobación final.

Productos
De la evaluación se generan tres productos:

• Versiones finales de los documentos.


• Documentos originales terminados.
• Reporte de avance.

MAESTRÍA EN TECNOLOGÍAS DE INFORMACIÓN - PÁGINA 44 


DOCUMENTACIÓN TÉCNICA

Lección 3.7 Implementación

Descripción
Finalmente, una vez que se ha determinado que el documento satisface las nece-
sidades y requisitos de la organización, puede organizarse su distribución o im-
plementación.
Es importante observar que cada copia del documento tenga la mejor calidad,
sea cual sea su medio de distribución.
Asimismo, todo documento técnico requiere de revisiones y adecuaciones sis-
temáticas, por lo cual deberá definirse una estrategia para mantener el documen-
to actualizado.

Actividades
Durante la implementación debes realizar las siguientes actividades:

• Define los detalles de reproducción masiva.


• Selecciona materiales, empaque y mecanismos de distribución.
• Determina las estrategias de mantenimiento y actualización.
• Redacta las memorias del proyecto.

Productos
De la implementación se generan:

• Documentación en archivos para crear originales mecánicos y galeras.


• Producción final.
• Memorias del proyecto.

MAESTRÍA EN TECNOLOGÍAS DE INFORMACIÓN - PÁGINA 45