Uni

dad

II Planeación de los documentosPlaneación de los documentos

30

D o c u m e n taci ó n t é cn i ca

Esquema conceptual: Unidad II

UNIDAD IIPlaneación de

los documentos

Definición

Características deseables

1. El escritor técnico

Análisis

2. Planeación del documento

Diseño

Implementación

Evaluación

Desarrollo

De actividades

De objetivos y necesidades

Objetivos de la documentación

Perfil del lector

Medios de distribución

Estrategia para la elaboración del documento

Equipo de escritores

Actividades

Productos

Actividades

Productos

Actividades

Productos

Actividades

Productos

31

U n i da d I I . P l a n e aci ó n d e l o s d o c u m e n to s

Sem

ana

3 Presentación

Para elaborar un documento técnico se debe realizar en varias etapas, entre ellas la planeación, que consta de análisis, diseño, desarrollo, evaluación e imple-

mentación.Al iniciar la planeación es fundamental tomar en cuenta si la elaboración del

documento es necesaria o adecuada, ya que 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 será abstenerse de la comunicación o esperar un momento propicio.

La comunicación escrita (ya sea una tarjeta, un correo 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, puede tener una interpretación diferente a la intención ori-ginal de quien lo elaboró.

Sin duda, un documento escrito implica mayor responsabilidad y cuidado, de ahí la idoneidad de que el escritor técnico reúna una serie de atributos.

Sea cual sea el caso, es indispensable reflexionar cuidadosamente antes de es-cribir un documento, cuál será el tiempo que se le dedicará, para una vez que se ha determinado iniciarlo, seguir todas las etapas y consideraciones.

II.1 El escritor técnico

II. Planeación de los documentos

Tema y subtemas

II

Objetivos específicos

• El alumno analizará las diferentes formas de planeación de un documento para definir específicamente la estructura que llevará, procurando un documento de calidad.

II.2 Planeación del documento

II.2.1 Análisis

32

D o c u m e n taci ó n t é cn i ca

¿Crees que sea suficiente que una persona tenga buenos conocimientos de redacción para ser un buen escritor técnico?

Definición del escritor técnico

II.1 El escritor técnico

El escritor técnico es, por supuesto, la persona que escribe documentos técnicos creando documentación fácil de entender para el lector. Actualmente, aún no se identifica en nuestro entorno como una profesión específica, sin embargo, cada vez se reconoce más la importancia de la comunicación escrita y en muchos países avanzados existe el puesto de “escritor técnico”. Así pues, muchos de no-sotros debemos agregar a nuestras actividades laborales cotidianas la escritura técnica.

El escritor técnico debe:

• Saberelegirlapalabraprecisaparaexplicarcadaidea,siempreajustándo-se a las definiciones establecidas.

• Conocerycomprenderbienelcontenido,parapoderloexplicarenformaescrita.

• Debemanejarsuidiomaylostérminostécnicos.• Distinguirentreloestéticoylofuncionalenlasilustraciones.

Generalmente, identificamos como escritor técnico a una persona que habi-tualmente elabora escritos en su ámbito de trabajo y que demuestra las siguientes características:

• Disfrutaaprenderdemaneraconstante.• Tienecapacidaddeanálisis,esdecir,dedescomponeralgoensuspartes.• Tienecapacidaddesíntesis,esdecir,deestructurarunconjuntodeele-

mentos en un todo organizado.• Conocelaterminologíaespecializadao“jerga”propiadesudisciplina.• Dominaeltemasobreelcualescribe.• Demuestraunbuenniveldedominiodellenguajeenelqueescribe,en

este caso español.• Tieneexperienciaenelusodeprocesadoresdepalabra(Word) y/o pro-

gramas de edición de documentos (LaTeX, FrameMaker, PageMaker).• Manejaadecuadamentelasilustraciones.• Escreativo.

Características deseables del escritor

técnico

Habilidades del escritor técnico

II.2 Planeación del documento

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.

Importancia de la planeación

33

U n i da d I I . P l a n e aci ó n d e l o s d o c u m e n to s

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 documento te permite:

• Reflexionaracercadelaconvenienciadecomunicarlainformaciónatra-vés de un documento.

• Escribireldocumentodesdelaperspectivadeunlectorbiendefinido.• Seleccionareltono,lenguajeyestiloadecuadosaestelector.• Definirelmedioapropiadoparahacerllegarlainformaciónallector(co-

rreo electrónico, circular, oficio, manual, etcétera).• Recabarconanticipaciónlainformaciónnecesariaparaelaborareldocu-

mento.• Conformar,siesnecesario,unequipodedocumentación.• Decidirlapresentacióncorrectadeldocumento.• Elegirelsoftware para desarrollar el documento.

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

• Cumplaconsuobjetivo.• Estélistoenlafechaprogramada.

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

Ventajas de la planeación de un documento técnico

Etapas de la planeación

Análisis

Diseño

Desarrollo

Evaluación

Implementación

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

II.2.1 Análisis

En la etapa de análisis se tendrán en cuenta los objetivos a alcanzar a través del documento técnico. El escritor técnico o el equipo de escritores realizarán entre-

34

D o c u m e n taci ó n t é cn i ca

Actividades del análisis

vistas o revisarán documentos anteriores relacionados con el tema. Una vez deter-minadas las necesidades y recursos disponibles, se definirá la estrategia a seguir.

Durante el análisis se deben realizar las siguientes actividades:

1. Definir con precisión los objetivos de la documentación y las necesidades a satisfacer.

2. Identificar el perfil de los lectores.3. Seleccionar el medio de entrega.4. Establecer una estrategia de documentación.5. Conformarelequipodeescritorestécnicos.

Antes de elaborar un documento, por pequeño o sencillo que sea, es indispen-sable determinar cuál es su objetivo. En algunas ocasiones puede ser conveniente, incluso, escribirlo. Si el documento es breve, bastará con tenerlo en mente de ma-nera clara.

Para definir los objetivos y necesidades a satisfacer, conviene hacerse las si-guientes preguntas:

• ¿Quésepretendelograrconeldocumento?• ¿Quétipodenecesidadessepretendensatisfacerconeldocumento?• ¿Lomejorparalograrelobjetivoesundocumentootalvezconvieneuna

conversacióntelefónicaounareuniónpersonal?

Algunos de los objetivos generales más frecuentes de la documentación son:

• Informar.• Solicitarinformación.• Pedirqueserealiceunaacción.• Documentarunproceso,procedimiento,hecho,etc.• Hacerunllamadodeatención.• Agradecerofelicitar.• Pedirdisculpas.

Debe definirse qué clase de destinatario leerá el documento. De manera muy general, el destinatario puede ser:

• Superior• Par• Subordinado• Externo

Asimismo, se requiere describir a los lectores en cuanto a:

• Nivel educativo:¿Sonsuficientementeclaraslasexplicaciones?¿Resul-tanexcesivasparaelniveleducativodelamayoríadeloslectores?

Definición de los objetivos y necesidades

Preguntas que ayudan a definir el objetivo

Perfil del lector

Objetivos de la documentación

35

U n i da d I I . P l a n e aci ó n d e l o s d o c u m e n to s

Medio de distribución

• Experiencia sobre el tema:¿Puedenincluirsetérminostécnicosporquesonfamiliaresparaloslectores?¿Puedendarseporsabidoslosantecedentes?

• Heterogeneidad:¿Loslectorestendránunperfilsemejanteohaydiver-sidadenellos?¿Elmismodocumentodebefuncionarparaeldirectivoyeloperador?

• Vocabulario:¿Esnecesariodefinirtérminos?¿Serequeriráunglosario?

• Cultura: ¿Puedenusarse referencias a cuestiones típicaso lenguajedecierta región? ¿Esmejor utilizar ejemplos universales? ¿Conviene usarejemplosfutbolísticosogastronómicos?

• Actitud hacia el tema:¿Loslectoresestánpredispuestosencontraoafavordeltema?¿Debeusarsesentidodelhumoroserformal?

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.

Tododocumento,desdeunasencillanotahastaunlibro,debesercuidadosa-mente pensado y organizado. Una vez que se ha definido el objetivo y el destinata-rio se elegirá la mejor forma de hacer llegar el documento a la persona a quien va dirigido. Entre los principales tipos de documentos pueden citarse:

• Nota• Memorándum• Oficio• Carta• Circular• Informe• Reporte• Correoelectrónico• Manual• Reglamento• Libro

En cuanto se tienen definidos el objetivo, el destinatario y el medio de dis-tribución, se programa 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

Estrategia para la elaboración del documento

36

D o c u m e n taci ó n t é cn i ca

• Requerimientos• Fechaslímite

Habráescritosquenorequierandeunequipodeescritoressinodeunsoloautor.Cuandoesnecesarioquevariaspersonasparticipenenundocumentodebecuidarse especialmente la planeación, ya que de otra manera se corre el riesgo de caer en repeticiones, omisiones o en la falta de un estilo homogéneo.

A partir del análisis se generan dos productos:

• Plandetrabajo• Reportedeavance

Cadatipodedocumentotieneunaestructuraespecífica.Enuncorreoelec-tró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.

Definir un equipo de escritores o al escritor

Importancia de la definición del tipo de

documento

Productos de la etapa de análisis

37

U n i da d I I . P l a n e aci ó n d e l o s d o c u m e n to s

Reactivos de autoevaluación

Instrucciones: Escribe en la línea la letra correspondiente, Fpara falso y V para verdadero.

1. Cualquierpersonaqueseparedactarbienesunbuenescritortécnico. _____

2. Es preferible contar con un escritor técnico que sea hábil en lo estético porque es lo fundamentalenunbuendocumento. _____

3. Es deseable que el escritor técnico tenga capacidad de análisis, aunque no tenga habilidaddesíntesis. _____

4. A diferencia de la escritura tradicional, el escritor técnico debe tener experiencia enelusodeprocesadoresdepalabrayprogramasdeedicióndedocumentos. _____

5. Para elaborar un documento técnico primero debe planearse a través de las etapas de análisis, diseño, desarrollo, evaluación e implementación, cada etapa tiene sus actividadesarealizarysusproductosresultantes. _____

6. Entre las actividades a realizar en la etapa de análisis en la planeación de documentos se definen los objetivos y se identifican a los lectores; se deja para otra etapa la selección del medio de distribución, la estrategia de documentación ylaconformacióndeunequipodetrabajo. _____

7. Una pregunta fundamental para establecer los objetivos del documento es: ¿quénecesidadessepretendensatisfacerconeldocumento? _____

8. Conocerelperfildeldestinatariodeldocumentoesunadelasactividadesque debenrealizarseparaplanearundocumentotécnico. _____

9. La estrategia de documentación incluye un plan de trabajo donde se plantean entre otras características las etapas a seguir, las actividades, los responsables, losrequerimientosylosparticipantes. _____

10. La estrategia de documentación incluye un plan de trabajo donde se plantean entre otras características las etapas a seguir, las actividades, los responsables, losrequerimientosylasfechaslímite. _____

38

D o c u m e n taci ó n t é cn i ca

Word: Procesador de textos de la suiteofimáticaOffice®deMicrosoft®.LaTeX: Procesador de textos que funciona básicamente a través de órdenes (ma-

cros), especialmente práctico para el sector científico y técnico, en eventos académicossueleserunestándarenlaelaboracióndedocumentos.Tam-bién se le conoce como un lenguaje de marcado. Este programa es software libre.

FrameMaker: Programa para la creación y publicación de documentación técni-ca, posee una interfaz de usuario donde pueden establecerse flujos de tra-bajo unificados y un entorno de creación basado en plantillas para el envío decontenido.CorrespondealacompañíaAdobe®.

PageMaker: Programa de maquetación de páginas para crear publicaciones de alta calidad como folletos y boletines. Posee plantillas, gráficos y herra-mientasdediseño.CorrespondealacompañíaAdobe®.

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

Glosario

Fuentes de información

39

U n i da d I I . P l a n e aci ó n d e l o s d o c u m e n to s

Panel de verificación

F

F

F

V

V

F

V

V

F

V

Instrucciones: Escribe en la línea la letra correspondiente, Fpara falso y V para verdadero.

1. Cualquierpersonaqueseparedactarbienesunbuenescritortécnico. _____

2. Es preferible contar con un escritor técnico que sea hábil en lo estético porque es lo fundamentalenunbuendocumento. _____

3. Es deseable que el escritor técnico tenga capacidad de análisis, aunque no tenga habilidaddesíntesis. _____

4. A diferencia de la escritura tradicional, el escritor técnico debe tener experiencia enelusodeprocesadoresdepalabrayprogramasdeedicióndedocumentos. _____

5. Para elaborar un documento técnico primero debe planearse a través de las etapas de análisis, diseño, desarrollo, evaluación e implementación, cada etapa tiene sus actividadesarealizarysusproductosresultantes. _____

6. Entre las actividades a realizar en la etapa de análisis en la planeación de documentos se definen los objetivos y se identifican a los lectores; se deja para otra etapa la selección del medio de distribución, la estrategia de documentación ylaconformacióndeunequipodetrabajo. _____

7. Una pregunta fundamental para establecer los objetivos del documento es: ¿quénecesidadessepretendensatisfacerconeldocumento? _____

8. Conocerelperfildeldestinatariodeldocumentoesunadelasactividadesque debenrealizarseparaplanearundocumentotécnico. _____

9. La estrategia de documentación incluye un plan de trabajo donde se plantean entre otras características las etapas a seguir, las actividades, los responsables, losrequerimientosylosparticipantes. _____

10. La estrategia de documentación incluye un plan de trabajo donde se plantean entre otras características las etapas a seguir, las actividades, los responsables, losrequerimientosylasfechaslímite. _____