Eleonora Scoseria

Pgina 1 de 24

Ver. 01

Gua para el desarrollo de documentos

1.

Por qu preocuparnos por la documentacin? Porque documentar es una exigencia regulatoria pero adems Los documentos son necesarios en las empresas porque: evitan errores ahorran tiempo demuestran lo que se hizo Todos los programas / sistemas de gestin de calidad (por ej. Deming o ISO 9000) requieren la existencia de documentacin, incluyendo registros.

Un sistema de documentacin bien pensado: Es una inversin. Ahorra tiempo. Debe permitir que sea ms fcil cumplir con el mismo que no cumplir. Debe evitar la transferencia innecesaria de datos. Debe asegurar trazabilidad sencilla y total.

2.

Concepto de documento y tipos de documentos 2.1. Qu es un documento? Se le puede definir como una forma organizada de informacin que puede servir como evidencia legal o prueba. Puede encontrarse en esencialmente cualquier tipo de formato. 2.2. Tipos de documentos Los podemos dividir en funcionales (2.2.1) y registros e informes (2.2.2): 2.2.1. Funcionales Indican qu hacer o qu NO hacer Definen estndares Se suelen usar repetidamente Ej. Procedimiento de recepcin de mercadera, instructivo de uso de la balanza o del sistema informtico Los siguientes son documentos funcionales: Polticas / directrices Procedimientos / Procedimientos Operativos Estndar / Normas

Eleonora Scoseria

Pgina 2 de 24

Ver. 01

Gua para el desarrollo de documentos Operativas Bsicas Instructivos Guas Dibujos/diagramas Especificaciones 2.2.2. Registros e informes Contienen informacin sobre lo que se hace. Proporcionan datos histricos. Proporcionan evidencia del cumplimiento de las buenas prcticas. Ejs. Registros de temperatura y HR, registros de acondicionamiento, informes de auditora. Existen diferencias entre registros e informes. Registros: son usualmente datos sin procesar. Informes: tienen un propsito ms complejo, como informar a la direccin tcnica y/o gerencia y frecuentemente son elaborados a partir de la informacin contenida en registros. 2.3. Tipos de ejemplares "MASTER" o patrn o padre (es el que suele tener las firmas originales, y se suele acompaar de la evidencia de distribucin de los documentos como se indica ms adelante). Copia controlada: es aquel ejemplar cuya ubicacin es conocida y que cuando corresponda ser sustituido por una nueva versin. Es el nico tipo de ejemplar que debera emplearse para llevar a cabo las tareas y no debe ser retirado de los sectores de trabajo. Copia no controlada: es un documento puramente informativo, cuya ubicacin la empresa no tiene por qu conocer. Este documento NO debe utilizarse para llevar a cabo las tareas y NO ser sustituido por versiones nuevas. Estos ejemplares suelen emplearse con fines de capacitacin o para pedir presupuestos (especificaciones de materia prima, por ejemplo). Debe ser posible distinguir entre ellos (por ej. mediante papeles de diferentes colores o sellos).

Eleonora Scoseria

Pgina 3 de 24

Ver. 01

Gua para el desarrollo de documentos

3.

Objetivo primordial: No caer en la sobredocumentacin Se ha dicho que lo que no est escrito no existe. Ahora bien
Tengo que tener documentos para todo? Esto incluye cmo emplear una pipeta o encender un mechero Bunsen? No! Hay conocimientos que son parte de la formacin de la persona que hace una tarea. No necesito generar procedimientos o instructivos para lo obvio. No necesitamos un procedimiento que indique cmo usar Excel. Pero probablemente necesitemos un procedimiento que indique quin debe sacar qu reportes en Excel, con qu formato, con qu frecuencia y a quin(es) debe derivarlos. Solamente necesitamos los documentos necesarios para asegurar procesos homogneos, en los casos en que sea importante la homogeneidad.

Si no escribo algo, puedo hacer de cuenta que no ocurri?

Puede haber creatividad en la forma de encarar una visita de promocin. Pero solamente una manera correcta de hacer un ensayo o fabricar un producto.

Los procedimientos deben ser a prueba de tontos? Tiene sentido pensar en que un tonto trabaje en una empresa farmacutica? Un procedimiento lo suficientemente detallado puede eximir de capacitar sobre el mismo?

Tampoco! Si bien un inspector o auditor puede no creer que hicimos bien las cosas si no lo registramos, el no registrar algo no implica que no ocurri. Menos! Es una industria donde necesito personal con la capacidad y capacitacin suficientes. No! Si hacemos el procedimiento excesivamente detallado con el espritu de ahorrarnos esfuerzo de capacitacin, probablemente fracasemos doblemente ya que nadie leer el documento.

Eleonora Scoseria

Pgina 4 de 24

Ver. 01

Gua para el desarrollo de documentos 3.1. Qu documentos necesito desarrollar? Para decidir qu documentos se necesitan, algunos autores recomiendan plantearse las siguientes preguntas: es el proceso/tarea importante? puede potencialmente afectar la seguridad/calidad/eficacia del producto final? puede implicar un riesgo para el personal? hay ms de una persona afectada a la actividad? se realiza ms de una vez? cul es el tamao de la empresa? cun amplia es la gama de productos? cul es el nivel de formacin del personal que realizar la tarea? Si dudamos sobre si necesitamos o no un procedimiento pensemos: qu pasa si la tarea no se hace de una determinada manera? cul sera la consecuencia?

puede derivar en un producto o servicio inadecuado? puede derivar en un riesgo?

Finalmente el operador es el que decide si usa o no el documento y que lo haga sistemticamente depender de: Cun crtica perciba la tarea Su comprensin del impacto de los errores/fallos Valor del contenido del documento segn el usuario Facilidad o dificultad para obtener la informacin Calidad del contenido Cun atractivo sea el documento Facilidad para usar el mismo durante la tarea Experiencia pasada con el documento Es importante recordar que los usuarios: Pueden emplear el mismo documento varias veces en circunstancias diferentes Interpretan a medida que leen Se basan en su experiencia personal al interpretar documentos Deben entender cabalmente que los documentos son HERRAMIENTAS

Eleonora Scoseria

Pgina 5 de 24

Ver. 01

Gua para el desarrollo de documentos 4. La comunicacin El desafo de la comunicacin a travs de documentos escritos es lograr reproducir la idea del escritor en la mente del lector. Esto es realmente un desafo dado que en general: Tendemos a percibir lo que esperamos percibir. Se requiere informacin sin ambigedades y ms clara, para reconocer un fenmeno inesperado que uno esperado. Las primeras impresiones se resisten al cambio. Es difcil mirar la misma informacin desde diferentes perspectivas.

4.1. Qu cosas perjudican la comunicacin Frases demasiado largas. Palabras demasiado largas. Encabezados que no aportan significado. Voz pasiva Desaparicin de los actores. Indefiniciones por modificadores sin significado: Adecuado Apropiado Relevante Normal Layout de las pginas Demasiados temas en una misma pgina Demasiada informacin en un mismo prrafo. Lneas demasiado largas (las lneas de no ms de 39 caracteres son ms amigables para el lector). Organizacin Falta de paralelismo en las listas, con diferentes estructuras gramaticales y tiempos verbales. Como por ejemplo:

Orden inadecuado en las listas numeradas. Mezcla de polticas, procedimientos e instructivos / tareas.

Ante la recepcin de un pedido: Registrar en la planilla Emisin de la recepcin administrativa Si corresponde se consulta al superior.

Eleonora Scoseria

Pgina 6 de 24

Ver. 01

Gua para el desarrollo de documentos 4.2. Recomendaciones para una buena comunicacin Tener definido el estilo a emplear mediante plantillas de documentos adecuadas: Ver Anexos. Determinar el grado de detalle requerido segn el documento y a quien(es) est dirigido. Ejemplos de grado de detalle: Bajo: Lavar todos los contenedores de tapones. Medio: Lavar todos los contenedores de tapones, en el gabinete del lavador ACME, usando el programa de lavado #3. Alto:

Fino:

1) Cargar todos los contenedores de tapones en las bandejas del lavador, con el lado abierto hacia abajo. 2) Girar el selector del lavador a la posicin #3. Cargar todos los contenedores en las bandejas del lavador con el lado abierto hacia abajo segn esquema adjunto. Girar el selector ubicado en el panel de control del lavador a la posicin #3. Esperar que se encienda la luz verde de "listo. Presionar el botn de arranque para comenzar el lavado.

Tener en cuenta las siguientes recomendaciones: Emplear justificacin completa o izquierda en los textos. Usar negritas en los ttulos. Evitar ttulos excesivamente largos. De ser necesario emplear un ttulo y un subttulo. Evitar textos demasiado anchos o demasiado angostos. Usar un tamao de letra adecuado. Dependiendo de la fuente utilizada los tamaos de letra entre 10 y 12 puntos suelen ser adecuados. Ser consistente Ej. Decidir qu unidades usar; no usar unas veces cm3 y otras mL por ejemplo. Emplear palabras adecuadas a la audiencia. Evitar la terminologa excesivamente tcnica a menos que se aporten las definiciones. Mantener un estilo simple y con oraciones cortas. Evitar redundancias y palabras o expresiones innecesarias. Estimado (aproximadamente) en.... Absolutamente (esencial)....

Eleonora Scoseria

Pgina 7 de 24

Ver. 01

Gua para el desarrollo de documentos Tubo (hueco)... Salir (hacia afuera)... No es (totalmente) hermtico... (No hace falta decir que) el piso debe quedar totalmente limpio.... Un mnimo de X (o ms).... Incluye (pero no se limita a)..... Algunos (pero no todos)... El siguiente es un ejemplo de cmo se pueden emplear 8 palabras en lugar de 16. La frase inicial se fue condensando a partir de una primera versin hasta llegar a su mnima expresin.

La tarea de control de plagas se desarrollar en varias etapas, que se detallan a continuacin:

La tarea de control de plagas se desarrollar en las etapas que se detallan a continuacin: La tarea de control de plagas se desarrollar en las siguientes etapas: Etapas de la tarea de control de plagas:
Emplear voz activa en lugar de voz pasiva. Evitar expresiones como: se coloca en un recipiente se controla la apariencia dado que no permiten establecer quin hace la accin. Es fundamental que el documento detalle quin debe hacer cada tarea en forma inequvoca. En la escritura de procedimientos o instructivos evitar expresiones como: el operador debera se har documentaremos ...se registra en la medida de lo posible. Los procedimientos e instructivos tienen como finalidad asegurar que la persona que los siga lleve a cabo exactamente las mismas acciones que cualquier otra persona. Los procedimientos deben eliminar o por lo menos minimizar la variabilidad, por lo tanto, no deben dejarse decisiones libradas al criterio del usuario.

Eleonora Scoseria

Pgina 8 de 24

Ver. 01

Gua para el desarrollo de documentos Emplear afirmaciones en vez de negaciones. Emplear rangos siempre que sea posible

Ej. Mantener la temperatura entre 70 C y 75 C, es correcto, mientras que a aproximadamente 72 C, o a 72 C es inadecuado

(en un caso se indica aproximadamente sin indicar cun aproximado debe ser, y en el segundo caso se indica la temperatura exacta, lo cual probablemente sea imposible de lograr durante todo el tiempo).

Considerar las necesidades de capacitacin para implementar el procedimiento. Al escribir un procedimiento o instructivo, numerar las tareas en el orden en que se realizan. Empezar una lnea nueva para cada tarea. Dejar separacin adecuada entre prrafos. Colocar las advertencias antes de la accin sobre la que advierten. Tener en cuenta que el empleo de fotos, diagramas (por ejemplo diagramas de flujo y esquemas), acompaados por comentarios ahorra muchas palabras.

Por ejemplo, en un procedimiento de limpieza o de armado de equipos pueden incluirse imgenes escaneadas de manuales o fotos de los equipos. Los procesadores de texto como MS Word permiten adems agregar flechas o diversas autoformas a las fotos y de esa manera sealar o detallar determinados puntos.

5.

Algunos documentos tipo

Definen los com promisos de la em presa Indican quin, qu, cundo Indican cm o Permiten saber quin hizo qu, cundo y cm o

Polticas

P rocedim ientos

Instructivos

Registros

Eleonora Scoseria

Pgina 9 de 24

Ver. 01

Gua para el desarrollo de documentos 5.1. Poltica: Describe una decisin de la gerencia. Siendo la gerencia cualquier persona o grupo con autoridad para emitir rdenes que gobiernen la forma en que debe efectuarse el trabajo. Las polticas definen la posicin de la organizacin. Son una expresin formal de las intenciones de la empresa: por ejemplo, su poltica de calidad. Son importantes no solamente para transmitir un mensaje a los clientes externos de la empresa, sino tambin para indicar a los propios funcionarios de la misma lo que la empresa considera importante. Una poltica como la poltica de calidad, debera ser auditable, y debera poder comprobarse la coherencia entre lo que expresa y lo que la empresa realmente lleva a cabo.

Las polticas dejan por escrito decisiones valiosas, por lo que ahorran tiempo y evitan redecidir cosas ya anteriormente decididas. 5.2. Procedimiento: lista en orden los pasos que da un equipo de gente para llevar a cabo un ciclo de accin.

Es preferible que se cumpla sistemticamente una poltica modesta, que tener una poltica ms ambiciosa de la cual la empresa se aparte con frecuencia.

El ciclo de accin comienza con un desencadenante y termina en una meta. Un procedimiento bien escrito, define claramente quin tiene que realizar cada accin. Procedimientos Operativos Estndar o Procedimientos de Operacin Normalizados o Normas Operativas Bsicas o en ingls, Standard Operating Procedures (SOPs): Son descripciones escritas con el suficiente grado de detalle de los procedimientos a seguir para cada actividad. 5.3. Instructivo / Detalle de Tarea: lista en orden los pasos que da una persona para completar un paso de un procedimiento o una serie de acciones relacionadas. Son similares a los procedimientos, pero suelen ser ms especficos, y ms detallados. Algunos procedimientos hacen referencia a un instructivo, (ej. Un procedimiento general de limpieza puede hacer referencia al instructivo de preparacin de las soluciones de limpieza y desinfeccin). Puede tratarse de: Un paso de un procedimiento desglosado en forma detallada. Una serie de pasos no relacionados con ningn procedimiento. En un ambiente regulado por las GXP no tiene por qu realizarse la distincin entre procedimientos e instructivos, y cada empresa decidir si implementa solamente procedimientos o si implementa procedimientos e instructivos.

Eleonora Scoseria

Pgina 10 de 24

Ver. 01

Gua para el desarrollo de documentos 6. Planificacin de los documentos principales 6.1. Polticas 6.1.1. Planificacin Escribir un ttulo de 6 palabras o menos que describa la actividad y la distinga de otras actividades. Describir los lmites de la poltica.

Listar los puntos principales y sus excepciones. Indicar quin aprueba la poltica. 6.1.2. Escritura

A quin(es) se aplica o no. Dnde se aplica o no. Cundo se aplica o no.

La Gerencia ha decidido que....excepto cuando....

Formato estndar (encabezado, pie de pgina). Una poltica por pgina. Ttulo especfico para ESA poltica Resumir las decisiones en encabezados Usar un buen layout de pgina. No ms de 10 lneas por prrafo. No ms de 17 palabras por frase. Palabras largas: No ms de 10 % del total de palabras. 10 % de las palabras utilizadas deberan ser verbos en voz activa. Marcar las modificaciones (ej. Asterisco con explicacin al pie de la pgina). Incluir referencias (ver tambin...) 6.1.3. Verificacin Es permanente? Ahorra a la gerencia el esfuerzo de tomar decisiones similares en cada caso individual? Es una gua vlida en por lo menos el 90 % de situaciones similares? Su aplicacin va a redundar en el tratamiento justo / equitativo de todo(s) lo(s) involucrado(s)? Transmite fehacientemente la decisin de la gerencia? Faltan referencias? Indica las excepciones?

Eleonora Scoseria

Pgina 11 de 24

Ver. 01

Gua para el desarrollo de documentos 6.2. Procedimientos 6.2.1. Planificacin Escribir un ttulo que identifique el ciclo de accin. Definir el desencadenante y la meta del ciclo de accin. Numerar los pasos del ciclo de accin y enunciar cada uno en voz activa y presente. Asignar responsabilidades indicando los cargos. Indicar las condiciones especiales que se apliquen en cada paso. Planificador de procedimientos Ttulo indicando accin Desencadenante: Accin / suceso Meta: Accin / suceso Cargo Quin El Encargado de Depsito 5 cm Actividad Condiciones especiales (si se aplican) verbo descripcin de la accin si recibe una mercadera en malas condiciones notifica a Control de Calidad. 9 cm

1. 2. 1 cm Mrgenes 2.5 cm

6.2.2. Verificacin El ltimo paso de un actor pasa la accin al siguiente actor? Se pierde paralelismo?

La accin de un actor oculta la de otro? Una accin oculta ms de una accin? Algn paso indica lo obvio?

Hace Hacer Har

Pueden emplearse menos palabras? Hay palabras suficientes para transmitir la idea? Se mezclan polticas e instructivos con el procedimiento? Se definen el desencadenante y la meta del ciclo de accin?

Completa el formulario indicando A, B, C, D Completa el formulario

Eleonora Scoseria

Pgina 12 de 24

Ver. 01

Gua para el desarrollo de documentos 6.3. Instructivos 6.3.1. Planificacin Ttulo indicando accin Actor nico Desencadenante Meta Frase de contexto / gua Actividad Condiciones especiales (si se aplican) verbo descripcin de la accin si recibe una mercadera en malas condiciones notifica a Control de Calidad

1. 2. 1 cm

Mrgenes 2.5 cm 6.4. Listados Por ejemplo, listados de equipos, listados de personal, de procedimientos, de productos o proveedores. Resultan tiles cuando un procedimiento hace referencia por ejemplo a una lista que puede variar con mayor frecuencia que el procedimiento en s. Por ejemplo, listado de productos que se almacenan a determinada temperatura, o listados de proveedores aprobados.

Eleonora Scoseria

Pgina 13 de 24

Ver. 01

Gua para el desarrollo de documentos 7. El proceso de generacin de documentos 7.1. Planificacin Abarca dos niveles - Macro Formatos Estilos - Cada documento individual

Con el objetivo de lograr un adecuado contenido y nivel de claridad.

7.1.1. Planificacin macro Tipos de estilo - Narrativo - Esquemtico - En columnas - En columnas con diagramas 7.1.2. Planificacin de cada documento Preguntas de orientacin: - Quines son los usuarios? - Cmo emplearn la informacin? - Qu otras herramientas/recursos tendrn disponibles? - Cunta experiencia tienen? - Con qu frecuencia emplearn el documento? - Cmo se realizar la capacitacin en el empleo del documento? - Cmo se evaluar la capacitacin? Evitar superposiciones y repeticiones - Si incluyo un mismo proceso en ms de un procedimiento o instructivo ser incmodo y/o confuso e implicar modificar dos documentos si modifico el proceso. 7.2. Recoleccin de informacin Algunos autores combinan esta etapa con la escritura del documento Preguntas bsicas: - Qu? - Cmo? - Cundo? - Quin?

Eleonora Scoseria

Pgina 14 de 24

Ver. 01

Gua para el desarrollo de documentos - Dnde? Adicionalmente: - Input (materiales, informacin, documentos). - Output (productos, informacin, registros). - Herramientas usadas (fsicas o de informacin). - Cmo determinar si el procedimiento se ejecut debidamente / si la tarea fue exitosa. 7.3. Escritura Algunos autores recomiendan que haya dos personas involucradas en la escritura de un procedimiento. - Una para describir exactamente cmo se hace. - Otra para escribir la informacin y plantear preguntas. Recordar lo indicado en la seccin 4 sobre la comunicacin. Tener en cuenta la posibilidad de emplear diagramas de flujo como una representacin grafica, ordenada, de la sucesin de acontecimientos que ocurren en un proceso, lo cual brinda las siguientes ventajas: - Proporcionan una visin sistemtica del conjunto de actividades que integran el proceso. - Permiten proporcionar explicaciones ms claras sobre la secuencia de actividades del proceso. - Hacen ms fcil establecer lmites. - Aclaran la asignacin de funciones. El Anexo II brinda un esquema de cmo encarar el diseo de diagramas de flujo. 7.4. Revisin Esencialmente consiste en una verificacin formal y una revisin tcnica. Puede adems haber una verificacin operativa. 7.4.1. Verificacin formal Ortografa. Gramtica. Empleo de unidades de medida estndar. Empleo de abreviaturas estndar. Empleo de formatos aprobados. Organizacin lgica del material.

7.4.2. Revisin tcnica Realizada usualmente por expertos del rea en cuestin eventualmente con ayuda de operarios. Calificacin operacional del documento.

Eleonora Scoseria

Pgina 15 de 24

Ver. 01

Gua para el desarrollo de documentos 7.4.3. Verificacin operativa Si se trata de un documento funcional, como por ejemplo un procedimiento, es recomendable adems realizar la calificacin del mismos pidiendo a una persona que no realice habitualmente la actividad que la lleve a cabo siguiendo el documento. Por ejemplo, un operario de manufactura de otra seccin. Tener en cuenta: El "ruteo": En serie En paralelo El "ruteo" para la revisin puede realizarse en serie (uno a continuacin del otro) o en paralelo (entregando copias a cada revisor simultneamente y luego integrando los aportes de cada uno). El control de acceso a los documentos en etapa de revisin. Es importante que durante la etapa de revisin est muy claro que los documentos no se encuentran vigentes.

7.5. Aprobacin Implica: - Autorizar el empleo del documento a partir de una fecha dada - Desencadenar las medidas necesarias para la distribucin y empleo del documento (por ej. Capacitacin) Para algunas empresas, la revisin y la aprobacin son una nica etapa. Aseguramiento de la Calidad/Control de Calidad tienen que participar en la aprobacin y tener autoridad final en todos los documentos que influyan sobre la calidad, seguridad y eficacia del producto. Como parte de la aprobacin, se suele emitir y firmar el documento patrn.

7.6. Distribucin Es el proceso por el cual se asegura que quienes van a emplear el documento cuenten con una copia en el lugar de trabajo, sin que existan confusiones sobre cul es el documento que deba ser utilizado. Debe ser posible reconstruir qu documento se emple en un momento dado. 7.7. Uso El uso de los documentos, es una de las etapas del proceso ms difcil de garantizar. Depender, como se indic anteriormente, de la percepcin del usuario sobre la utilidad del documento y de la accesibilidad del mismo.

Eleonora Scoseria

Pgina 16 de 24

Ver. 01

Gua para el desarrollo de documentos 7.8. Revisin / Retencin / Destruccin 7.8.1. Revisin Peridica Con una periodicidad pre-establecida (usualmente a nivel del documento madre o de un listado de referencia), se suelen revisar los documentos para asegurar que mantengan su pertinencia. En general, plazos de revisin peridica mayores a dos aos se consideran excesivos. Algunas empresas farmacuticas adoptan como criterio la revisin anual, alineada con la revisin anual de productos. Si en la instancia de revisin se llega a la conclusin de que el documento sigue vigente, se debe dejar constancia escrita de esta conclusin (por ejemplo en un formulario adjunto al ejemplar patrn). Adicional Adems de esta revisin peridica (usualmente anual), los documentos sern revisados cuando ocurra un evento que desencadene la necesidad de revisin (por ejemplo hallazgos a nivel de autoinspecciones, cambios de equipos o forma de trabajo, retroalimentacin del personal, etc.).

7.8.2. Retencin Cuando se concluya que el documento debe ser retirado (o porque deja de tener sentido tener dicho documento o porque hay que sustituirlo por una nueva versin), la empresa deber ir a buscar cada una de las copias controladas y registrar su retiro y destruccin. Las copias no controladas no se buscan ni tienen por qu rescatarse ni destruirse. Se conserva el ejemplar patrn marcado como obsoleto a los efectos de tener todos los antecedentes del documento, y poder saber exactamente qu deca el documento usado en un momento dado. 7.8.3. Destruccin Pasados 1-2 aos de la fecha de expiracin de cualquiera de los productos elaborados por aplicacin de esa versin del documento, esos ejemplares patrn obsoletos podran destruirse. Una alternativa es el empleo de microfilm o versiones escaneadas para conservar la informacin ocupando poco espacio fsico.

Eleonora Scoseria

Pgina 17 de 24

Ver. 01

Gua para el desarrollo de documentos 8. Referencias esenciales Vesper, J. "Documentation Systems: Clear and Simple", Interpharm Press, IL, USA, 1998. De Sain, C. "Documentation Basics", Aster Publishing Corp. Eugene, Oregon, USA, 1992. De Sain, C. "Documentation Practices", Advanstar, Cleveland, OH, USA, 1996. Cutter, M. How to Write Policies and Procedures, Interpharm Press, 1995. Cutter, M. How to Review and Redesign SOP Systems, Interpharm Press, 1995. Hemphill, B. www.productiveenvironment.com Peabody, L. HOW TO WRITE POLICIES, PROCEDURES & TASK OUTLINES: Sending Clear Signals in Written Directions, Second Edition, 1996.

Eleonora Scoseria

Pgina 18 de 24

Ver. 01

Gua para el desarrollo de documentos ANEXO I: Algunas secciones habituales en los documentos y su fundamento
El objetivo no debera ser una repeticin del ttulo. Si lo fuera, no necesitaramos un objetivo. Algunos autores recomiendan pensar no solamente en cul es el propsito del procedimiento, sino tambin qu pasara si el procedimiento no existiera. Tomemos como ejemplo el instructivo de limpieza del recipiente de acero inoxidable nmero 1234. Este objetivo se puede desglosar en: Asegurar el empleo de los materiales de limpieza adecuados. Evitar la contaminacin cruzada. Asegurar el enjuague y secado adecuado del recipiente. Asegurar la correcta rotulacin del recipiente. La escritura de un buen objetivo, sirve para motivar al operario, explicndole por qu es importante llevar a cabo el procedimiento de la manera correcta. Redaccin tpica de un objetivo: establecer la manera correcta deevitando

El objetivo

que ocurra contaminacin.asegurando que.

El alcance o campo de aplicacin Responsables

A qu se extiende o aplica el procedimiento.

Quines van a ser responsables de la ejecucin de las diferentes etapas del procedimiento y quines van a ser responsables de la supervisin. Esta seccin no necesariamente va a encontrarse en todos los documentos, pero puede ser til si es necesario definir determinados trminos que puedan no ser de conocimiento de todos los operadores, o trminos que puedan dar lugar a confusiones o malas interpretaciones. Nuevamente, es una seccin que no siempre se va a necesitar. Es particularmente til en procedimientos de limpieza y anlisis, por ejemplo, y la descripcin de los equipos o materiales debe ser lo ms exacta posible. Ejemplo: Reactor N 2A. Espectrofotmetro marca ACME modelo superdetect 18G. Solucin de hipoclorito de sodio al X % preparada segn instructivo INSLIP-012. Una seccin de advertencias resume las precauciones para la ejecucin del procedimiento o instructivo. De todas formas es recomendable reiterar las advertencias antes de cada paso sobre el que se advierte. Esta seccin es el procedimiento o instructivo en s. No todas las empresas emplean esta seccin. En nuestra experiencia es til hacer referencia a todos los registros a los que se haga referencia en el procedimiento. Esto se puede hacer empleando los cdigos y nombres de los mismos. Ejemplo: PL-DEP-001-A Registro de recepcin de mercadera.

Definiciones

Equipos y materiales

Advertencias

Operaciones

Registros

Eleonora Scoseria

Pgina 19 de 24

Ver. 01

Gua para el desarrollo de documentos

Algunas empresas listan indicadores del cumplimiento del procedimiento, como por ejemplo autoinspecciones, resultados de determinados ensayos, etc. Esto resulta til para que el personal que lleva a cabo el procedimiento tenga claro: Que existe un monitoreo del cumplimiento del mismo. Cmo saber si el procedimiento se llev a cabo de la manera correspondiente (si fuera posible). tiles para determinar fcilmente qu fuentes se usaron como base para redactar el documento. Esta seccin permite describir la evolucin histrica que ha sufrido el documento. Los cambios introducidos se describen en forma resumida. Por ejemplo:

Indicadores

Referencias

Histrico de revisiones

Se modific el procedimiento de limpieza del reactor para tener en cuenta la incorporacin del dispositivo CIP. Se detallaron los pasos intermedios en el armado del equipo. Se corrigi un error de tipeo en el punto 5.7. Se agreg la determinacin de ph luego del tercer enjuague (punto 7.6.1).

Algunas empresas incluyen la lista de distribucin del documento como parte de cada copia. En estas empresas los documentos tienen una seccin que detalla, por ejemplo:

Lista de distribucin

Supervisin de Acondicionamiento. Jefatura de Produccin. Seccin Depsito. Seccin Acondicionamiento.

Esto implica que existen copias a disposicin de esas secciones o cargos. Si bien es importante saber qu secciones o personas tienen qu documentos (y nos extenderemos sobre este tema en la parte correspondiente a control de la documentacin), no consideramos deseable que dicha lista se encuentre como parte de cada documento distribuido. Una alternativa que consideramos preferible es colocar una seccin Destinatarios, que a veces se incluye como parte del encabezado del documento, para que en la misma se indiquen las secciones a las que est dirigido el documento.

Eleonora Scoseria

Pgina 20 de 24

Ver. 01

Gua para el desarrollo de documentos ANEXO II: Lineamientos generales para disear diagramas de flujo. Si bien las reglas sobre cmo construir diagramas de flujo tienen variantes segn la aplicacin especfica, podemos establecer algunos lineamientos generales: Dar un ttulo al diagrama Comenzar con el evento que desencadena el proceso (ingreso de mercadera, llamada de un cliente, etc.) Anotar cada accin en el proceso en forma concisa y clara Realizar primero un diagrama global, y despus si es necesario representar etapas del mismo mediante diagramas ms detallados. Incluir referencias a otra informacin relevante (tal como procedimientos, o registros). Concluir el proceso en un punto que resulte relevante (por ejemplo, envo de mercadera, emisin de una factura, etc.).

Representa un evento que desencadena un proceso. Usualmente se le emplea tambin para representar la conclusin del proceso. Representa etapas controlables dentro del proceso. Representa un punto de decisin en el proceso, tpicamente en funcin de la respuesta existirn diferentes caminos a seguir en el proceso. Representa un punto de conexin con otro proceso.Dentro del crculo se debera hacer referencia al otro proceso y/o al diagrama que lo representa. Representa el uso de documentos en el proceso, generalmente registros. Y, representa que ambos caminos deben cumplirse

Eleonora Scoseria

Pgina 21 de 24

Ver. 01

Gua para el desarrollo de documentos Ejemplo que ha sido corregido para eliminar la falta de paralelismo indicada anteriormente:

Eleonora Scoseria

Pgina 22 de 24

Ver. 01

Gua para el desarrollo de documentos ANEXO III: Desarrollo de registros tiles y amigables Asegurarse de que el registro sea til y/o exigido. Codificar los registros o planillas. Cdigo de documento que en lo posible lo relacione con el procedimiento asociado. Versin del registro (que puede ser diferente de la del procedimiento asociado).

Evitar planillas con demasiada densidad de informacin. Asegurarse de que exista espacio suficiente para ingresar datos. Armar el registro en un orden lgico. Siempre que sea posible, poner espacios para marcar vs espacios para completar. Dejar claro lo que se espera que se ingrese. Prever espacios para adjuntar registros relacionados (ej. Rtulos, cromatogramas, etc.). Prever espacio para observaciones. Asegurarse de proporcionar espacios para firmar TODA VEZ que corresponda. Organizar la informacin en forma de grilla. Evitar justificar centrado.

Centrado Esta es una muestra que ilustra la apariencia del texto centrado. Esta es una muestra que ilustra la apariencia del texto centrado. Esta es una muestra que ilustra la apariencia del texto centrado.

Justificacin izquierda Esta es una muestra que ilustra la apariencia del texto centrado. Esta es una muestra que ilustra la apariencia del texto centrado. Esta es una muestra que ilustra la apariencia del texto centrado.

Mantener un balance de fuentes: Evitar la multiplicidad de fuentes en tipo y tamao. En general un mximo de 3 tamaos de letra es suficiente.

Eleonora Scoseria

Pgina 23 de 24

Ver. 01

Gua para el desarrollo de documentos Evitar redundancias Estas dos tablas presentan la misma informacin, solo que la segunda lo hace en forma mucho ms compacta y sin redundancias. HR T Mn Mn 63 15 Mx Mx 85 28

HR T

Mn 63 15

Mx 85 28

Asegurarse de que cada punto a realizar y/o completar est en una lnea separada. Buscar e incorporar la retroalimentacin del usuario.

Eleonora Scoseria

Pgina 24 de 24

Ver. 01