Guía de documentación

Versión 1.4 - 10 de septiembre de 2006

A. Introducción

Esta guía tienen el propósito de apoyar la preparación de documentos. Contiene algunas recomendaciones básicas de estilo, orientaciones generales sobre la estructura de los documentos y el contenido que éstos comprenden.

La guía no pretende ser un conjunto de normas rígidas. Se trata más bien de premisas para ser superadas. Los contenidos requeridos por cada tipo de documento no necesariamente corresponde a la división que éstos deben llevar. Se trata más bien de la información que no debe faltar.

Los documentos acá descritos son básicos. Es decir que de ellos se pueden derivar combinaciones o documentos más complejos.

Documentos graduales y finales

Para los documentos se hace una distinción básica: documentos finales, que no volverán a ser editados, y documentos graduales cuyo contenido se va definiendo progresivamente. Estas posibilidades no son excluyentes: un documento gradual puede llegar a ser final, o un documento final puede ser la base para uno gradual.

Para los documentos graduales se utilizará un número de versión compuesto por dos dígitos separados por un punto. El dígito de la derecha se referirá a las revisiones menores y el dígito de la izquierda a las mayores. Ejemplos: 0.2, 1.13, 2.0. Además, al final del documento se incluirá una sección en la que se resuman los cambios más relevantes introducidos de versión a versión.

Será responsabilidad de los autores de los documentos llevar el control de versiones y decidir los momentos en que el número de versión deba cambiar.

Redacción y revisión

Cuando los documentos estén destinados a un público externo es recomendable que sean sometidos a un proceso de revisión.

El encargado de la revisión ayudará a eliminar las faltas de ortografía y gramaticales. Velará por la observancia de los criterios contenidos en esta guía y otros generalmente aceptados en la edición de textos.

El encargado de la revisión también hará un análisis crítico de los contenidos, buscando la mejor sustentación y coherencia del documento.

Tipos de documentos básicos

A continuación se listan los tipos de documentos básicos. Pueden ser utilizados en forma directa o bien los documentos se pueden basar en una parte o en una combinación de tales tipos básicos.

• Notas de eventos y alertas
• Reporte de acuerdos o posiciones
• Programación de eventos
• Plan de trabajo
• Informe de resultados

Notas de eventos y alertas

Un evento es un hecho de relevancia que amerita ser reportado. Puede ser una reunión, la publicación de un documento o el anuncio de una actividad, entre otras posibilidades.

La estructura de una nota es la siguiente:

• Título
• Lugar y fecha de la nota
• Cuerpo de la nota:
  • Descripción del evento: naturaleza y características del evento, lugar y fecha dónde se dio, personas y grupos involucrados.
  • Contexto y relevancia: circunstancia especiales en las que se dio el evento y razones que los hacen relevante.
  • Antecedentes y consecuencias: referencias breves sobre eventos previos que condujeron al reportado y algunas proyecciones sobre sus consecuencias.
  • Impresiones: comentarios o interpretaciones de los involucrados en el evento
• Referencias: contactos, documentos y otras referencias relevantes al evento
• Responsables: nombre del autor, cargo y datos de contacto del redactor y del revisor.

Las alertas son denuncias sobre prácticas de corrupción y los efectos que estás tienen, especialmente en materia de afectación de derechos a las personas afectadas. Su estructura es igual a la de una nota con las siguientes salvedades:

• En las impresiones se debe incluir una interpretación jurídico-política de los hechos denunciados y la posición institucional de Probidad.
• Debe contener un apartado de acciones recomendadas, como sugerencias para que otras personas o grupos puedan ofrecer su respaldo a la denuncia realizada.

Se recomienda que las notas de evento o las alertas tengan como extensión entre 400 y mil palabras. También es importante acompañar las notas de eventos o alertas con una o dos fotos.

Reporte de acuerdos o de posiciones

Es un resumen que guarda con una adecuada precisión el registro de los acuerdos alcanzados por un grupo de personas o de las posiciones de éstas.

• Titulo
• Entorno de los acuerdos
  • Objetivo principal de los acuerdos o posiciones
  • Nombre de los participantes
  • Lugar, fecha y hora cuando se adoptaron los acuerdos
• Exposición de los acuerdos o posiciones
• Descripción de las tareas de seguimiento
• Responsable: nombre del autor, cargo y datos de contacto
• Anexos:
  • Listado de participantes (incluyendo sus datos de contacto)
  • Documentos de referencia

Programación de eventos

Una programación de eventos es un plan en el que se definen los fines, las actividades y los recursos que serán necesarios para realizar un evento. Como se mencionó anteriormente un evento puede ser una reunión, la publicación de un documento u otro hecho de relevancia.

La estructura de la programación de eventos es la siguiente:

• Título del evento
• Datos generales:
  • Objetivo
  • Lugar, fecha y hora en qué se realizará
  • Encargados de la organización (incluyendo datos de contacto)
  • Proyecto o plan al que corresponde el evento
• Resumen del programa:
  • Título y descripción breve de cada actividad
  • Datos y papel de los expositores y moderadores
• Requerimientos de recursos (personal o fondos)
• Complementarios
• Listado de material de apoyo
  • Modelo de la invitación
  • Listado de invitados (incluyendo datos de contacto)

Plan de trabajo

• Título
• Contexto y antecedentes
• Resumen de los objetivos, principales actividades y costos.
• Justificación: breve exposición del problema y de las alternativas de solución
• Descripción de objetivos
  • Objetivo general y resultados esperados. Éste implica de cambios.
  • Objetivos específicos y resultados esperados. Los objetivos deben corresponder a las etapas del proceso o a los principales componentes del plan.
• Metodología: exposición del proceso de solución
• Descripción de los componentes y actividades, incluyendo el calendario de ejecución y la distribución de responsabilidades
• Recursos y administración, incluyendo el presupuesto
• Descripción de los mecanismos de monitoreo y evaluación

Informes de resultados

• Título
• Autor y fecha
• Resumen de los resultados reportados
• Cuerpo del informe:
  • Contexto y relevancia: circunstancia especiales en las que se da el informe y razones que los hacen relevante
  • Reporte de resultados: logros, estándar de evaluación (resultado esperado), exposición de las diferencias y descripción de los obstáculos enfrentados
  • Reseña de las evaluaciones de terceros: testimonios, resumen de sondeos, citas documentales u otros medios.
  • Lecciones aprendidas sobre las relaciones y nuestras capacidades
  • Descripción de las tareas de seguimiento

---

Historia del documento:

Versión 1.1 - Fueron revisadas las recomendaciones de estilo y los ejemplos - Para las primeras cuatro reglas de estilo se incluyó una explicación sobre su motivación. - Se agrego un listado de los documentos básicos - Se incluyó un nuevo tipo de documento básico: la descripción de iniciativas.

Versión 1.2 - Se modificó la estructura de las descripciones de iniciativas - Otros cambios menores

Versión 1.3 - Las recomendaciones de estilo fueron trasladadas a la Guia de lenguaje - Se eliminó la descripción de iniciativas porque su contenido fue reelaborado en la Guía de gestión

Versión 1.4 - Se eliminó el documento "Análisis", porque paso a ser parte de la Guía de autores de la Revista Probidad.