coaching para escribir documentos - … · propuestas de edward de bono “seis sombreros para...

COACHING PARA

ESCRIBIR DOCUMENTOS

de la ingeniería de software

Presentan

MSI. Edna Martha Miranda Chávez.

MCC. Sergio Fuenlabrada Velázquez.

Ing. Mario Alberto Sesma Martínez

Noviembre 2006

Edna Martha Miranda Chávez, Sergio Fuenlabrada Velázquez, Mario Alberto Sesma Martínez

COACHING PARA ESCRIBIR DOCUMENTOS 2

Contenido

Introducción.__________________________________________________________ 1�

Capítulo I. Qué es el Coaching para escribir documentos _______________________ 2�

1.1. Cómo hacer un auto-coaching. ______________________________________ 3�

1.2. Metodología del coaching.__________________________________________ 4�

Capítulo II. Herramientas de apoyo a la percepción. ___________________________ 6�

2.1. Hábitos de pensamiento ___________________________________________ 6�

2.1.1. Pensamiento de sombrero blanco_________________________________ 8�

2.1.2. Pensamiento de sombrero rojo ___________________________________ 8�

2.1.3. Pensamiento de sombrero negro _________________________________ 9�

2.1.4. Pensamiento de sombrero amarillo________________________________ 9�

2.1.5. Pensamiento de sombrero verde ________________________________ 10�

2.1.6. Pensamiento de sombrero azul__________________________________ 11�

2.2. Mapas mentales ________________________________________________ 11�

Capítulo III. Herramientas para el manejo de Información ______________________ 14�

3.1. Reglas para escribir documentos. ___________________________________ 14�

3.2. Escriba sólo lo importante._________________________________________ 14�

Capítulo IV. Documentos de la Ingeniería de Software ________________________ 19�

Capítulo V. Coaching para escribir documentos _____________________________ 22�

5.1. Meta-preguntas _________________________________________________ 23�

5.1.1 Meta-preguntas para romper los modelos mentales __________________ 24�

5.1.2. Meta-preguntas para crear documentos que envía___________________ 24�

5.1.3. Meta-preguntas de formato y estructura del documento. ______________ 26�

5.1.4. Meta-preguntas para documentos técnicos ________________________ 27�

5.1.4.1.- Meta-preguntas para documentar los requerimientos _____________ 27�

5.1.4.2.- Meta-preguntas para determinar el ciclo de vida. ________________ 29�

5.1.4.3.- Meta-preguntas para documentar el diseño. ____________________ 30�

5.1.4.4.- Meta-preguntas para documentar el desarrollo. _________________ 31�

5.1.4.5.- Meta-preguntas para documentar las pruebas.__________________ 33�

Bibliografía. _________________________________________________________ 35�

Anexos _____________________________________________________________ 37�

Lineamientos para la presentación de documentos ___________________________ 38�



I. Prefacio _________________________________________________________ 38�

II. Estándares para la identificación del documento._________________________ 38�

III. Estándares para la presentación de documentos ________________________ 38�

IV. Estándares de la estructura del documento. ____________________________ 40�

Cubierta y portada_________________________________________________ 41�

Resumen________________________________________________________ 41�

Contenido o índice ________________________________________________ 41�

Lista de figuras ___________________________________________________ 41�

Notación empleada ________________________________________________ 41�

Introducción. _____________________________________________________ 41�

Desarrollo, cuerpo principal del texto __________________________________ 41�

Referencias, bibliografía y citas bibliográficas____________________________ 42�

Referencias ____________________________________________________ 42�

Cita bibliográfica __________________________________________________ 42�

Bibliografía ______________________________________________________ 43�

Glosario_________________________________________________________ 44�

Apéndices _______________________________________________________ 44�

Tablas e ilustraciones ______________________________________________ 45�

V. Estándares para la actualización del documento. ________________________ 45�



Figuras

Figura 1 Mapa mental _________________________________________________ 12�

Figura 2 Tipos de documentos producidos para apoyar a los usuarios. ___________ 20�

Figura 3 Proceso de producción de un documento.___________________________ 23�



Tabla

Tabla 1 Función de los sombreros _________________________________________ 7�

Introducción.

Coaching es una relación que se establece entre un entrenador -Coach- y el entrenado –Coachee- a fin de que el entrenado mejore sustancialmente su rendimiento en determinada área. Este documento se sustenta en la idea principal de que si se cuenta con un buen entrenador toda persona podrá mejorar sustancialmente su rendimiento.

Actualmente esta actividad de Coaching se da en diferentes ámbitos: empresarial, personal, ejecutivo, deportivo, y literario entre otras.

Este documento esta dirigido específicamente a quienes tienen necesidad de escribir documentos técnicos en el área de ingeniería de software, ya sea en el entorno escolar o profesional, mostrándose la metodología de coaching para lograr escribir más rápidamente mejores documentos técnicos.

El definir que se quiere expresar, con que profundidad, cuales elementos constituyen el documento, por donde empezar, son algunas de las interrogantes que se presentan al iniciar la escritura de un documento.

Este trabajo se inicia mostrando las herramientas de apoyo a la percepción –“seis sombreros para pensar” - y la de -“mapas mentales” - que facilitan el definir claramente el objetivo del documento a escribir, a quien va dirigido y el entorno técnico en el que se deberá ubicar, sin omitir las herramientas para el manejo de la información -“reglas para escribir documentos” - y consejos de – “escriba sólo lo importante”- que permiten acceder rápidamente a la acción de escribir.

En seguida se establece la metodología del coaching la cual se apoya principalmente en la formulación de Meta-preguntas que al ser contestadas orientan al escritor acerca de que escribir.

Teniéndose como marco de aplicación la necesidad de escribir documentos técnicos en el área de software.



Capítulo I. Qué es el Coaching para escribir documentos

El coaching es un proceso en el que intervienen un entrenador –coach- y un entrenado –coachee-, que radica básicamente en una relación donde una persona entrena a otra para que el entrenado mejore su rendimiento en una determinada área [BULAT, 2006]

El sustento del coaching es que si se cuenta con un buen entrenador toda persona podrá mejorar exponencialmente su rendimiento, y explotar sus potencialidades para lograr sus objetivos que se proponga.

Existen diferentes clases de coaching, básicamente se trata de las mismas habilidades aplicadas a diferentes áreas. Un coach puede especializarse, pero es frecuente que esas áreas tengan uno o varios aspectos de intersección. Cómo el propósito del presente documento es apoyar a los escritores a realizar documentos, únicamente se enuncian los distintos coaching según los establecen Bulat [BULAT, 2006] y O´Connor [O’CONNOR, 2005] los cuales son:

� Coaching personal.

� Coaching ejecutivo.

� Coaching empresarial.

� El directivo como coach.

� Coaching para la profesión.

� Coaching deportivo o de equipos.

� Coaching literario.

� Auto coaching.

El coaching para escribir documentos es una adaptación de la metodología de coaching [BULAT, 2006] aplicada a la actividad de escribir, el propósito del presente trabajo es:

Ayudar a los escritores a desarrollar todo su potencial y a definir con precisión sus documentos, para que sus ideas queden adecuadamente reflejadas en sus escritos.

Hay que hacer una aclaración, el coaching para escribir documentos no es un proceso de edición, aunque pueda incluir algunas de sus actividades, ya que casi siempre se harán trabajos de formateo y corrección. Los editores trabajan a partir de un documento y lo editan de la mejor manera posible para adaptarlo a lo que desean, y posteriormente publicarlo. Por el contrario el coach literario trabaja con el escritor para definir claramente lo que quiere



expresar y la forma de hacerlo [BULAT, 2006]. Que no sean lo mismo tampoco implica que sean opuestos, sino todo lo contrario, son complementarios.

El coaching inicia, en la medida de lo posible, antes de escribir y su finalidad apunta a potenciar la capacidad expresiva y de transmisión de ideas del autor.

En cuanto a los actores que intervienen en ambos proceso, los fines son totalmente distintos:

� Coach literario es una persona que se le contrata y le pagan para cuestionar y asesorar, no tiene prejuicios al respecto, ni ataduras a la hora de dar sugerencias y consejos. Sus cuestionamientos son con el fin de asegurarse que lo que el escritor está diciendo es lo que realmente quiere expresar.

� El editor no tiene tiempo de cuestionar el documento. Si el documento esta aceptablemente bien hecho y si lo puede arreglar lo edita. Su misión consiste en corregir y adaptar el documento para que tenga un formato estándar de acuerdo a lo establecido.

1.1. Cómo hacer un auto-coaching.

El coaching para escribir documentos pretende ser práctico y no teórico, lo que implica una contradicción terminológica; si el coaching requiere como mínimo un coach y un coachee, e implica una actividad dinámica de intercambio entre ambos, entonces ¿se puede hacer auto-coaching?

La respuesta técnica es NO, pero hay que recordar el propósito que persigue este trabajo, es que el lector-escritor pueda plantearse muchas de las preguntas que le haría un coach literario y utilizar las herramientas que el coaching conlleva para encontrar muchas de las respuestas. Por supuesto ser “juez y parte” y automotivarse no es fácil, pero si el lector aplica los objetivos y metodología de coaching que se proponen, podrá escribir un documento técnico.

El objetivo de coaching literario es ayudar a quien tiene deseos de expresarse y escribir un documento, a que lo realice de manera que satisfaga sus expectativas y responda lo mejor posible a su idea y propósito original.

Se ha observado que a la mayoría de las personas técnicas que desean escribir documentaciones, se les presentan las siguientes situaciones:

� La ley de la opacidad.- La brillante idea que se tiene en la cabeza, cuando se quiere escribir pierde su brillantez.

� La ley del obvio.- Consiste en omitir aquellas cosas que para el escritor son obvias, pero para el lector no lo son.

� La ley de la tortura.- Cuando para el escritor la idea escrita esta clarísima, pero el lector interpreta otra cosa. Dostoievski llamaba a esto “la tortura de que la palabra no siga al pensamiento”.



Lo que se busca con el coaching literario es que a través de una metodología determinada, disminuir la aparición de estas leyes, y así el escritor obtenga mejores resultados. Esta metodología se puede aplicar a todo el documento o en aquellas partes que el escritor crea convenientes.

1.2. Metodología del coaching.

Debido a que el coaching depende del contexto, problemática y personalidad del coach y del coachee, no se trata de una disciplina rígida que tenga reglas a seguir, pero si tiene algunos puntos comunes o principios que buscan ayudar a que el coachee mejore en los aspectos:

� La percepción: Esta se da en dos aspectos:

o Que el escritor conozca sus fortalezas y debilidades y cómo puede hacer uso de ellas para escribir.

o Y las herramientas1 que le permiten percibir la realidad, que incluye la evaluación de cuales son los verdaderos intereses del autor y de sus lectores (usuarios2).

� El compromiso: Una vez que el entrenado es conciente de su objetivo, deseos y necesidades, el coach lo apoya a encontrar sus propias soluciones a comprometerse a hacer lo necesario para conseguirlas y a establecer las metas que le ayudaran a concretar la escritura del documento.

� La acción: Se lleva a la práctica el compromiso adquirido y se comienza a escribir y corregir.

En la sección de Herramientas de apoyo a la percepción se presentan las propuestas de Edward de Bono “Seis sombreros para pensar” y la de Tony Buzan “Mapas mentales”, para conseguir una mejor percepción de la realidad. En la sección de Documentos de la ingeniería de software, se presentan los distintos documentos que se requieren en la ingeniería de software, que ayudan a la definición del los objetivos. En la sección Herramientas para el manejo de información se presentan las propuestas de Maureen Malanchuk las “reglas para escribir documentos” y la de Marie-Josée Couchaère “escriba sólo lo importante”, que ayudan a la acción.

Lo más importante que el coach le debe a su entrenado:

� Tener una mente abierta para recibir las distintas perspectivas posibles y alejarse de los modelos mentales [SENGER, 1995].

� Las preguntas son las respuestas [O´CONNOR, 2005], usando preguntas directas e indirectas, así como la empatía y la paráfrasis,

1 En este documento sólo se utilizan las herramientas de pensamiento propuestas por Edward D Bono y Tony Buzan. 2 Son aquellas personas que usaran el documento técnico que elabore el escritor.



con la finalidad que la persona entrenada descubra su verdadera solución.

� Cuestionar y discutir hasta la indiscutible para forzar al entrenado a afirmar sus propias ideas [BULAT, 2006].

� Apoyar al entrenado a que diferencie entre sus intereses y las percepciones de los demás.

� Descubran lo que realmente es importante para ellos, es decir su dominio personal [SENGER, 1995].

� Elaborar los compromisos de acción.

El entrenado para ser lector-escritor, requiere ciertas características como la organización, empeño, objetividad y distanciamiento de su documento para que pueda por sí mismo utilizar algunas de las herramientas que se proponen en esta propuesta de “Coaching para escribir documentos”.

Para lograr el distanciamiento de su documento, el lector-escritor debe recordar que los modelos mentales son las imágenes, supuestos e historias que llevamos en la mente acerca de nosotros, los demás, las instituciones y todos los aspectos del mundo. Como unos lentes sin la graduación correcta, que distorsionan sutilmente la visión, los modelos mentales determinan lo que se ve y hace. El problema radica en que los modelos mentales suelen ser tácitos y existen por debajo del nivel de conciencia, en la sección de Coaching para escribir documentos en las Meta-preguntas para romper los modelos mentales, se establece una posible reflexión para romper los modelos mentales.

En algunas ocasiones el lector-escritor podrá ser auxiliado por personas de su confianza para que evalúen las cosas que escriban. Estas personas deberán ser conminadas a realizar críticas concretas y detalladas que ayuden a mejorar el texto. Como en este caso la propuesta es para escribir documentos técnicos, estas personas pueden ser parte del equipo de trabajo o algún usuario, que responda un cuestionario después de leer el documento.



Capítulo II. Herramientas de apoyo a la percepción.

La manera en que se realiza el pensamiento debido a nuestra herencia Aristotélica, generalmente es argumentativo y con una dialéctica defectuosa [BONO, 1991, pp 23-24], ya que excluye lo creativo y lo generativo. Es necesario reconocer que este ha generado grandes avances en el mundo occidental, pero el construir a través de argumentos, que deben ser sustentados, genera un alto desgaste discursivo, que en algunas ocasiones puede llevarnos a encontrar una verdad a medias.

El uso de mapas mentales ayuda a clarificar el pensamiento, al convertirlo de lineal a cartográfico.

El análisis implica tener una VISIÓN completa del sistema global al que pertenece el elemento (subsistema) que se pretende comprender e identificar la configuración de las interrelaciones entre los componentes claves del subsistema.

Debido a la poca claridad que los sistemas suaves3 presentan al identificar las interrelaciones entre sus elementos, se deben buscar otras formas de realizar el pensamiento, por lo que en las siguientes secciones se describe la técnica de los seis sombreros para pensar, como una herramienta para de realizar el pensamiento lateral, que se auxilia de los mapas mentales para hacer cartográfico el pensamiento.

2.1. Hábitos de pensamiento

El propósito de los seis sombreros para pensar [BONO, 1991], es desarrollar el pensamiento, de modo que el pensador pueda utilizar un modo de pensar después de otro, en lugar de hacer todo al mismo tiempo o intentarlo. La mejor analogía es la impresión a todo color. Se imprime cada color por separado y al final se reúnen todos y se ve el conjunto.

El método de los seis sombreros para pensar está diseñado para sacar al pensamiento del estilo argumentativo habitual y llevarlo a un estilo cartográfico. Esto hace al pensamiento un proceso de dos etapas. La primera es elaborar el mapa. La segunda es elegir la ruta en el mapa. Si el mapa es suficientemente bueno, la ruta mejor suele ser obvia. Tal como en la analogía de la impresión a color, cada uno de los seis sombreros pone un tipo de pensamiento en el mapa.

No pretende afirmar que los seis sombreros abarcan todo espectro posible del pensamiento, sino que abarcan los modos principales. Tampoco se sugiere que se ponga uno de los sombreros cada vez que se piense.

3 La metodología de sistemas suaves [CHECKLAND, 1994, pp.17-73] auxilia a los administradores, de todos los tipos y en todos los niveles, para que resuelvan con éxito su tarea.



El mayor valor de los sombreros es su misma artificialidad. Brindan una formalidad y una convención para requerir cierto tipo de pensamiento tanto de nosotros mismo como los demás. Fijan las reglas del juego del pensamiento. Cualquiera que lo juegue debe conocer estas reglas.

Cuanto más se utilicen los sombreros, más se integrarán a la cultura del pensamiento. Todos los miembros de una organización deberían aprender el lenguaje básico de modo que se pueda incorporar a la cultura organizacional.

Enfocar el pensamiento resulta mucho más potente. En lugar de perder tiempo en discusiones y razonamientos sin rumbo, se contará con un planteamiento enérgico y disciplinado.

Al principio, es posible que la gente se sienta un poco incómoda con el uso de los sombreros, pero esta incomodidad desaparece apenas la conveniencia del sistema resulta evidente. La primera utilización de los sombreros será un pedido ocasional de usar uno en particular o de cambiar el negro por otro.

El gran valor de los sombreros es que proporcionan roles de pensamiento. Un pensador puede enorgullecerse de representar cada uno de los roles. Sin la formalidad de los sombreros algunos pensadores se estancarían en un modo único (generalmente el negro).

La tabla 1 [BONO, 1991, pp 42-44] muestra en forma resumida la función de cada sombrero:

Sombrero Función

Blanco Blanco, hechos puros, números e información.

Rojo Ver rojo, emociones y sentimientos, también presentimientos e intuición.

Negro Abogado del diablo, enjuiciamiento negativo, razones por las que no resultará.

Amarillo Luz del sol, brillo y optimismo, positivo, constructivo, oportunidad.

Verde Fertilidad, creatividad. Plantas brotando de las semillas, movimiento, provocación.

Azul Moderación y control, director de orquesta, pensar en el pensamiento.

Tabla 1 Función de los sombreros

Mientras más personas aprendan el lenguaje que se siguiere con el color de los sombreros, más útil resultará en cualquier organización. La verdad es que no contamos con un lenguaje sencillo como sistema de control del pensamiento.



Si nos sentimos tan inteligentes que creemos poder prescindir de éste sistema, podríamos tener en cuenta que haría dicho sistema con esa inteligencia, de la que tanto nos jactamos, fuera aún más eficaz. Una persona con talento natural para correr se beneficia más que otros si a ese talento aplica disciplina.

2.1.1. Pensamiento de sombrero blanco

Imagine una computadora que da los hechos y las cifras que se le piden. Es neutral y objetiva. No hace interpretaciones ni da opiniones. Cuando usa el sombrero blanco, el pensador debería imitar la computadora.

La persona que pide información debe enmarcar y precisar las preguntas a fin de obtener información o para completar vacíos de la información existente.

En la práctica existe un sistema doble de información. El primer nivel contiene hechos verificados y probados, hechos de primera clase. El segundo, hechos que se cree que son verdaderos, pero que todavía no han sido totalmente verificados, hechos de segunda clase.

La credibilidad varía desde "siempre verdadero" hasta "nunca verdadero". En el medio hay niveles utilizables, tales como "en general", "a veces", y "en forma ocasional". Se puede presentar esta clase de información con el sombrero blanco siempre que se use el "marco" apropiado para indicar su grado de probabilidad.

El pensamiento de sombrero blanco es una disciplina y una dirección. El pensador se esfuerza por ser más neutral y más objetivo al presentar la información. Te pueden pedir que te pongas el sombrero blanco o puedes pedirle a otro que lo haga. Se puede optar por usarlo o por quitárselo.

El blanco (ausencia de color) indica neutralidad.

2.1.2. Pensamiento de sombrero rojo

El uso del sombrero rojo permite que el pensador diga: "Así me siento con respecto a este asunto".

El sombrero rojo da legalidad a las emociones y los sentimientos como una parte importante del pensamiento.

El sombrero rojo hace visibles los sentimientos para que puedan convertirse en parte del mapa y también del sistema de valores que elige la ruta en el mapa.

El sombrero provee al pensador de un método conveniente para entrar y salir del modo emocional; así puede hacerlo de una manera que no resulta posible sin este truco o instrumento.

El sombrero rojo permite que el pensador explore los sentimientos de los demás cuando les solicita un punto de vista de sombrero rojo.



Cuando un pensador está usando el sombrero rojo, nunca debería hacer el intento de justificar los sentimientos o de basarlos en la lógica.

El sombrero rojo cubre dos amplios tipos de sentimiento. En primer lugar, las emociones comunes, que varían desde las fuertes, tales como miedo y disgusto, hasta las más sutiles como la sospecha. En segundo lugar, los juicios complejos, clasificables en tipos tales como presentimientos, intuiciones, sensaciones, preferencias, sentimientos estéticos y otros tipos no justificables de modo perceptible. Cuando una opinión consta en gran medida de este tipo de sentimientos, también se la puede encajar bajo el sombrero rojo.

2.1.3. Pensamiento de sombrero negro

El pensar de sombrero negro se ocupa específicamente del juicio negativo. El pensador de sombrero negro señala lo que está mal, lo incorrecto y erróneo. El pensador de sombrero negro señala por qué algo no va a funcionar. El pensador de sombrero negro señala los riesgos y peligros. El pensador de sombrero negro señala las imperfecciones de un diseño.

El pensamiento de sombrero negro no es argumentación y nunca se lo debería considerar tal. Es un intento objetivo de poner en el mapa los elementos negativos.

El pensamiento de sombrero negro puede señalar los errores en el proceso del pensamiento y en el método mismo.

El pensamiento de sombrero negro puede confrontar una idea con el pasado para verificar si encaja con lo ya sabido.

El pensamiento de sombrero negro puede proyectar una idea en el futuro para verificar qué podría fracasar o ir mal.

El pensamiento de sombrero negro puede hacer preguntas negativas.

El pensamiento de sombrero negro no debería utilizarse para encubrir complacencia negativa o sentimientos negativos, los que deberían utilizar el sombrero rojo.

El juicio positivo queda para el sombrero amarillo. De presentarse ideas nuevas, el sombrero amarillo siempre se debe usar antes que el negro.

2.1.4. Pensamiento de sombrero amarillo

El pensamiento de sombrero amarillo es positivo y constructivo. El color amarillo simboliza el brillo del sol. La luminosidad y el optimismo.

El pensamiento de sombrero amarillo se ocupa de la evaluación positiva del mismo modo que el pensamiento de sombrero negro se ocupa de la evaluación negativa.

El pensamiento de sombrero amarillo abarca un espectro positivo que va desde el aspecto lógico y práctico hasta los sueños, visiones y esperanzas.



El pensamiento de sombrero amarillo indaga y explora en busca de valor y beneficio. Después procura encontrar respaldo lógico para este valor y beneficio. El pensamiento de sombrero amarillo trata de manifestar un optimismo bien fundado, pero no se limita a esto - a menos que se califique adecuadamente otros tipos de optimismo.

El pensamiento de sombrero amarillo es constructivo y generativo. De él surgen propuestas concretas y sugerencias. Se ocupa de la operabilidad y de hacer que las cosas ocurran. La eficacia es el objetivo del pensamiento constructivo de sombrero amarillo.

El pensamiento de sombrero amarillo puede ser especulativo y buscador de oportunidades. Permite, además, visiones y sueños.

El pensamiento de sombrero amarillo no se ocupa de la mera euforia positiva (sombrero rojo) ni tampoco, directamente, de la creación de ideas nuevas (sombrero verde).

2.1.5. Pensamiento de sombrero verde

El sombrero verde es para el pensamiento creativo. La persona que se lo pone va a usar el lenguaje del pensamiento creativo. Quienes se hallen a su alrededor, deben considerar el producto como un producto creativo. Idealmente, tanto el pensador como el oyente deberían usar sombreros verdes.

El color verde es símbolo de la fertilidad, el crecimiento y el valor de las semillas.

La búsqueda de alternativas es un aspecto fundamental del pensamiento de sombrero verde. Hace falta ir más allá de lo conocido, lo obvio y lo satisfactorio.

Con la pausa creativa el pensador de sombrero verde se detiene en un punto dado para considerar la posibilidad de ideas alternativas en ese punto. No hacen falta razones para esta pausa.

En el pensamiento de sombrero verde el lenguaje del movimiento reemplaza al del juicio. El pensador procura avanzar desde una idea para alcanzar otra nueva.

La provocación es un elemento importante del pensamiento de sombrero verde y se simboliza con la palabra op. Se utiliza las provocaciones para salir de nuestras pautas habituales de pensamiento. Existente varias formas de plantear provocaciones incluyendo el método de la palabra al azar.

El pensamiento lateral es una serie de actitudes, lenguajes y técnicas (que incluyen movimiento, provocación y op) para saltar de pautas en un sistema autorganizado de pautas asimétricas. Se utiliza para generar conceptos y percepciones.



2.1.6. Pensamiento de sombrero azul

El sombrero azul es el sombrero del control. El pensador del sombrero azul organiza el pensamiento mismo. Pensar con el sombrero azul organiza el pensamiento mismo. Pensar con el sombrero azul establece el foco. Define los problemas y elabora las preguntas. El pensamiento de sombrero azul determina las tareas de pensamiento que se van a desarrollar.

El pensamiento de sombrero azul monitorea el pensamiento y asegura el respeto de las reglas de juego. El pensamiento de sombrero azul detiene la discusión e insiste en el pensamiento cartográfico. El pensamiento de sombrero azul refuerza y aplica la disciplina.

Se puede usar el pensamiento de sombrero azul en interrupciones eventuales para pedir un sombrero. También puede utilizarse para establecer una secuencia gradual de operaciones de pensamiento que deben respetarse tal como una danza respeta la coreografía.

Aún cuando se asigne a una persona el rol específico del pensamiento de sombrero azul, este rol está abierto a cualquiera que quiera proponer comentarios o sugerencias de sombrero azul.

2.2. Mapas mentales

Como lo establece Cervantes [CERVANTES, 1998, pp. 13,14], es un instrumento que permite representar de manera gráfica las ideas que se tienen sobre algún tópico en particular. Los mapas mentales contienen palabras claves, símbolos y figuras conectadas por líneas, que permiten a través de la forma, el color y el contenido, que las personas que lo usen, lo recuerden y lo analicen, al indicar de forma explícita como se relacionan todos los elementos presentados.

Como se muestra en la figura 1 [CERVANTES, 1998, p. 14], el mapa mental equivale a conseguir en un diagrama no lineal una réplica de la forma natural de pensar.



Figura 1 Mapa mental

Para poder construir un mapa mental [CERVANTES, 1998, pp. 13-81], se requiere:

1. Iniciarlo con una imagen central que involucre al menos tres colores.

2. Conectar tantas ramificaciones a la imagen central como sea

necesario.

3. Sí se requiere enfatizar una rama principal, sólo hay que añadir

grosor en la línea.

4. Elegir únicamente palabras o imágenes claves.

5. Usar imágenes lo más posible.

6. Agregar símbolos, flechas y colores a fin de establecer conexiones

y asociaciones entre los diferentes elementos.

7. Utilizar ayudas dimensionales.

Existen dos tipos de mapas mentales, el de generación de ideas o creativo y el que parte de ideas predeterminadas; el primero permite organizar las ideas propias, al profundizar en los conocimientos y experiencias previas con el fin de organizarlos y observarlos desde una perspectiva, lo que facilita pasar a la acción; el segundo organiza las ideas



propias o ajenas, al partir de cualquier clase de conocimientos o experiencias previas, para transformarlos en una réplica con estructura funcional.

Cuando se utiliza el pensamiento lateral una forma cartográfica de representarlos es a través de los mapas mentales.



Capítulo III. Herramientas para el manejo de Información

3.1. Reglas para escribir documentos.

En palabras de Bill Gates que el dueño del mundo es el dueño de la información y en otras opiniones semejantes de otros personajes, así como la facilidad que da Internet para publicar, han generado que la mayoría de la gente busque información, la generé, la duplique, la reenvíe, acumule. Provocando una marejada de información.

En la propuesta de Maureen Malanchuk [MALANCHUK, 1997] establece una serie de recomendaciones tanto para recibir como para enviar información. Por el propósito de este documento sólo se comenta su propuesta sobre el envío de información que resume en siete técnicas.

1. Seducir: Provoque la atención de su lector. Garantice lograr el objetivo de la información que envía.

2. Sintetizar: Acopie toda la información conveniente a su proyecto, analícela y explíquesela al el destinatario de su documento.

3. Mostrar: Utilice elementos gráficos y “palabras visuales” para transmitir su mensaje4.

4. Clasificar: Establezca una estructura de su documento en un estilo factible de recibir, y flexible que permita al receptor manejarla de manera fácil y rápida.

5. Separar: Identifique claramente cual es la información crucial de la caótica5.

6. Seleccionar: Elija el canal adecuado, ya sea en papel o en línea, según el documento que entrega y el propósito del mismo.

7. Callar: Reconozca cuando haya dicho suficiente o cuando no tenga nada que decir, y no diga una palabra más.

3.2. Escriba sólo lo importante.

Marie-Josée Couchaère [COACHAÈRE, 1990] y Edward de Bono [BONO, 1991] establecen una serie de recomendaciones que ayudan a escribir mejor y sólo lo importante, las cuales pueden ser un marco de referencia para el proceso del coach dar contexto al coachee. Establecen las siguientes recomendaciones:

4 Siga la propuesta de Marie-Josée Couchaère [COACHAÈRE, 1990] de cómo aligerar frases. 5 Se refiere que hay que dividirla en diferentes grados de detalle, para que los destinatarios obtengan lo que requieren.



� Escribir es indispensable: La documentación no sólo es sólo un instrumento de comunicación, también es un aspecto esencial en la sociedad del conocimiento. Establece lo siguiente:

o Los diccionarios y manuales no están prohibidos.

o Cuando más se escribe, mejor se habla.

o Siempre hay tiempo para leer un documento breve y bien escrito que invita a ser leído.

o Basta ejercitarse para mejorar la ortografía. Pero cuando se inicia un documento hay que escribir sin cuidar la ortografía, pero haciendo un esfuerzo por no cometer errores.

o Las palabras se las lleva el viento mientras los escritos quedan.

o Aquello que está bien escrito impresiona al lector, inclusive al jefe.

o Con métodos y puntos de referencia es más rápido y más fácil.

� No escriba para impresionar: En la actualidad el lector empresario tiene prisa y está muy ocupado. Necesita leer con rapidez para actuar eficazmente. Por lo que no emplee:

o Palabras pomposas y grandilocuentes y pesadas para producir “efecto”.

o Fórmulas discursivas para ocultar la dificultad.

o Las frases hechas y los pleonasmos para dar importancia.

o La voz pasiva para disimular la responsabilidad.

o El verbo en infinitivo para valorizar la expresión.

o Invertir el sujeto para reforzar su importancia.

� Consejos para aligerar sus frases.

o Haga frase de menos de 25 palabras.

o Escriba la palabra importante al principio de la frase, o en ciertos casos al final, pero jamás en el medio.

o Utilice palabras simples, cortas, vigentes, concretas y representativas.

o Depure la expresión.

o Reemplace el pronombre relativo por un adjetivo o un sustantivo.

o Utilice una afirmación en lugar de una negación.

o Aplique toda la variedad de signos de puntuación.

o Utilice las palabras enlace al principio de la oración.

o Conjugue los verbos en la voz activa.



o Elimine las palabras superfluas.

o Suprima las frases inútiles.

� Adopte un estilo directo: Forzar las situaciones, manejarlas o huir ante los problemas, son estilos que ya no van con la comunicación en la sociedad del conocimiento. Hoy es necesario saber afirmarse, respetando a los demás.

o Respuesta automática frente a los problemas.

� Describa la situación.

� Exprese su opinión.

� Proponga una solución.

� Convenza con un argumento.

o Preguntas claves para saber que decir.

� ¿Cuáles son los hechos?

� ¿Qué opinión tengo al respecto?

� ¿Por qué hay que hacer algo?

� ¿Por qué o qué puede salir mal?

� ¿Cuáles son otros caminos de solución?

� Fase para escribir bien y rápido: Basta con ser metódico para evitar tergiversar, tachar lo escrito o paralizarse ante la hoja en blanco.

1. Reúna las ideas y los hechos.

2. Elabore un plan.

3. Haga un bosquejo.

4. Revise el bosquejo.

� Utilice las palabras de enlace: Encadena los razonamientos, apoya la descripción y esclarecen las expresiones. Se deben utilizar, sobre todo, en las cartas comerciales y en los informes. Las principales palabras de enlace son:

o La oposición.

o La adhesión.

o La restricción.

o La sucesión.

o La alternativa.

o La correlación.

o La causa.

o La consecuencia.



o El resultado.

o La adición.

� Use todos los signos de puntuación: Los signos son parte integrante de las frases y pueden remplazar a las palabras, ocupando menos espacio. Es necesario utilizar todos sus recursos.

o Utilice los dos puntos.

o Rescate el punto y coma.

o Extienda el uso de la coma.

o Atención con los paréntesis.

o Emplee los guiones.

� Utilice títulos convincentes: Deben sugerir al lector el “meollo” del texto y orientarlo para una lectura rápida. Consejos para lograr un título convincente.

o Cada título debe despertar el interés del lector o su curiosidad.

o Dé un rasgo de actualidad a sus títulos. El lector esta al acecho de novedades.

o Atrévase a hacer títulos largos, si hace falta. Pero para el título principal del documento busque que no sea de más de 80 caracteres o 7 palabras.

o Evite los títulos con juegos de palabras, difíciles de entender, alusiones literarias o de otro tipo.

o Evite los títulos formulados con una negociación. Escriba “Para iniciar un proyecto, establezca los requerimientos” en lugar de “No inicie un proyecto, sin definir requerimientos”.

o Utilice las preguntas con precisión: ¿Dónde está..?, ¿Cómo hacer para…?

o Recurra a los números: La siete razones…., Los cuatro problemas de…

o Antes de elegir un título definitivo, realice una lista de títulos posibles.

o Si el escrito tiene dos títulos, el segundo debe complementar y no reproducir al primero.

o Elija el título al final, después de haber escrito el texto.

� Presentación del documento: La presentación del documento debe ser atractiva, además de dar la impresión de facilitar la lectura. Hay que tener en cuenta que ésta es la primera relación del lector con usted. Su código debe ser evidente y revelador, ya que forma parte de su mensaje.



Estos estándares definen un “estilo propio” para los documentos y contribuye de forma importante a la consistencia de los mismos. Incluye el tipo de letra y estilos utilizados en el documento, la utilización de logotipos y los nombres de la compañía (si aplica), la utilización de color para resaltar la estructura del documento entre otras recomendaciones. Cada equipo de desarrollo podrá establecer sus propios estándares, pero estos deben abarcar:

o El formato: Defina el que mejor convenga al destino de su documento.

o La encuadernación: Piense en su destinatario y en su posición de lectura.

o El papel: Aproveche la gran variedad que actualmente ofrece el mercado.

o El gancho: Lo constituyen la primera, la última y la penúltima páginas.

o La tipografía: Se refiere al tamaño y estilo de los caracteres.

o La composición: Es la distribución por página del texto y las figuras.



Capítulo IV. Documentos de la Ingeniería de Software

La planeación y el control son elementos esenciales de todo software exitoso. Al desarrollar el software la planeación se realiza mucho antes de que comience la programación. Se necesita técnicas que nos ayuden a poner los objetivos en clara para que el software cumpla con lo esperado por el usuario. También se requieren técnicas de diseño que ayuden a dividir el esfuerzo de programación en módulos u objetos manejables.

Sin embargo, no es satisfactorio tratar de dejar las cosas simplemente en las etapas de planeación. Después de que los programas estén terminados deben recibir mantenimiento, y los esfuerzos de mantenimiento típicamente sobrepasan el esfuerzo gastado en el diseño y programación original.

Se documenta el software y los documentos para que estén en un formato que pueda ser fácilmente accesado. El acceso a los procedimientos es necesarios para que las nueva gente que aprenda el software y como un recordatorio para aquellos que lo usan con poca frecuencia. La documentación permite que los usuarios, evaluadores del sistema, administradores del sistema, “vean” al software y procedimientos sin tener la necesidad de interactuar con él.

La rotación de personal de las áreas de tecnología de información ha sido tradicionalmente alta en comparación con otros departamentos, por lo que hay mucha probabilidad de que la gente que concibió e instalo el software original no sea la misma que le dé mantenimiento. Documentación consistente bien conservada acortará la cantidad de horas requeridas para nuevos ingenieros de software aprendan el sistema antes de realizar el mantenimiento.

Hay muchas razones por las cuales el software están sin documentar o con muy poca documentación, ya que algunos de los problemas residen con el software mismo y otros con los ingenieros de software.

Alguno software antiguo fue escrito antes de que el negocio estandarizará sus técnicas de documentación, pero se encuentran todavía en uso (sin documentación). Muchos otros software han tolerado modificaciones mayores y menores y “parches” a través de los años, pero su documentación no ha sido modificada para que los refleje. Algún software especializado fue comprado por sus funciones importantes a pesar de la falta de documentación correspondiente.

Los ingenieros de software pueden fallar al documentar el software adecuadamente, debido a que no tienen tiempo o no son recompensados por el tiempo gastado en la documentación. Algunos ingenieros no documentan debido a que tienen miedo de hacerlo o sienten que no es un trabajo real. Además muchos ingenieros son reticentes de documentar software que no es propio, tal vez temiendo represalias si incluyen material incorrecto acerca del software de alguien más.



Los manuales del software proveen información más detallada de la ayuda en línea y se diseña de tal forma que pueda ser usada por diferentes usuarios del sistema.

Figura 2 Tipos de documentos producidos para apoyar a los usuarios.

Como lo establece Sommerville [SOMMERVILLE, 2002], para satisfacer esta clase de usuarios, existen al menos seis documentos o tal vez capítulos de un solo documento, que se entrega con un sistema de software (ver figura 2).

Estos documentos son:

1. Descripción Funcional: narra brevemente, los servicios que provee el sistema en términos de requerimientos funcionales y no funcionales y las métricas para su comprobación de cumplimiento. El usuario le debe ser posible leer este documento junto con su manual introductorio y decidir si es el sistema que necesita.

2. Documento de instalación: Indica los detalles de cómo instalar el software. Describe los discos que se entregan con el sistema, los archivos que contienen y la configuración mínima de hardware requerida. Debe incluir las instrucciones de instalación y los detalles de cómo instalar los archivos dependientes de la configuración.

3. Manual introductorio: Describe el área problema, las causas que originan el problema, los requerimientos originales del usuario (si existen). Una descripción de la utilización “normal” del sistema. Describe cómo iniciar y cómo los usuarios finales pueden utilizar los recursos comunes del software. Se ilustra con muchos ejemplos. Incluye información de cómo recuperarse de los errores y restablecer el funcionamiento.

Evaluadores de sistemas

Administradores del sistemas

Usuarios novatos

Usuarios experimentados

Administradores del sistemas

Ingenieros de software

Descripción

funcional

Documento

de instalación

Manual de

introducción

Manual de referencia

Guía del

administrador

Manual del

sistema

Descripción de servicios

Cómo instalar

el sistema

Iniciando

Descripción de recursos

Operación y

mantenimiento

Diseño del

sistema



4. Manual de referencia: Describe los recursos del software y su utilización, provee una lista de mensajes de error y posibles causas y describe cómo recuperarse de los errores detectados.

5. Manual del administrador: Se provee en algunos tipos de software. Éste describe los mensajes generados cuando el software interactúa con otros y cómo reaccionar a estos mensajes. Si el sistema de hardware participa, explica cómo reconocer y reparar los problemas relacionados con el hardware, cómo conectar los nuevos periféricos, etcétera.

6. Manual del sistema: Describe la especificación del diseño, aborda diferentes aspectos del modelo de software utilizando los estándares de diagramación establecidos para diseño orientado a estructura o a objetos según corresponda, incluye la especificación de:

a. Diseño de datos, se describe las estructuras de las bases de datos, y de cualquier estructura externa de archivos, estructuras internas de datos y una referencia cruzada que conecta los objetos de datos con archivos especificados.

b. Diseño arquitectónico, indica cómo se ha derivado la arquitectura del programa del modelo de análisis. Además, para representar la jerarquía del módulo se utilizan gráficos de estructura,

c. Diseño de interfaces internas y externas, de programas y se describe un diseño detallado de la interfaz hombre-máquina.

d. Narrativa de procedimiento: Los componentes que pueden ser elementos de software que se pueden tratar por separado como subrutinas, funciones o procedimientos, se describen con una narrativa de procesamiento que explica la función procedimental del componente, hasta llegar a su descripción estructural.

e. Referencia cruzada de requerimientos: Establece que todos los requerimientos se satisfagan mediante el diseño de software, y específica cuales son los componentes críticos para la implementación de requisitos determinados.

f. Restricciones de diseño: Tales como limitaciones físicas de memoria o la necesidad de una interfaz externa especializada, podrán dictar requerimientos especiales para ensamblar o empaquetar el software, entre otros.

g. Datos complementarios: Presenta descripciones de algoritmos, procedimientos alternativos, datos tabulares o extractos de otros documentos y otro tipo de información relevante, todos mediante notas especiales o apéndices separados.



Capítulo V. Coaching para escribir documentos

Los estándares de documentación en un proyecto de software son documentos muy importantes ya que son la única forma tangible de representar al software y al proceso de software. Los escritos estandarizados tienen una apariencia, estructura y calidad estable, y por lo tanto son más viables de leer y comprender:

1. Estándares para el proceso de documentación: Éstos definen el proceso a seguir para la producción del documento.

2. Estándares del documento: En el anexo “Lineamientos para la presentación de documentos” se hace una propuesta de la estructura y su presentación.

3. Estándares para el intercambio de documentos: Se busca que todas las copias electrónicas de los documentos sean compatibles.

Siguiendo la metodología de coaching, pese a no tener un coaching que lo apoye, el lector-escritor puede:

1. Romper sus modelos mentales ya sea de manera personal o preguntando a sus cercanos qué es lo que opina o buscando las opiniones de otros autores.

2. Usar la meta-preguntas propuesta, así como también ponerse en el lugar de los otros para iniciar.

3. Escribir el documento, guardarlo un tiempo y posteriormente echarle un vistazo. Esto se convierte en un instrumento que permite examinar el pensamiento propio como si fuera de otro.

4. Cuestionar la legitimidad de las propias ideas usando la meta-pregunta para ver si el documento la responde.

5. Evaluar si no se presenta las leyes de la opacidad, lo obvio y la tortura.

6. Cuestionarse qué es realmente importante para los usuarios.

Siguiendo estos parámetros guía y utilizando algunas de las herramientas, consejos y sugerencias que se discutieron anteriormente, así como el proceso de producción de un documento que incluye la comprobación de calidad, como se muestra en la figura 3.

Los estándares de calidad del proceso de documentos deben ser flexibles y les debe ser posible ajustarse a todo tipo de documentos. Para los documentos de comunicación interna como memorandos, de trabajo, no es necesario comprobar explícitamente la calidad. Sin embargo si los documentos serán utilizados para desarrollos posteriores o son documentos a entregar a los clientes, se debe adoptar el proceso formal de comprobación de calidad.

Prepararse para crear un documento, crear un borrador, comprobarlo aplicando meta-preguntas, y rehacerlo es un proceso iterativo. Este continúa



hasta que se produce un documento de calidad aceptable. El nivel dependerá del tipo de documento y de los lectores potenciales de este.

Los estándares del documento aplicaran a todos los documentos producidos en el transcurso del desarrollo del software. Los documentos deberán tener un estilo y una apariencia estable. Aunque los estándares del documento se adecuen a las necesidades de un proyecto en particular, una buena práctica es que se utilice el mismo estilo en todos los documentos producidos por una organización.

Figura 3 Proceso de producción de un documento.

5.1. Meta-preguntas

Las preguntas sirven para muchas cosas. Cuando se inicia una sesión el coach pregunta para recabar información y establecer los hechos. En las fases subsecuentes el coach pregunta para explorar las creencias y los valores del cliente, para profundizar en su pensamiento e indagar que desea, por qué lo quiere y qué le impide alcanzarlo.

Como ya se comento en la sección de "Qué es coaching para escribir documentos", las meta-preguntas se aplican en distintos momentos por el lector-escritor y estas son elementos que provocan la reflexión del coachee,



al inicio como elemento de reflexión, en los mementos subsecuentes como elemento de revisión, las cuales si son aplicadas con talento pueden producir los resultados esperados.

5.1.1 Meta-preguntas para romper los modelos mentales

Peter Senger [SENGER, 1995] establece varias técnicas para romper los modelos mentales, sólo se tomara parte de las técnicas, la “escalera de indiferencia” y “la columna izquierda” que más se adecuan al propósito de generar Meta-preguntas que ayuden a romper los modelos mentales.

� ¿Cuáles son los datos observables que respaldan esta afirmación?

� ¿Todos concuerdan con la índole de los datos?

� ¿Puedes hacerme seguir tu razonamiento?

� ¿Cómo pasamos de los datos a estos supuestos abstractos?

� ¿Qué me ha inducido a pensar y sentir de esta manera?

� ¿Cuál era mi intención? ¿Qué pretendía lograr?

� ¿Alcancé los resultados que buscaba?

� ¿Cómo influyeron mis comentarios sobre las dificultades?

� ¿Por qué no dije lo que estaba yo pensando?

� ¿Qué supuestos tenia sobre los usuarios?

� ¿Cuál fue el precio de operar de esta manera? ¿Cuáles fueron los frutos?

� ¿Qué me impidió actuar de otra manera?

� ¿Cómo puedo usar lo que yo pensaba, como recurso para mejorar la comunicación?

5.1.2. Meta-preguntas para crear documentos que envía

La copiosidad de la información a la que Maureen Malanchuk [MALANCHUK; 1997] se refiere como el “infodiluvio”, es uno de los desafíos más dominantes y debilitantes de la vida profesional moderna. Con la idea de que la “información es poder”, se trata de absorber todo, y como consecuencia produce un ahogo de información en el proceso. Por lo que, cuando se crean documentos que van a ser leídos por otros, hay que tomar en cuenta si se busca informar de algo o de persuadirlos de hacer algo. Por lo que debemos hacernos una serie de Meta-preguntas que indiquen sí se es experto en el envío de información.

Nivel de experiencia enviando información.

� ¿Siempre tienes presente a tus lectores cuando envías información?



� ¿Domino técnicas poderosas de comunicación oral y escrita y las aplicas en todos los medíos que utilizas?

� ¿Tomas cursos o lees libros para fortalecer tus técnicas básicas de comunicación y para descubrir nuevos métodos para el envío de información?

� ¿Te esfuerzas para atraer la atención de tus lectores y para lograr que tus mensajes destaquen?

� ¿Eres un comunicador equilibrado que sabe cómo mostrar, no sólo decir, tu mensaje?

� ¿Sabes cómo comunicar información dinámica que cambia constantemente?

� ¿Separas la información crítica de la que resulta caótica para tus lectores?

� ¿Presentas la información en formatos rápidos y sencillos de leer?

� ¿Eliges los medios más apropiados para tus lectores y mensajes?

� ¿Reconoces cuando has dicho suficiente y no dices más?

Técnicas para manejar la información de tu documento.

� Seducir:

o ¿El documento atraer la atención de tu lector?

o ¿El mensaje de tu documento llegará hasta el proceso de clasificación del lector?6

o ¿Los títulos o encabezados son convenientes, específicos, originales o informativos?

o ¿El documento es atractivo y fácil de leer?

o ¿El documento emplea resúmenes ejecutivos, panoramas generales, señalamiento de puntos importantes, sinopsis, plantillas y formatos estandarizados?

� Sintetizar:

o ¿Haz reunido las observaciones, hechos, cifras, análisis y evaluaciones pertinentes?

o ¿Tienes un contexto como marco de referencia que te permita seleccionar la información y datos pertinentes?

o ¿Alguien dentro de la organización trabaja en un proyecto similar?

6 El proceso de clasificación del lector, es cuando supera las barreras de reopción, como el estrés, la actitud defensiva y la resistencia al cambio.



� Mostrar:

o ¿Lo que vas a escribir se puede expresar con una imagen, un cuadro o una gráfica?

o ¿Hay fotografías que muestren los hechos?

o ¿La “imagen” no requiere explicación?

o ¿Las “imágenes” tiene un texto anexo explicativo?

� Clasificar:

o ¿Se incluye todo lo que se tiene que decir?

o ¿La estructura del documento es flexible?

o ¿La estructura del documento es fácil de leer?

o ¿La información del documento se muestra en distintos niveles de detalle?

o ¿Identifica distintos tipos de lectores del mismo documento?

� Separar:

o ¿Identifica la información caótica del la crucial?

o ¿Identifica la información crucial de su documento?

� Seleccionar:

o ¿Cuál es el tipo de información que contiene su documento?

o ¿Cuál es el canal más apropiado para el tipo de lector del documento?

o ¿Qué acción espera del tu lector una vez lea tu documento?

o ¿Cuáles la urgencia e importancia de tu documento?

� Callar:

o ¿Sabe lo que tiene que decir?

o ¿Ya dijo lo que quiere decir?

o ¿Sus párrafos son cortos y directos?

o ¿Sus ideas no son redundantes?

5.1.3. Meta-preguntas de formato y estructura del documento.

Estructura.

� ¿Cuáles son los hechos?

� ¿Qué opinión tengo al respecto?

� ¿Por qué hay que hacer algo?

� ¿Por qué o qué puede salir mal?



� ¿Cuáles son otros caminos de solución?

Formato.

� ¿Cuál es el objetivo del documento? ¿Es valido?

� ¿Quién es el destinatario del documento?

� ¿Qué consecuencias puede tener este documento?

5.1.4. Meta-preguntas para documentos técnicos

Dependiendo del tipo de documento y contenido se aplicaran antes y después el siguiente apartado:

1. Meta-preguntas para documentar los requerimientos.

2. Meta-preguntas para determinar el ciclo de vida.

3. Meta-preguntas para documentar el diseño.

4. Meta-preguntas para documentar el desarrollo.

5. Meta-preguntas para documentar las pruebas.

5.1.4.1.- Meta-preguntas para documentar los requerimientos

En el libro de Lawrence [LAWRENCE, 2003], establece una serie de cuestionamiento para garantizar la calidad de los requerimientos, en este caso las convertiremos en Meta-preguntas que ayuden a realizar el auto-coaching. Los documentos a crear deben responder a las siguientes Meta-preguntas.

Ambiente físico.

� ¿Dónde esta el equipamiento que necesita el sistema para funcionar?

� ¿Existe una Localización o varias?

� ¿Existen restricciones ambientales, tales como temperatura, humedad o interferencia magnética?

Interfaces.

� ¿La entrada proviene de uno a más sistemas?

� ¿La salida va a no o más sistemas?

� ¿Existe una manera prescrita en la que deban formatearse los datos?

� ¿Existe un medio prescrito que los datos deban utilizar?

Usuarios y factores humanos.

� ¿Quién usará el sistema?

� ¿Habrá varios tipos de usuarios?

� ¿Cuál es el nivel de habilidades de cada usuario?

� ¿Qué clase de entrenamiento requerirá cada tipo de usuario?



� ¿Cuán fácil le será a un usuario comprender y utilizar el sistema?

� ¿Cuán difícil le resultará a un usuario hacer uso indebido del sistema?

Funcionalidad.

� ¿Qué hará el sistema?

� ¿Cuándo lo hará?

� ¿Existen varios modos de operación?

� ¿Cómo y cuándo puede combinarse o mejorarse un sistema?

� ¿Existen restricciones de la velocidad de ejecución, tiempo de respuesta o rendimiento?

Documentación.

� ¿Cuánta documentación se requiere?

� ¿Debe estar en línea, en papel o en ambos?

� ¿A qué audiencia está orientado cada tipo de información?

Datos.

� ¿Cuál será el formato de los datos tanto para la entrada como la salida?

� ¿Cuán a menudo serán recibidos o enviados?

� ¿Cuán exactos deben ser?

� ¿Con qué grado de precisión deben hacerse los cálculos?

� ¿Cuántos datos fluyen a través del sistema?

� ¿Debe retenerse algún dato por algún periodo de tiempo?

Recursos.

� ¿Qué recursos materiales, personales o de otro tipo se requieren para construir, utilizar y mantener el sistema?

� ¿Qué habilidades deben tener los desarrolladores?

� ¿Cuánto espacio físico será ocupado por el sistema?

� ¿Cuáles son los requerimientos de energía, calefacción o acondicionamiento de aire?

� ¿Existe un cronograma prescrito para el desarrollo?

� ¿Existe un límite sobre la cantidad de dinero a gastar en el desarrollo o en hardware y software?

Seguridad.

� ¿Debe controlarse el acceso al sistema o a la información?

� ¿Cómo se podrá aislar los datos de un usuario de los otros?



� ¿Cómo podrán aislarse los programas de usuario de los otros programas y del sistema operativo?

� ¿Con qué frecuencia deben hacerse las copias de respaldo?

� ¿Las copias de respaldo deben almacenarse en un lugar diferente?

� ¿Debe tomarse precauciones contra fuego, el daño provocado por agua o el robo?

� ¿Cómo se debe actuar en caso de desastre?

Aseguramiento de la calidad.

� ¿Cuáles son los requerimientos para la confiabilidad, disponibilidad, factibilidad de mantenimiento, seguridad y los restantes atributos de calidad del software?

� ¿Cómo deben demostrarse las características del sistema a terceros?

� ¿Debe el sistema detectar y aislar los defectos?

� ¿Cuál es el promedio de tiempo prescrito entre fallas?

� ¿Existe un tiempo máximo permitido para la recuperación del sistema después de una falla?

� ¿Cómo puede el sistema incorporar cambios al diseño?

� ¿El mantenimiento corregirá meramente los errores, o incluirá también el mejoramiento del sistema?

� ¿Qué medidas de eficiencia se aplicarán al uso de los recursos y al tiempo de respuesta?

� ¿Cuán fácil debe ser mover el sistema de una ubicación a otra o de un tipo de computadora a otra?

5.1.4.2.- Meta-preguntas para determinar el ciclo de vida.

Distintos proyectos tienen necesidades diferentes, incluso si todos necesitan ser desarrollados lo más rápido posible. Por lo que no existe “un modelo de ciclo de vida de desarrollo rápido”, debido a que el modelo más efectivo depende del contexto en el que se utilice. Determinados modelos de ciclo de vida son considerados más rápidos que otros. Pero cada uno de ellos será más rápido en determinadas situaciones y más lento en otras. Un modelo que a menudo trabaja bien puede suceder que no funcione bien si no se utiliza correctamente. Para saber si se seleccionar el modelo más conveniente se debe responder a las siguientes Meta-Preguntas:

� ¿Me compenetro con el cliente para la especificación de los requerimientos al comienzo del problema?

� ¿Es probable que el entendimiento de las dos partes cambie significativamente a medida que se avance en el proyecto?

� ¿Comprendo bien la arquitectura del sistema?



� ¿Es probable que necesite llevar a cabo modificaciones importantes en la arquitectura a mitad del proyecto?

� ¿Cuánta fiabilidad necesito?

� ¿Cuánto tiempo extra necesito para planificar y diseñar durante el proyecto para las versiones futuras?

� ¿Cuántos riesgos conlleva el proyecto?

� ¿Estoy sometido a una planificación predefinida?

� ¿Necesito poder realizar modificaciones a medio camino?

� ¿Necesito proporcionar a mis clientes signos visibles de progreso durante el proyecto?

� ¿Necesito ofrecer a la directiva signos visibles de progreso durante el proyecto?

� ¿Cuánta sofisticación necesito para utilizar el modelo de ciclo de vida con éxito?

5.1.4.3.- Meta-preguntas para documentar el diseño.

Uno de los productos más importantes del proceso de diseño es un conjunto de documentos que describen el sistema a ser construido. Como se ha visto, una parte de esta documentación esta dirigida a clientes y usuarios, en lenguaje natural, para describirles qué es lo que el sistema hará; una segunda parte usa terminología técnica que describe la estructura del sistema, datos y funciones- De este modo, el contenido de las dos partes puede superponerse pero no la forma en que se expresan los conceptos.

� ¿Este diseño es una solución al problema?

� ¿El diseño es modular, bien estructurado y fácil de comprender?

� ¿Puede hacerse algo para mejorar la estructura y la comprensión del sistema?

� ¿El diseño es transportable a otras plataformas?

� ¿Es reutilizable?

� ¿Es fácil de modificar y expandir?

� ¿Soporta facilidad de prueba?

� ¿Maximiza el rendimiento donde es apropiado?

� ¿Reutiliza componentes provenientes de otros proyectos, donde es apropiado?

� ¿Los algoritmos son los adecuados o pueden mejorarse?

� Si está provisto desarrollar este sistema en fases, ¿tiene las “interfaces” adecuadas de modo de que la transición entre etapas sea fácil?



� ¿El diseño esta bien documentado e incluye las opciones de diseño y una justificación racional?

� ¿El diseño hace referencia cruzada de componentes y datos con los requerimientos?

� ¿Utiliza las técnicas apropiadas para el tratamiento de defectos y la prevención de fallas?

� ¿Contiene menús y otros formatos de presentaciones en pantalla?

� ¿Describe las interfaces hombre-máquina; teclas de función; descripción de pantallas sensibles al tacto, esquemas de teclado y el uso del mouse o de la palanca para juegos (joystick)?

� ¿Describe los formatos de los informes?

� Entrada: ¿Identifica la procedencia de los datos, cómo se les da formato y el medio en que son almacenados?

� Salida: ¿Identifica dónde se envían los datos, cómo se les da formato y el medio en que son almacenados?

� ¿Describe las características funcionales generales?

� ¿Establece las exigencias de performance?

� ¿Describe los procedimientos de archivos?

� ¿Establece el enfoque del tratamiento de defectos?

5.1.4.4.- Meta-preguntas para documentar el desarrollo.

Cuando se escribe código, como cuando se prepara un documento o se crea una obra de arte, a menudo se prepara un borrador. Luego, se le revisa cuidadosamente y se reescribe hasta obtener un resultado satisfactorio. Si se descubre que el flujo de control es intrincado, que los procesos de decisión son difíciles de comprender o que las ramificaciones incondicionales resultan difíciles de suprimir, puede ser oportuno volver sobre el diseño. Reexaminar el diseño para determinar si los problemas que aparecen son inherentes al diseño o tienen que ver con la traducción a código. Volver a mirar la forma en que los datos están representados y estructurados, los algoritmos elegidos y la descomposición adoptada. Las siguientes Meta-Preguntas puede ayudar a resolver estas situaciones.

Generales.

� ¿El componente realiza la función o proporciona los datos necesarios?

� ¿Si se requiere alguna modificación menor, es menos trabajo la modificación que componer el componente desde el principio?

� ¿El componente se encuentra bien documentado de modo que se comprenda sin necesidad de verificar su implementación línea por línea?



� ¿Existe un registro completo de la historia de revisión y prueba de los componentes que garantice que no tiene defectos?

Si son componentes reutilizables.

� ¿El componente reutilizable utiliza parámetros y anticipa condiciones similares a aquellas en que el sistema invocará estos componentes?

� ¿Separa dependencias, de forma que las secciones que probablemente requieran cambios estén aisladas de las que probablemente se van a conservar idénticas?

� ¿La interfaz del componente es general y esta bien definida?

� En caso de defectos, ¿Están corregidos y documentados?

� ¿Se describe las estructuras de datos y algoritmos?

� ¿Se encuentran separadas las secciones de comunicación y manipulación de error? ¿Estas secciones son fáciles de modificar?

Documentación interna –dentro del programa-

� ¿Qué denominación tiene el componente?

� ¿Quién ha escrito el componente?

� ¿Dónde va ubicado el componente en el diseño general del sistema?

� ¿Cuándo fue escrito, revisado o modificado?

� ¿Por qué existe el componente?

� ¿Cómo utiliza sus estructuras de datos algoritmos y control?

� ¿Indica el nombre, tipo y propósito de cada una de las principales estructuras de datos y variables?

� ¿Contiene breves descripciones del flujo lógico, algoritmos y tratamiento de errores?

� ¿Indica cuales son las entradas esperadas y las posibles salidas?

� ¿Presenta las ayudas para la prueba y cómo usarla?

� ¿Enuncia las extensiones o revisiones esperadas?

� Los nombres de variables y enunciados, ¿reflejan su utilización y significado?

Documentación externa.

� ¿Se describe el problema a resolver?

� ¿Se describe el porqué de la existencia del componente?

� ¿Se describe los algoritmos?

� ¿Se conoce el flujo de datos? ¿Contiene referencias relevantes con el diccionario de datos?



5.1.4.5.- Meta-preguntas para documentar las pruebas.

La documentación de pruebas permite controlar la complejidad y la dificultad inherentes a esta etapa de un proyecto, por lo que la documentación de la prueba debe responder a las siguientes Meta-Preguntas.

Objetivos de la prueba.

� ¿Cómo se hará la gestión de prueba?

� ¿Qué esfuerzo técnico se requiere durante la prueba?

� ¿Cuál es el plan a seguir y su cronograma correspondiente?

� ¿Qué requerimientos a la organización se requieren para realizar la prueba?

� ¿Cuáles son los métodos de prueba?

� ¿Cuál es la naturaleza y magnitud de cada prueba?

� ¿De qué manera la prueba evaluará por completo la función y rendimiento del sistema?

� ¿Cuáles son las entradas de prueba?

� ¿Cuáles son los procedimientos de prueba específicos?

Especificación de la prueba.

� ¿Cuáles son los requerimientos probados?

� ¿Cuáles son las funciones probadas?

� ¿Qué métodos se seguirán para la realización de la prueba?

� ¿Qué condiciones previas y durante la prueba deben estar presentes?

Descripción de la prueba.

� ¿Cuáles son los datos para la prueba?

� ¿Cuáles son los medios de control de la prueba?

� ¿Cuál es el procedimiento a seguir para la realización de la prueba?

� ¿Cuál es el criterio de cobertura de prueba?

� ¿Existen limitaciones de tiempo, interfaz, equipamiento, personal, base de datos o de otro tipo sobre la prueba?

� ¿Si la prueba consiste en una serie de pruebas más pequeñas, en qué orden deben ser realizadas?

Informe de análisis de prueba.

� ¿Cuáles son los resultados esperados de la prueba?

� Si se produce una falla, ¿El informe proporciona la información que se necesita para reproducirla se es necesario?



� Si se produce una falla, ¿El informe proporciona la información que se necesita para localizar y arreglar el origen del problema?

� ¿Cuáles son los elementos que establecen la confianza en el rendimiento del software?



Bibliografía.

[BONO, 1991] Edward de Bono, “Seis sombreros para pensar, Una guía de pensamiento para gente de acción”, Editorial Granica Vergara. Argentina, páginas 222, ISBN. 950-641-061-5, 1991:

[BONO, 1997] Edward de Bono, “Aprender a pensar por ti mismo”, Editorial Paidos. México, páginas 214, ISBN.968-853-358-0, 1997:

[BULAT, 2006] Sergio Bulat, “Coaching para escribir”, Editorial Paidos, España, páginas 143, ISBN. 84-493-1879-3, año 2006.

[BUZAN; 1996] Tony Buzan, “El libro de los mapas mentales, cómo utilizar al máximo las capacidades de la mente”, Editorial Urano, España, páginas 350, ISBN. 84-7953-146-0, 1996.

[CHECKLAND, 1993] Peter Checkland, “Pensamiento de sistemas, práctica de sistemas”, Editorial John Wiley & Son/Noriega Editores, México, páginas 367, ISBN. 968-18-4525-0, 1993.

[CHECKLAND, 1994] Peter Checkland, et al, “La metodología de los sistemas suaves de acción”, Editorial John Wiley & Son/Noriega Editores, México, páginas, ISBN. , 1994.

[COUCHAERE, 1997] María-Josée Couchaére, “Escriba mejor, y sólo lo importante”, Editorial Granica, España, páginas 18, ISBN. 84-7577-540-3, año 1997.

[KENDAL, 1997] Kenneth E. Kendall, et al. “Análisis y diseño de sistemas”, Editorial Prentice Hall, México, páginas 913, ISBN. 968-880-694-3. 1997.

[LAWRENCE, 2002] Shari Lawerence Pfleeger, “Ingeniería de software, teoría y práctica”, Editorial Prentice Hall, Brasil, páginas 759, ISBN 987-9460-71-5, 2005.

[MALANCHUK, 1997] Maureen Malachuk, “Información, habilidades para organizarla y mantener el control”, Prentice Hall, México, páginas 128, ISBN 968-880-983-7. 1997

[MCCONNELL, 1997] Steve McConnell, “Desarrollo y gestión de proyectos informáticos”, Editorial Mc Graw Hill, España, páginas 691, ISBN. 84-481-1229-6, 1997.

[O’CONNOR, 2005] Joseph O’Connor, et al, “Coaching con PNL”, Editorial Urano, España, páginas 268, ISBN. 84-7953-586-5.

[PRESSMAN, 2002] Roger S. Pressman. “Ingeniería de software, un enfoque práctico”, Editorial Mc Graw Hill, España, páginas 601, ISBN. 84-481-3214-9, 2002.

[SENGER, 1992] Peter Senger, “La quinta disciplina, el arte y la práctica de la organización abierta al aprendizaje”, Editorial Granica Vergara,



Argentina, páginas 492, ISBN 950-641-099-2 1992

[SENGER, 1995] Peter Senger, et al. “La quinta disciplina en la práctica”, Editorial Granica, España, páginas 593, ISBN 84-7577-393-1, 1995.

[SENGER, 2000] Peter Senger, et al. “La danza del cambio, los retos para sostener el impulso en organizaciones abiertas al aprendizaje”, Editorial Grupo editorial Norma, Colombia, páginas 498, ISBN 958-04-5494-9, 2000.

[SOMMERVILLE, 2002] Ian Sommerville. “Ingeniería de software”, Editorial Addison Wesley, México, páginas 692, ISBN. 970-26-0206-8. 2002



Anexos



Lineamientos para la presentación de documentos

I. Prefacio

Con el objetivo de facilitar la elaboración documentos proporciona los lineamientos generales para su preparación y presentación.

Estos lineamientos se deben tomar en cuenta desde el primer momento en que se empieza a recopilar la información para el trabajo escrito, con el fin procurar la más alta calidad.

II. Estándares para la identificación del documento.

Debido a que los proyectos de sistemas grandes producen cientos de documentos, cada uno de ellos se debe identificar de forma única. Para los documentos que son distribuidos a varios clientes, este identificador es el definido por el administrador de la configuración. Para documentos que son distribuidos a un solo cliente el identificador es defino por el administrador del proyecto.

III. Estándares para la presentación de documentos

Estos estándares definen un “estilo propio” para los documentos y contribuye de forma importante a la consistencia de los mismos. Incluye el tipo de letra y estilos utilizados en el documento, la utilización de logotipos y los nombres de la compañía (si aplica), la utilización de color para resaltar la estructura del documento entre otras recomendaciones. Cada equipo de desarrollo podrá establecer sus propios estándares, aquí se sugieren los siguientes:

� El titulo del documento, debe ser como máximo de 80 caracteres incluyendo espacios, o siete palabras sin abreviaturas.

� No se admiten copias de diferente calidad: esto quiere decir que la impresión y presentación de cada copia debe ser uniforme (tanto en calidad como en forma).

� La encuadernación deberá ser engargolada.

� Se respetarán los márgenes establecidos, véase ejemplo

� Las hojas serán impresas de un solo lado.

� La notación matemática debe respetarse como lo marcan los estándares.

� Las páginas del texto principal deberán numerarse consecutivamente, así como las ilustraciones y apéndices.

� La página inmediata a la portada debe contener un resumen del documento con no más de 300 palabras.



� El idioma del documento será de acuerdo a la lengua del usuario correspondiente.

� En caso de aplicar, incluir una lista de obras consultadas, las cuales serán referencias o bibliografía, con la información suficiente para poder remitirse a ellas.

� Si el documento es muy extenso, se sugiere que sea encuadernada en dos volúmenes; esto con la finalidad de evitar, que por el número de hojas, el documento se deteriore con mayor facilidad. Aproximadamente 250 hojas por volumen.

� El estilo es uno de los puntos más importantes en la redacción de un documento y uno de los temas más difíciles sobre los cuales se pueden dictar reglas. De esta forma ingeniero de software debe tener en cuenta que la claridad y precisión en las ideas es fundamental para el buen entendimiento y comunicación con los demás.

� Hay que recordar que el documento se califica por la calidad de su contenido y no por cantidad y extensión.

� Existen varios libros sobre técnicas de investigación y metodología, además de los de herramientas propuestas en este documento.

� Redactar en forma impersonal.

� Las abreviaturas deben ser uniformes.

� No inventar nuevas palabras o términos para conceptos ya existentes.

� Hacer un plan de trabajo antes de comenzar a escribir el documento. De esta forma se encontrará el lugar correcto para decir lo que se quiere.

� Discutir sus problemas con personas involucradas en el tema.

� El escrito estará en un solo lado de la hoja, 27-30 renglones por hoja con interlineado a 1 ½.

� El tipo de letra utilizada deberá ser uniforme para todo el texto distinguiendo capítulos, sub-capítulos, etc., de la siguiente manera:

o Para nombres de capítulo se usarán como tamaño definido 18 puntos.

o Para sub-capítulos se utilizará un tamaño de 16 puntos.

o Para las secciones el tamaño de la letra será de 14 puntos.

o Finalmente para el texto el tamaño de letra utilizado será de 12 puntos.

� Utilizar mayúsculas y minúsculas.

� Extensión mínima en cuartillas dependerá del tipo y amplitud del tema del documento, el formato en cada cuartilla tendrá los márgenes superior e inferior 2.5, izquierdo 3.0 cm. y derecho 2.5.



� La numeración de las páginas con números arábigos a partir de la introducción.

� El contenido del documento deberá aparecer dividido en capítulos señalados usando el sistema decimal.

� El empleo de párrafos para dividir el texto es una regla general en la elaboración de escritos, con esto se evitan aglomeraciones, a la vez que es un descanso visual para el lector.

� Hoja Falsa. Esta hoja se inserta al inicio de cada uno de los capítulos del documento y tiene escrito el titulo que antecede, éste se pondrá en la parte media de la hoja (centrado), trátese de la introducción, de cada uno de los capítulos o de los apéndices. A la hoja falsa no se le folia, pero si se cuenta en la numeración total.

� Los encabezados de cada componente se iniciarán cargados al margen izquierdo.

� El primer párrafo de cada capítulo se iniciará respetando el margen superior de 5 cm., en todas las demás hojas el margen será de 2.5 cm., este primer párrafo se iniciará sin sangría, los subsecuentes serán con sangría.

IV. Estándares de la estructura del documento.

Se recomienda que el arreglo físico del documento contenga los siguientes elementos:

� Cubierta y portada

� Resumen

� Contenido o índice

� Lista de figuras, si las hay

� Notación empleada

� Introducción

� Desarrollo, cuerpo principal del texto

� Referencias, bibliografía y citas bibliográficas

� Glosario (opcional)

� Apéndices

� Tablas o ilustraciones, a menos que se incluyas en el texto.

A continuación se describe el contenido de cada uno de los elementos anteriores.



Cubierta y portada

Esta se realiza tanto en la cubierta, como en la portada; la cubierta deberá contener al menos el nombre de la organización a quien se desarrolla el software, logotipos, nombre del documento, participantes, indicar la fecha de elaboración y la identificación del documento y su versión (x.xx), su distribución será de acuerdo a la creatividad y criterio del escritor.

Si por razones de extensión se tienen dos volúmenes, deben anotarse en la cubierta.

Resumen

Es el texto sintético que describe la totalidad del contenido del trabajo escrito, el cual no deberá exceder de 300 palabras o cuatro paginas.

Contenido o índice

En él se señala la distribución temática del documento, de lo general a lo específico, indicando con precisión la página en la que inicia cada apartado, la enumeración de los capítulos y sus partes se hace usando el sistema decimal.

Todas las páginas que antecedan al desarrollo principal aparecerán numeradas en estilo romano.

Lista de figuras

Es una relación de figuras, relacionadas en forma numérica ascendente, indicando su descripción o titulo de la figura, así como el número de página donde se encuentra.

Notación empleada

Cualquier símbolo empleado en el trabajo será listado bajo el encabezado de NOTACIÓN. Esta lista deberá aparecer antes del cuerpo principal del texto.

Introducción.

Constituye la presentación del documento, refiere los antecedentes del mismo, los motivos de su realización, el problema de investigación que se aborda, el objetivo, la hipótesis y así como las partes que componen el capitulado.

Desarrollo, cuerpo principal del texto

A fin de tener uniformidad, se recomienda cumplir con recomendaciones que se establecen a cada tipo de documento discutido en la sección de Documentos de ingeniería de software,



Referencias, bibliografía y citas bibliográficas

Esté apartado es opcional, se agrega por si el documento los requiere, como es el caso de que por el contrato se tenga que identificar los estándares que se ocuparon para el desarrollo del proyecto.

Referencias

El objetivo de las referencias es permitir que el lector pueda:

� Conocer la fuente empleada por el autor

� Conocer el tipo de fuente empleada por el autor

� Buscar la fuente original para revisarla y obtener mayor información

Cualquiera de las siguientes formas para citar referencias es correcto:

1. “este fenómeno fue observado también en el departamento [1]”

2. “este fenómeno fue observado también en el departamento [2]”

3. “este fenómeno fue observado también en el departamento [Smith. 20055]”

En el ejemplo 1, las referencias se arreglan por el número, este corresponde al orden en el cual son referidos en el texto.

En el ejemplo 2, aunque se redacta igual que el ejemplo 1, en este caso, el número corresponde al orden alfabético de los autores en la bibliografía general.

En el ejemplo 3, las referencias no se enumeran, sólo se agrega el apellido del autor y el año de publicación del documento: de esta forma el usuario puede remitirse a las fuentes principales, consultando la bibliografía general.

Cita bibliográfica

Se utiliza cuando se hace referencia textual, la cual se asentará entre comillas, indicada con numeración ascendente continua.

La cita se estructura de la siguiente manera:

El número, el punto, espacio, el nombre de autor empezando por el apellido, el titulo de la obra en negrita, un punto, espacio, y la página o páginas de donde se toma la cita. Como en el ejemplo siguiente:

....”El diseño se ha descrito como un proceso multifase en el que se sintetizan representaciones de la estructura de datos”1..........

..........

.........



1 Pressman. Roger. Ingeniería del software. p.529

Si hay dos citas del mismo autor y la misma obra, con cita intermedia de otro autor, se anota el apellido del autor, luego la abreviatura op. cit., y a continuación la página.

Si se tienen dos citas seguidas del mismo autor, la misma obra, pero diferente página, la segunda cita se asienta como lbid., y la página (s). Si la segunda cita es del mismo autor, misma obra y misma página se utilizará sólo la abreviatura ldem.

A pie de página se asentarán todas las citas tratadas en la cuartilla, es importante señalar la ventaja de la herramienta “nota al pie” de los procesadores de texto, la cual es idónea para este apartado.

Nota. Cualquier nota o aclaración del texto se marcará con asterisco y se explicará a pie de página, antes de las citas.

Bibliografía

Los elementos necesarios para escribir una referencia son los siguientes:

En libros:

APELLIDOS(S), Nombre(s). Título. Número de edición (se anota a partir de la segunda). Lugar de edición: Editorial, año de publicación, número de páginas.

Ejemplo:

SHILIMBERT, Louis J. Boundary layer theory. 4ª ed. New York: Mc Graw Hill, 2005. pag. 547

En reportes

APELLIDO(S), Nombres(s). Título, Fuente, No. De reporte. Organización, año de publicación.

Ejemplo:

WHITCOMB, L.J. Some consideration regarding the aplications of the supersonics area rule to the desing of airplane fuselages. NASA Rm L56E23a. 1996.

En revistas:

APELLIDO(S), Nombre)s). “Título del artículo”. En: Título de la revista. Lugar de publicación. (número – mes- año). Páginas que ocupa el artículo dentro de la revista.

Ejemplo:

KAY, S.E. “The element light.” En: Aicraft engineering. (no. 9 – sept – 1980) Pág. 65-70.



Referencia personal

APELLIDOS(S), Nombre(s). Comunicación personal, fecha.

Ejemplo:

PETERSON, W. Wesley. Comunicación personal, 2 de abril de 1980.

��

AUTOR (si lo hay). Título. Lugar: Quien publica o genera la página, fecha de consulta, dirección en Internet.

Ejemplo:

LÓPEZ REGUERA, Jorge. Redes: contenido, transparencias y animaciones. Chile: Universidad de Concepción. Departamento de ingeniería informática y ciencias de la computación. Curso redes de computadoras. 9 de febrero de 1999.

http://www.inf.udec.cl/~jlópez/REDES/HTML/redes_mag.html

NOTA: En todos los casos de referencia, solamente es el primer autor el que se cita iniciando con su(s) apellido(s), después de este los autores se escriben empezando con su nombre de pila, sin mayúsculas, cuando son más de tres se anota [et. al.].

Es importante mencionar la diferencia entre referencias, bibliografía y citas bibliográficas. Las referencias son cada uno de los trabajos que se citan explícitamente en el texto. La bibliografía es la integración en una lista de todos los materiales relevantes consultados para la elaboración del documento. La cita bibliográfica es la referencia textual a una parte de un escrito de un autor.

Glosario

Es la descripción técnica de todos los términos relevantes empleados y se relacionan en forma alfabética.

Apéndices

Los apéndices proporcionan información más detallada de aspectos particulares presentados en el documento, tales como: pruebas, estadísticas, programas de computadora, etc. Los apéndices se nombran en forma alfabética.

Programas de computadora.

A menos que haya una razón de peso, no se recomienda incluir programas de computadora en el cuerpo principal del trabajo. Es más recomendable asignar un apéndice en el documento, donde se describan brevemente estos programas y la forma en que operan.

Notación matemática



La notación del lenguaje matemático debe usarse correctamente, por ejemplo la expresión:

dy / dx + y / x + fRi / b(1+)2piRi^2W / Q)^2x^2)^0.5(x-y) =0

no es aceptable, debe escribirse de la siguiente manera:

dx y fRi 2πbRi² ² ½ — + — + — 1+ ——— x²(y – x)² (y – x) = 0 dy x b Q

Tablas e ilustraciones

• Cuando se incluyen gráficas la colocación de escalas debe ser tan consistente como sea posible.

• No deben escribirse signos ni puntos sobre los ejes coordinados (si éstos existen).

• Los ejes coordinados de la gráfica ocuparán el tamaño necesario, así como las líneas de la gráfica.

• Se recomienda que el número de la figura que se incluye en título de la gráfica, se escriba en el ángulo inferior izquierdo.

V. Estándares para la actualización del documento.

Conforme el documento evoluciona y refleja los cambios en el sistema, se debe utilizar una forma consistente para indicar los cambios en el documento. Se pueden utilizar distintos colores de la portada para indicar una nueva versión del documento e indicar con un número la versión (x.xx) y cambiar las barras en el margen para indicar párrafos modificados y agregados.

coaching para escribir documentos - … · propuestas de edward de bono “seis sombreros para...

Documents