Está en la página 1de 50

COACHING

PARA
ESCRIBIR
DOCUMENTOS
de la ingeniera de software


Presentan
MSI. Edna Martha Miranda Chvez.
MCC. Sergio Fuenlabrada Velzquez.
Ing. Mario Alberto Sesma Martnez
Noviembre 2006
Edna Martha Miranda Chvez, Sergio Fuenlabrada Velzquez, Mario Alberto Sesma Martnez
COACHING PARA ESCRIBIR DOCUMENTOS 2
Contenido
Introduccin.__________________________________________________________ 1
Captulo I. Qu es el Coaching para escribir documentos _______________________ 2
1.1. Cmo hacer un auto-coaching. ______________________________________ 3
1.2. Metodologa del coaching. __________________________________________ 4
Captulo II. Herramientas de apoyo a la percepcin. ___________________________ 6
2.1. Hbitos 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
Captulo III. Herramientas para el manejo de Informacin ______________________ 14
3.1. Reglas para escribir documentos. ___________________________________ 14
3.2. Escriba slo lo importante._________________________________________ 14
Captulo IV. Documentos de la Ingeniera de Software ________________________ 19
Captulo 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 enva___________________ 24
5.1.3. Meta-preguntas de formato y estructura del documento. ______________ 26
5.1.4. Meta-preguntas para documentos tcnicos ________________________ 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 diseo. ____________________ 30
5.1.4.4.- Meta-preguntas para documentar el desarrollo. _________________ 31
5.1.4.5.- Meta-preguntas para documentar las pruebas. __________________ 33
Bibliografa. _________________________________________________________ 35
Anexos _____________________________________________________________ 37
Lineamientos para la presentacin de documentos ___________________________ 38
Edna Martha Miranda Chvez, Sergio Fuenlabrada Velzquez, Mario Alberto Sesma Martnez
COACHING PARA ESCRIBIR DOCUMENTOS 3
I. Prefacio _________________________________________________________ 38
II. Estndares para la identificacin del documento._________________________ 38
III. Estndares para la presentacin de documentos ________________________ 38
IV. Estndares de la estructura del documento. ____________________________ 40
Cubierta y portada_________________________________________________ 41
Resumen________________________________________________________ 41
Contenido o ndice ________________________________________________ 41
Lista de figuras ___________________________________________________ 41
Notacin empleada ________________________________________________ 41
Introduccin. _____________________________________________________ 41
Desarrollo, cuerpo principal del texto __________________________________ 41
Referencias, bibliografa y citas bibliogrficas____________________________ 42
Referencias ____________________________________________________ 42
Cita bibliogrfica __________________________________________________ 42
Bibliografa ______________________________________________________ 43
Glosario_________________________________________________________ 44
Apndices _______________________________________________________ 44
Tablas e ilustraciones ______________________________________________ 45
V. Estndares para la actualizacin del documento. ________________________ 45

Edna Martha Miranda Chvez, Sergio Fuenlabrada Velzquez, Mario Alberto Sesma Martnez
COACHING PARA ESCRIBIR DOCUMENTOS 4
Figuras
Figura 1 Mapa mental _________________________________________________ 12
Figura 2 Tipos de documentos producidos para apoyar a los usuarios. ___________ 20
Figura 3 Proceso de produccin de un documento. ___________________________ 23

Edna Martha Miranda Chvez, Sergio Fuenlabrada Velzquez, Mario Alberto Sesma Martnez
COACHING PARA ESCRIBIR DOCUMENTOS 5
Tabla
Tabla 1 Funcin de los sombreros _________________________________________ 7



Introduccin.
Coaching es una relacin 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 especficamente a quienes tienen
necesidad de escribir documentos tcnicos en el rea de
ingeniera de software, ya sea en el entorno escolar o profesional,
mostrndose la metodologa de coaching para lograr escribir ms
rpidamente mejores documentos tcnicos.
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
percepcin 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 tcnico en el
que se deber ubicar, sin omitir las herramientas para el manejo
de la informacin -reglas para escribir documentos - y consejos
de escriba slo lo importante- que permiten acceder
rpidamente a la accin de escribir.
En seguida se establece la metodologa del coaching la cual se
apoya principalmente en la formulacin de Meta-preguntas que al
ser contestadas orientan al escritor acerca de que escribir.
Tenindose como marco de aplicacin la necesidad de escribir
documentos tcnicos en el rea de software.
Edna Martha Miranda Chvez, Sergio Fuenlabrada Velzquez, Mario Alberto Sesma
Martnez
COACHING PARA ESCRIBIR DOCUMENTOS 2
Captulo 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 bsicamente en una relacin 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, bsicamente 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
interseccin. Cmo el propsito del presente documento es apoyar a los
escritores a realizar documentos, nicamente se enuncian los distintos
coaching segn los establecen Bulat [BULAT, 2006] y OConnor [OCONNOR,
2005] los cuales son:
Coaching personal.
Coaching ejecutivo.
Coaching empresarial.
El directivo como coach.
Coaching para la profesin.
Coaching deportivo o de equipos.
Coaching literario.
Auto coaching.
El coaching para escribir documentos es una adaptacin de la metodologa
de coaching [BULAT, 2006] aplicada a la actividad de escribir, el propsito del
presente trabajo es:

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

Hay que hacer una aclaracin, el coaching para escribir documentos no es un
proceso de edicin, aunque pueda incluir algunas de sus actividades, ya que
casi siempre se harn trabajos de formateo y correccin. 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
Edna Martha Miranda Chvez, Sergio Fuenlabrada Velzquez, Mario Alberto Sesma
Martnez
COACHING PARA ESCRIBIR DOCUMENTOS 3
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 transmisin 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
misin consiste en corregir y adaptar el documento para que tenga un
formato estndar de acuerdo a lo establecido.
1.1. Cmo hacer un auto-coaching.
El coaching para escribir documentos pretende ser prctico y no terico, lo
que implica una contradiccin terminolgica; si el coaching requiere como
mnimo un coach y un coachee, e implica una actividad dinmica de
intercambio entre ambos, entonces se puede hacer auto-coaching?
La respuesta tcnica es NO, pero hay que recordar el propsito que persigue
este trabajo, es que el lector-escritor pueda plantearse muchas de las
preguntas que le hara 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 fcil, pero si el lector aplica los
objetivos y metodologa de coaching que se proponen, podr escribir un
documento tcnico.
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 propsito original.
Se ha observado que a la mayora de las personas tcnicas 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
clarsima, pero el lector interpreta otra cosa. Dostoievski llamaba a
esto la tortura de que la palabra no siga al pensamiento.
Edna Martha Miranda Chvez, Sergio Fuenlabrada Velzquez, Mario Alberto Sesma
Martnez
COACHING PARA ESCRIBIR DOCUMENTOS 4
Lo que se busca con el coaching literario es que a travs de una metodologa
determinada, disminuir la aparicin de estas leyes, y as el escritor obtenga
mejores resultados. Esta metodologa se puede aplicar a todo el documento o
en aquellas partes que el escritor crea convenientes.
1.2. Metodologa del coaching.
Debido a que el coaching depende del contexto, problemtica y personalidad
del coach y del coachee, no se trata de una disciplina rgida 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 percepcin: Esta se da en dos aspectos:
o Que el escritor conozca sus fortalezas y debilidades y cmo
puede hacer uso de ellas para escribir.
o Y las herramientas
1
que le permiten percibir la realidad, que
incluye la evaluacin de cuales son los verdaderos intereses del
autor y de sus lectores (usuarios
2
).
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 accin: Se lleva a la prctica el compromiso adquirido y se
comienza a escribir y corregir.
En la seccin de Herramientas de apoyo a la percepcin se presentan las
propuestas de Edward de Bono Seis sombreros para pensar y la de Tony
Buzan Mapas mentales, para conseguir una mejor percepcin de la realidad.
En la seccin de Documentos de la ingeniera de software, se presentan los
distintos documentos que se requieren en la ingeniera de software, que
ayudan a la definicin del los objetivos. En la seccin Herramientas para el
manejo de informacin se presentan las propuestas de Maureen Malanchuk
las reglas para escribir documentos y la de Marie-Jose Couchare escriba
slo lo importante, que ayudan a la accin.
Lo ms 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 [OCONNOR, 2005], usando
preguntas directas e indirectas, as como la empata y la parfrasis,

1
En este documento slo se utilizan las herramientas de pensamiento propuestas por Edward D Bono y Tony Buzan.
2
Son aquellas personas que usaran el documento tcnico que elabore el escritor.
Edna Martha Miranda Chvez, Sergio Fuenlabrada Velzquez, Mario Alberto Sesma
Martnez
COACHING PARA ESCRIBIR DOCUMENTOS 5
con la finalidad que la persona entrenada descubra su verdadera
solucin.
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 dems.
Descubran lo que realmente es importante para ellos, es decir su
dominio personal [SENGER, 1995].
Elaborar los compromisos de accin.
El entrenado para ser lector-escritor, requiere ciertas caractersticas como la
organizacin, empeo, 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 imgenes, supuestos e historias
que llevamos en la mente acerca de nosotros, los dems, las instituciones y
todos los aspectos del mundo. Como unos lentes sin la graduacin correcta,
que distorsionan sutilmente la visin, los modelos mentales determinan lo que
se ve y hace. El problema radica en que los modelos mentales suelen ser
tcitos y existen por debajo del nivel de conciencia, en la seccin de
Coaching para escribir documentos en las Meta-preguntas para romper los
modelos mentales, se establece una posible reflexin para romper los
modelos mentales.
En algunas ocasiones el lector-escritor podr ser auxiliado por personas de
su confianza para que evalen las cosas que escriban. Estas personas
debern ser conminadas a realizar crticas concretas y detalladas que ayuden
a mejorar el texto. Como en este caso la propuesta es para escribir
documentos tcnicos, estas personas pueden ser parte del equipo de trabajo
o algn usuario, que responda un cuestionario despus de leer el documento.

Edna Martha Miranda Chvez, Sergio Fuenlabrada Velzquez, Mario Alberto Sesma
Martnez
COACHING PARA ESCRIBIR DOCUMENTOS 6
Captulo II. Herramientas de apoyo a la percepcin.
La manera en que se realiza el pensamiento debido a nuestra herencia
Aristotlica, generalmente es argumentativo y con una dialctica 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 travs 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 cartogrfico.
El anlisis implica tener una VISIN completa del sistema global al que
pertenece el elemento (subsistema) que se pretende comprender e identificar
la configuracin de las interrelaciones entre los componentes claves del
subsistema.
Debido a la poca claridad que los sistemas suaves
3
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
tcnica de los seis sombreros para pensar, como una herramienta para de
realizar el pensamiento lateral, que se auxilia de los mapas mentales para
hacer cartogrfico el pensamiento.
2.1. Hbitos de pensamiento
El propsito de los seis sombreros para pensar [BONO, 1991], es desarrollar
el pensamiento, de modo que el pensador pueda utilizar un modo de pensar
despus de otro, en lugar de hacer todo al mismo tiempo o intentarlo. La
mejor analoga es la impresin a todo color. Se imprime cada color por
separado y al final se renen todos y se ve el conjunto.
El mtodo de los seis sombreros para pensar est diseado para sacar
al pensamiento del estilo argumentativo habitual y llevarlo a un estilo
cartogrfico. 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
analoga de la impresin 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 metodologa 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.
Edna Martha Miranda Chvez, Sergio Fuenlabrada Velzquez, Mario Alberto Sesma
Martnez
COACHING PARA ESCRIBIR DOCUMENTOS 7
El mayor valor de los sombreros es su misma artificialidad. Brindan una
formalidad y una convencin para requerir cierto tipo de pensamiento tanto
de nosotros mismo como los dems. Fijan las reglas del juego del
pensamiento. Cualquiera que lo juegue debe conocer estas reglas.
Cuanto ms se utilicen los sombreros, ms se integrarn a la cultura del
pensamiento. Todos los miembros de una organizacin deberan aprender el
lenguaje bsico de modo que se pueda incorporar a la cultura organizacional.
Enfocar el pensamiento resulta mucho ms potente. En lugar de perder
tiempo en discusiones y razonamientos sin rumbo, se contar con un
planteamiento enrgico y disciplinado.
Al principio, es posible que la gente se sienta un poco incmoda con el uso
de los sombreros, pero esta incomodidad desaparece apenas la conveniencia
del sistema resulta evidente. La primera utilizacin 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 estancaran en un
modo nico (generalmente el negro).
La tabla 1 [BONO, 1991, pp 42-44] muestra en forma resumida la funcin de
cada sombrero:
Sombrero Funcin
Blanco
Blanco, hechos puros, nmeros e
informacin.
Rojo
Ver rojo, emociones y sentimientos,
tambin presentimientos e intuicin.
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, provocacin.
Azul
Moderacin y control, director de orquesta, pensar en
el pensamiento.
Tabla 1 Funcin de los sombreros
Mientras ms personas aprendan el lenguaje que se siguiere con el color de
los sombreros, ms til resultar en cualquier organizacin. La verdad es que
no contamos con un lenguaje sencillo como sistema de control del
pensamiento.
Edna Martha Miranda Chvez, Sergio Fuenlabrada Velzquez, Mario Alberto Sesma
Martnez
COACHING PARA ESCRIBIR DOCUMENTOS 8
Si nos sentimos tan inteligentes que creemos poder prescindir de ste
sistema, podramos tener en cuenta que hara dicho sistema con esa
inteligencia, de la que tanto nos jactamos, fuera an ms eficaz. Una persona
con talento natural para correr se beneficia ms 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 debera imitar la computadora.
La persona que pide informacin debe enmarcar y precisar las preguntas a
fin de obtener informacin o para completar vacos de la informacin
existente.
En la prctica existe un sistema doble de informacin. El primer nivel contiene
hechos verificados y probados, hechos de primera clase. El segundo, hechos
que se cree que son verdaderos, pero que todava no han sido totalmente
verificados, hechos de segunda clase.
La credibilidad vara 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 informacin 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 direccin. El
pensador se esfuerza por ser ms neutral y ms objetivo al presentar la
informacin. Te pueden pedir que te pongas el sombrero blanco o puedes
pedirle a otro que lo haga. Se puede optar por usarlo o por quitrselo.
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 tambin del sistema de valores que elige la ruta en el
mapa.
El sombrero provee al pensador de un mtodo 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
dems cuando les solicita un punto de vista de sombrero rojo.
Edna Martha Miranda Chvez, Sergio Fuenlabrada Velzquez, Mario Alberto Sesma
Martnez
COACHING PARA ESCRIBIR DOCUMENTOS 9
Cuando un pensador est usando el sombrero rojo, nunca debera hacer el
intento de justificar los sentimientos o de basarlos en la lgica.
El sombrero rojo cubre dos amplios tipos de sentimiento. En primer lugar, las
emociones comunes, que varan desde las fuertes, tales como miedo y
disgusto, hasta las ms sutiles como la sospecha. En segundo lugar, los
juicios complejos, clasificables en tipos tales como presentimientos,
intuiciones, sensaciones, preferencias, sentimientos estticos y otros tipos no
justificables de modo perceptible. Cuando una opinin consta en gran medida
de este tipo de sentimientos, tambin se la puede encajar bajo el sombrero
rojo.
2.1.3. Pensamiento de sombrero negro
El pensar de sombrero negro se ocupa especficamente del juicio negativo. El
pensador de sombrero negro seala lo que est mal, lo incorrecto y errneo.
El pensador de sombrero negro seala por qu algo no va a funcionar. El
pensador de sombrero negro seala los riesgos y peligros. El pensador de
sombrero negro seala las imperfecciones de un diseo.
El pensamiento de sombrero negro no es argumentacin y nunca se lo
debera considerar tal. Es un intento objetivo de poner en el mapa los
elementos negativos.
El pensamiento de sombrero negro puede sealar los errores en el proceso
del pensamiento y en el mtodo 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 podra fracasar o ir mal.
El pensamiento de sombrero negro puede hacer preguntas negativas.
El pensamiento de sombrero negro no debera utilizarse para encubrir
complacencia negativa o sentimientos negativos, los que deberan 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 evaluacin positiva del
mismo modo que el pensamiento de sombrero negro se ocupa de la
evaluacin negativa.
El pensamiento de sombrero amarillo abarca un espectro positivo que va
desde el aspecto lgico y prctico hasta los sueos, visiones y esperanzas.
Edna Martha Miranda Chvez, Sergio Fuenlabrada Velzquez, Mario Alberto Sesma
Martnez
COACHING PARA ESCRIBIR DOCUMENTOS 10
El pensamiento de sombrero amarillo indaga y explora en busca de valor y
beneficio. Despus procura encontrar respaldo lgico 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, adems, visiones y sueos.
El pensamiento de sombrero amarillo no se ocupa de la mera euforia positiva
(sombrero rojo) ni tampoco, directamente, de la creacin 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 deberan usar sombreros
verdes.
El color verde es smbolo de la fertilidad, el crecimiento y el valor de las
semillas.
La bsqueda de alternativas es un aspecto fundamental del pensamiento de
sombrero verde. Hace falta ir ms 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 provocacin 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 mtodo de la palabra al azar.
El pensamiento lateral es una serie de actitudes, lenguajes y tcnicas (que
incluyen movimiento, provocacin y op) para saltar de pautas en un sistema
autorganizado de pautas asimtricas. Se utiliza para generar conceptos y
percepciones.
Edna Martha Miranda Chvez, Sergio Fuenlabrada Velzquez, Mario Alberto Sesma
Martnez
COACHING PARA ESCRIBIR DOCUMENTOS 11
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
discusin e insiste en el pensamiento cartogrfico. 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. Tambin puede utilizarse para establecer
una secuencia gradual de operaciones de pensamiento que deben respetarse
tal como una danza respeta la coreografa.
An cuando se asigne a una persona el rol especfico 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 grfica las ideas que se
tienen sobre algn tpico en particular. Los mapas mentales contienen
palabras claves, smbolos y figuras conectadas por lneas, que permiten a
travs de la forma, el color y el contenido, que las personas que lo usen, lo
recuerden y lo analicen, al indicar de forma explcita 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 rplica de la forma
natural de pensar.
Edna Martha Miranda Chvez, Sergio Fuenlabrada Velzquez, Mario Alberto Sesma
Martnez
COACHING PARA ESCRIBIR DOCUMENTOS 12

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, slo hay que aadir
grosor en la lnea.
4. Elegir nicamente palabras o imgenes claves.
5. Usar imgenes lo ms posible.
6. Agregar smbolos, 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 generacin 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 accin; el segundo organiza las ideas
Edna Martha Miranda Chvez, Sergio Fuenlabrada Velzquez, Mario Alberto Sesma
Martnez
COACHING PARA ESCRIBIR DOCUMENTOS 13
propias o ajenas, al partir de cualquier clase de conocimientos o experiencias
previas, para transformarlos en una rplica con estructura funcional.
Cuando se utiliza el pensamiento lateral una forma cartogrfica de
representarlos es a travs de los mapas mentales.
Edna Martha Miranda Chvez, Sergio Fuenlabrada Velzquez, Mario Alberto Sesma
Martnez
COACHING PARA ESCRIBIR DOCUMENTOS 14
Captulo III. Herramientas para el manejo de
Informacin
3.1. Reglas para escribir documentos.
En palabras de Bill Gates que el dueo del mundo es el dueo de la
informacin y en otras opiniones semejantes de otros personajes, as como
la facilidad que da Internet para publicar, han generado que la mayora de la
gente busque informacin, la gener, la duplique, la reenve, acumule.
Provocando una marejada de informacin.
En la propuesta de Maureen Malanchuk [MALANCHUK, 1997] establece una
serie de recomendaciones tanto para recibir como para enviar informacin.
Por el propsito de este documento slo se comenta su propuesta sobre el
envo de informacin que resume en siete tcnicas.
1. Seducir: Provoque la atencin de su lector. Garantice lograr el objetivo
de la informacin que enva.
2. Sintetizar: Acopie toda la informacin conveniente a su proyecto,
analcela y explquesela al el destinatario de su documento.
3. Mostrar: Utilice elementos grficos y palabras visuales para transmitir
su mensaje
4
.
4. Clasificar: Establezca una estructura de su documento en un estilo
factible de recibir, y flexible que permita al receptor manejarla de
manera fcil y rpida.
5. Separar: Identifique claramente cual es la informacin crucial de la
catica
5
.
6. Seleccionar: Elija el canal adecuado, ya sea en papel o en lnea,
segn el documento que entrega y el propsito del mismo.
7. Callar: Reconozca cuando haya dicho suficiente o cuando no tenga
nada que decir, y no diga una palabra ms.
3.2. Escriba slo lo importante.
Marie-Jose Couchare [COACHARE, 1990] y Edward de Bono [BONO,
1991] establecen una serie de recomendaciones que ayudan a escribir mejor
y slo 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-Jose Couchare [COACHARE, 1990] de cmo aligerar frases.
5
Se refiere que hay que dividirla en diferentes grados de detalle, para que los destinatarios obtengan lo que
requieren.
Edna Martha Miranda Chvez, Sergio Fuenlabrada Velzquez, Mario Alberto Sesma
Martnez
COACHING PARA ESCRIBIR DOCUMENTOS 15
Escribir es indispensable: La documentacin no slo es slo un
instrumento de comunicacin, tambin es un aspecto esencial en la
sociedad del conocimiento. Establece lo siguiente:
o Los diccionarios y manuales no estn prohibidos.
o Cuando ms se escribe, mejor se habla.
o Siempre hay tiempo para leer un documento breve y bien
escrito que invita a ser ledo.
o Basta ejercitarse para mejorar la ortografa. Pero cuando se
inicia un documento hay que escribir sin cuidar la ortografa,
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 mtodos y puntos de referencia es ms rpido y ms fcil.
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 Frmulas 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 expresin.
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 jams en el medio.
o Utilice palabras simples, cortas, vigentes, concretas y
representativas.
o Depure la expresin.
o Reemplace el pronombre relativo por un adjetivo o un sustantivo.
o Utilice una afirmacin en lugar de una negacin.
o Aplique toda la variedad de signos de puntuacin.
o Utilice las palabras enlace al principio de la oracin.
o Conjugue los verbos en la voz activa.
Edna Martha Miranda Chvez, Sergio Fuenlabrada Velzquez, Mario Alberto Sesma
Martnez
COACHING PARA ESCRIBIR DOCUMENTOS 16
o Elimine las palabras superfluas.
o Suprima las frases intiles.
Adopte un estilo directo: Forzar las situaciones, manejarlas o huir ante
los problemas, son estilos que ya no van con la comunicacin en la
sociedad del conocimiento. Hoy es necesario saber afirmarse,
respetando a los dems.
o Respuesta automtica frente a los problemas.
Describa la situacin.
Exprese su opinin.
Proponga una solucin.
Convenza con un argumento.
o Preguntas claves para saber que decir.
Cules son los hechos?
Qu opinin tengo al respecto?
Por qu hay que hacer algo?
Por qu o qu puede salir mal?
Cules son otros caminos de solucin?
Fase para escribir bien y rpido: Basta con ser metdico para evitar
tergiversar, tachar lo escrito o paralizarse ante la hoja en blanco.
1. Rena 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
descripcin 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 oposicin.
o La adhesin.
o La restriccin.
o La sucesin.
o La alternativa.
o La correlacin.
o La causa.
o La consecuencia.
Edna Martha Miranda Chvez, Sergio Fuenlabrada Velzquez, Mario Alberto Sesma
Martnez
COACHING PARA ESCRIBIR DOCUMENTOS 17
o El resultado.
o La adicin.
Use todos los signos de puntuacin: 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 Atencin con los parntesis.
o Emplee los guiones.
Utilice ttulos convincentes: Deben sugerir al lector el meollo del texto
y orientarlo para una lectura rpida. Consejos para lograr un ttulo
convincente.
o Cada ttulo debe despertar el inters del lector o su curiosidad.
o D un rasgo de actualidad a sus ttulos. El lector esta al acecho
de novedades.
o Atrvase a hacer ttulos largos, si hace falta. Pero para el ttulo
principal del documento busque que no sea de ms de 80
caracteres o 7 palabras.
o Evite los ttulos con juegos de palabras, difciles de entender,
alusiones literarias o de otro tipo.
o Evite los ttulos formulados con una negociacin. Escriba Para
iniciar un proyecto, establezca los requerimientos en lugar de
No inicie un proyecto, sin definir requerimientos.
o Utilice las preguntas con precisin: Dnde est..?, Cmo
hacer para?
o Recurra a los nmeros: La siete razones., Los cuatro
problemas de
o Antes de elegir un ttulo definitivo, realice una lista de ttulos
posibles.
o Si el escrito tiene dos ttulos, el segundo debe complementar y
no reproducir al primero.
o Elija el ttulo al final, despus de haber escrito el texto.
Presentacin del documento: La presentacin del documento debe ser
atractiva, adems de dar la impresin de facilitar la lectura. Hay que
tener en cuenta que sta es la primera relacin del lector con usted.
Su cdigo debe ser evidente y revelador, ya que forma parte de su
mensaje.
Edna Martha Miranda Chvez, Sergio Fuenlabrada Velzquez, Mario Alberto Sesma
Martnez
COACHING PARA ESCRIBIR DOCUMENTOS 18
Estos estndares 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
utilizacin de logotipos y los nombres de la compaa (si aplica), la
utilizacin de color para resaltar la estructura del documento entre
otras recomendaciones. Cada equipo de desarrollo podr establecer
sus propios estndares, pero estos deben abarcar:
o El formato: Defina el que mejor convenga al destino de su
documento.
o La encuadernacin: Piense en su destinatario y en su posicin
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 penltima
pginas.
o La tipografa: Se refiere al tamao y estilo de los caracteres.
o La composicin: Es la distribucin por pgina del texto y las
figuras.
Edna Martha Miranda Chvez, Sergio Fuenlabrada Velzquez, Mario Alberto Sesma
Martnez
COACHING PARA ESCRIBIR DOCUMENTOS 19
Captulo IV. Documentos de la Ingeniera de Software
La planeacin y el control son elementos esenciales de todo software exitoso.
Al desarrollar el software la planeacin se realiza mucho antes de que
comience la programacin. Se necesita tcnicas que nos ayuden a poner los
objetivos en clara para que el software cumpla con lo esperado por el usuario.
Tambin se requieren tcnicas de diseo que ayuden a dividir el esfuerzo de
programacin en mdulos u objetos manejables.
Sin embargo, no es satisfactorio tratar de dejar las cosas simplemente en las
etapas de planeacin. Despus de que los programas estn terminados
deben recibir mantenimiento, y los esfuerzos de mantenimiento tpicamente
sobrepasan el esfuerzo gastado en el diseo y programacin original.
Se documenta el software y los documentos para que estn en un formato
que pueda ser fcilmente 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
documentacin permite que los usuarios, evaluadores del sistema,
administradores del sistema, vean al software y procedimientos sin tener la
necesidad de interactuar con l.
La rotacin de personal de las reas de tecnologa de informacin ha sido
tradicionalmente alta en comparacin 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. Documentacin
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 estn sin documentar o con
muy poca documentacin, 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 tcnicas de documentacin, pero se encuentran todava en uso (sin
documentacin). Muchos otros software han tolerado modificaciones mayores
y menores y parches a travs de los aos, pero su documentacin no ha
sido modificada para que los refleje. Algn software especializado fue
comprado por sus funciones importantes a pesar de la falta de
documentacin 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 documentacin. Algunos ingenieros no documentan
debido a que tienen miedo de hacerlo o sienten que no es un trabajo real.
Adems muchos ingenieros son reticentes de documentar software que no es
propio, tal vez temiendo represalias si incluyen material incorrecto acerca del
software de alguien ms.
Edna Martha Miranda Chvez, Sergio Fuenlabrada Velzquez, Mario Alberto Sesma
Martnez
COACHING PARA ESCRIBIR DOCUMENTOS 20
Los manuales del software proveen informacin ms detallada de la ayuda en
lnea y se disea 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 captulos de
un solo documento, que se entrega con un sistema de software (ver figura 2).
Estos documentos son:
1. Descripcin Funcional: narra brevemente, los servicios que provee el
sistema en trminos de requerimientos funcionales y no funcionales y
las mtricas para su comprobacin 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 instalacin: Indica los detalles de cmo instalar el
software. Describe los discos que se entregan con el sistema, los
archivos que contienen y la configuracin mnima de hardware
requerida. Debe incluir las instrucciones de instalacin y los detalles de
cmo instalar los archivos dependientes de la configuracin.
3. Manual introductorio: Describe el rea problema, las causas que
originan el problema, los requerimientos originales del usuario (si
existen). Una descripcin de la utilizacin normal del sistema.
Describe cmo iniciar y cmo los usuarios finales pueden utilizar los
recursos comunes del software. Se ilustra con muchos ejemplos.
Incluye informacin de cmo recuperarse de los errores y restablecer
el funcionamiento.
Evaluadores
de sistemas
Administradores
del sistemas
Usuarios
novatos
Usuarios
experimentados
Administradores
del sistemas
Ingenieros
de software

Descripcin
funcional

Documento
de instalacin

Manual de
introduccin

Manual de
referencia

Gua del
administrador

Manual del
sistema

Descripcin
de servicios

Cmo instalar
el sistema

Iniciando

Descripcin
de recursos

Operacin y
mantenimiento

Diseo del
sistema
Edna Martha Miranda Chvez, Sergio Fuenlabrada Velzquez, Mario Alberto Sesma
Martnez
COACHING PARA ESCRIBIR DOCUMENTOS 21
4. Manual de referencia: Describe los recursos del software y su
utilizacin, provee una lista de mensajes de error y posibles causas y
describe cmo recuperarse de los errores detectados.
5. Manual del administrador: Se provee en algunos tipos de software.
ste describe los mensajes generados cuando el software interacta
con otros y cmo reaccionar a estos mensajes. Si el sistema de
hardware participa, explica cmo reconocer y reparar los problemas
relacionados con el hardware, cmo conectar los nuevos perifricos,
etctera.
6. Manual del sistema: Describe la especificacin del diseo, aborda
diferentes aspectos del modelo de software utilizando los estndares
de diagramacin establecidos para diseo orientado a estructura o a
objetos segn corresponda, incluye la especificacin de:
a. Diseo 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. Diseo arquitectnico, indica cmo se ha derivado la
arquitectura del programa del modelo de anlisis. Adems, para
representar la jerarqua del mdulo se utilizan grficos de
estructura,
c. Diseo de interfaces internas y externas, de programas y se
describe un diseo detallado de la interfaz hombre-mquina.
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 funcin procedimental
del componente, hasta llegar a su descripcin estructural.
e. Referencia cruzada de requerimientos: Establece que todos los
requerimientos se satisfagan mediante el diseo de software, y
especfica cuales son los componentes crticos para la
implementacin de requisitos determinados.
f. Restricciones de diseo: Tales como limitaciones fsicas de
memoria o la necesidad de una interfaz externa especializada,
podrn 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 informacin relevante, todos
mediante notas especiales o apndices separados.

Edna Martha Miranda Chvez, Sergio Fuenlabrada Velzquez, Mario Alberto Sesma
Martnez
COACHING PARA ESCRIBIR DOCUMENTOS 22
Captulo V. Coaching para escribir documentos
Los estndares de documentacin 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 ms
viables de leer y comprender:
1. Estndares para el proceso de documentacin: stos definen el
proceso a seguir para la produccin del documento.
2. Estndares del documento: En el anexo Lineamientos para la
presentacin de documentos se hace una propuesta de la estructura y
su presentacin.
3. Estndares para el intercambio de documentos: Se busca que todas
las copias electrnicas de los documentos sean compatibles.
Siguiendo la metodologa 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 tambin 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 parmetros gua y utilizando algunas de las herramientas,
consejos y sugerencias que se discutieron anteriormente, as como el
proceso de produccin de un documento que incluye la comprobacin de
calidad, como se muestra en la figura 3.
Los estndares de calidad del proceso de documentos deben ser flexibles y
les debe ser posible ajustarse a todo tipo de documentos. Para los
documentos de comunicacin interna como memorandos, de trabajo, no es
necesario comprobar explcitamente la calidad. Sin embargo si los
documentos sern utilizados para desarrollos posteriores o son documentos
a entregar a los clientes, se debe adoptar el proceso formal de comprobacin
de calidad.
Prepararse para crear un documento, crear un borrador, comprobarlo
aplicando meta-preguntas, y rehacerlo es un proceso iterativo. Este contina
Edna Martha Miranda Chvez, Sergio Fuenlabrada Velzquez, Mario Alberto Sesma
Martnez
COACHING PARA ESCRIBIR DOCUMENTOS 23
hasta que se produce un documento de calidad aceptable. El nivel depender
del tipo de documento y de los lectores potenciales de este.
Los estndares del documento aplicaran a todos los documentos producidos
en el transcurso del desarrollo del software. Los documentos debern tener
un estilo y una apariencia estable. Aunque los estndares del documento se
adecuen a las necesidades de un proyecto en particular, una buena prctica
es que se utilice el mismo estilo en todos los documentos producidos por una
organizacin.


Figura 3 Proceso de produccin de un documento.
5.1. Meta-preguntas
Las preguntas sirven para muchas cosas. Cuando se inicia una sesin el
coach pregunta para recabar informacin 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 seccin 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 reflexin del coachee,
Edna Martha Miranda Chvez, Sergio Fuenlabrada Velzquez, Mario Alberto Sesma
Martnez
COACHING PARA ESCRIBIR DOCUMENTOS 24
al inicio como elemento de reflexin, en los mementos subsecuentes como
elemento de revisin, 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 tcnicas para romper los
modelos mentales, slo se tomara parte de las tcnicas, la escalera de
indiferencia y la columna izquierda que ms se adecuan al propsito de
generar Meta-preguntas que ayuden a romper los modelos mentales.
Cules son los datos observables que respaldan esta afirmacin?
Todos concuerdan con la ndole de los datos?
Puedes hacerme seguir tu razonamiento?
Cmo pasamos de los datos a estos supuestos abstractos?
Qu me ha inducido a pensar y sentir de esta manera?
Cul era mi intencin? Qu pretenda lograr?
Alcanc los resultados que buscaba?
Cmo influyeron mis comentarios sobre las dificultades?
Por qu no dije lo que estaba yo pensando?
Qu supuestos tenia sobre los usuarios?
Cul fue el precio de operar de esta manera? Cules fueron los
frutos?
Qu me impidi actuar de otra manera?
Cmo puedo usar lo que yo pensaba, como recurso para mejorar la
comunicacin?
5.1.2. Meta-preguntas para crear documentos que enva
La copiosidad de la informacin a la que Maureen Malanchuk [MALANCHUK;
1997] se refiere como el infodiluvio, es uno de los desafos ms dominantes
y debilitantes de la vida profesional moderna. Con la idea de que la
informacin es poder, se trata de absorber todo, y como consecuencia
produce un ahogo de informacin en el proceso. Por lo que, cuando se crean
documentos que van a ser ledos 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
envo de informacin.
Nivel de experiencia enviando informacin.
Siempre tienes presente a tus lectores cuando envas informacin?
Edna Martha Miranda Chvez, Sergio Fuenlabrada Velzquez, Mario Alberto Sesma
Martnez
COACHING PARA ESCRIBIR DOCUMENTOS 25
Domino tcnicas poderosas de comunicacin oral y escrita y las
aplicas en todos los medos que utilizas?
Tomas cursos o lees libros para fortalecer tus tcnicas bsicas de
comunicacin y para descubrir nuevos mtodos para el envo de
informacin?
Te esfuerzas para atraer la atencin de tus lectores y para lograr que
tus mensajes destaquen?
Eres un comunicador equilibrado que sabe cmo mostrar, no slo
decir, tu mensaje?
Sabes cmo comunicar informacin dinmica que cambia
constantemente?
Separas la informacin crtica de la que resulta catica para tus
lectores?
Presentas la informacin en formatos rpidos y sencillos de leer?
Eliges los medios ms apropiados para tus lectores y mensajes?
Reconoces cuando has dicho suficiente y no dices ms?
Tcnicas para manejar la informacin de tu documento.
Seducir:
o El documento atraer la atencin de tu lector?
o El mensaje de tu documento llegar hasta el proceso de
clasificacin del lector?
6

o Los ttulos o encabezados son convenientes, especficos,
originales o informativos?
o El documento es atractivo y fcil de leer?
o El documento emplea resmenes ejecutivos, panoramas
generales, sealamiento de puntos importantes, sinopsis,
plantillas y formatos estandarizados?
Sintetizar:
o Haz reunido las observaciones, hechos, cifras, anlisis y
evaluaciones pertinentes?
o Tienes un contexto como marco de referencia que te permita
seleccionar la informacin y datos pertinentes?
o Alguien dentro de la organizacin trabaja en un proyecto
similar?

6
El proceso de clasificacin del lector, es cuando supera las barreras de reopcin, como el estrs, la actitud
defensiva y la resistencia al cambio.
Edna Martha Miranda Chvez, Sergio Fuenlabrada Velzquez, Mario Alberto Sesma
Martnez
COACHING PARA ESCRIBIR DOCUMENTOS 26
Mostrar:
o Lo que vas a escribir se puede expresar con una imagen, un
cuadro o una grfica?
o Hay fotografas que muestren los hechos?
o La imagen no requiere explicacin?
o Las imgenes 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 fcil de leer?
o La informacin del documento se muestra en distintos niveles
de detalle?
o Identifica distintos tipos de lectores del mismo documento?
Separar:
o Identifica la informacin catica del la crucial?
o Identifica la informacin crucial de su documento?
Seleccionar:
o Cul es el tipo de informacin que contiene su documento?
o Cul es el canal ms apropiado para el tipo de lector del
documento?
o Qu accin espera del tu lector una vez lea tu documento?
o Cules la urgencia e importancia de tu documento?
Callar:
o Sabe lo que tiene que decir?
o Ya dijo lo que quiere decir?
o Sus prrafos son cortos y directos?
o Sus ideas no son redundantes?
5.1.3. Meta-preguntas de formato y estructura del documento.
Estructura.
Cules son los hechos?
Qu opinin tengo al respecto?
Por qu hay que hacer algo?
Por qu o qu puede salir mal?
Edna Martha Miranda Chvez, Sergio Fuenlabrada Velzquez, Mario Alberto Sesma
Martnez
COACHING PARA ESCRIBIR DOCUMENTOS 27
Cules son otros caminos de solucin?
Formato.
Cul es el objetivo del documento? Es valido?
Quin es el destinatario del documento?
Qu consecuencias puede tener este documento?
5.1.4. Meta-preguntas para documentos tcnicos
Dependiendo del tipo de documento y contenido se aplicaran antes y
despus 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 diseo.
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 fsico.
Dnde esta el equipamiento que necesita el sistema para funcionar?
Existe una Localizacin o varias?
Existen restricciones ambientales, tales como temperatura, humedad
o interferencia magntica?
Interfaces.
La entrada proviene de uno a ms sistemas?
La salida va a no o ms 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.
Quin usar el sistema?
Habr varios tipos de usuarios?
Cul es el nivel de habilidades de cada usuario?
Qu clase de entrenamiento requerir cada tipo de usuario?
Edna Martha Miranda Chvez, Sergio Fuenlabrada Velzquez, Mario Alberto Sesma
Martnez
COACHING PARA ESCRIBIR DOCUMENTOS 28
Cun fcil le ser a un usuario comprender y utilizar el sistema?
Cun difcil le resultar a un usuario hacer uso indebido del sistema?
Funcionalidad.
Qu har el sistema?
Cundo lo har?
Existen varios modos de operacin?
Cmo y cundo puede combinarse o mejorarse un sistema?
Existen restricciones de la velocidad de ejecucin, tiempo de
respuesta o rendimiento?
Documentacin.
Cunta documentacin se requiere?
Debe estar en lnea, en papel o en ambos?
A qu audiencia est orientado cada tipo de informacin?
Datos.
Cul ser el formato de los datos tanto para la entrada como la
salida?
Cun a menudo sern recibidos o enviados?
Cun exactos deben ser?
Con qu grado de precisin deben hacerse los clculos?
Cuntos datos fluyen a travs del sistema?
Debe retenerse algn dato por algn 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?
Cunto espacio fsico ser ocupado por el sistema?
Cules son los requerimientos de energa, calefaccin o
acondicionamiento de aire?
Existe un cronograma prescrito para el desarrollo?
Existe un lmite 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 informacin?
Cmo se podr aislar los datos de un usuario de los otros?
Edna Martha Miranda Chvez, Sergio Fuenlabrada Velzquez, Mario Alberto Sesma
Martnez
COACHING PARA ESCRIBIR DOCUMENTOS 29
Cmo podrn 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 dao provocado por
agua o el robo?
Cmo se debe actuar en caso de desastre?
Aseguramiento de la calidad.
Cules son los requerimientos para la confiabilidad, disponibilidad,
factibilidad de mantenimiento, seguridad y los restantes atributos de
calidad del software?
Cmo deben demostrarse las caractersticas del sistema a terceros?
Debe el sistema detectar y aislar los defectos?
Cul es el promedio de tiempo prescrito entre fallas?
Existe un tiempo mximo permitido para la recuperacin del sistema
despus de una falla?
Cmo puede el sistema incorporar cambios al diseo?
El mantenimiento corregir meramente los errores, o incluir tambin
el mejoramiento del sistema?
Qu medidas de eficiencia se aplicarn al uso de los recursos y al
tiempo de respuesta?
Cun fcil debe ser mover el sistema de una ubicacin 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 ms rpido posible. Por lo que no existe un modelo de
ciclo de vida de desarrollo rpido, debido a que el modelo ms efectivo
depende del contexto en el que se utilice. Determinados modelos de ciclo de
vida son considerados ms rpidos que otros. Pero cada uno de ellos ser
ms rpido en determinadas situaciones y ms 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 ms conveniente se
debe responder a las siguientes Meta-Preguntas:
Me compenetro con el cliente para la especificacin 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?
Edna Martha Miranda Chvez, Sergio Fuenlabrada Velzquez, Mario Alberto Sesma
Martnez
COACHING PARA ESCRIBIR DOCUMENTOS 30
Es probable que necesite llevar a cabo modificaciones importantes
en la arquitectura a mitad del proyecto?
Cunta fiabilidad necesito?
Cunto tiempo extra necesito para planificar y disear durante el
proyecto para las versiones futuras?
Cuntos riesgos conlleva el proyecto?
Estoy sometido a una planificacin 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?
Cunta sofisticacin necesito para utilizar el modelo de ciclo de vida
con xito?
5.1.4.3.- Meta-preguntas para documentar el diseo.
Uno de los productos ms importantes del proceso de diseo es un conjunto
de documentos que describen el sistema a ser construido. Como se ha visto,
una parte de esta documentacin esta dirigida a clientes y usuarios, en
lenguaje natural, para describirles qu es lo que el sistema har; una
segunda parte usa terminologa tcnica 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 diseo es una solucin al problema?
El diseo es modular, bien estructurado y fcil de comprender?
Puede hacerse algo para mejorar la estructura y la comprensin del
sistema?
El diseo es transportable a otras plataformas?
Es reutilizable?
Es fcil 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 transicin entre etapas sea
fcil?
Edna Martha Miranda Chvez, Sergio Fuenlabrada Velzquez, Mario Alberto Sesma
Martnez
COACHING PARA ESCRIBIR DOCUMENTOS 31
El diseo esta bien documentado e incluye las opciones de diseo y
una justificacin racional?
El diseo hace referencia cruzada de componentes y datos con los
requerimientos?
Utiliza las tcnicas apropiadas para el tratamiento de defectos y la
prevencin de fallas?
Contiene mens y otros formatos de presentaciones en pantalla?
Describe las interfaces hombre-mquina; teclas de funcin;
descripcin 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, cmo se les da
formato y el medio en que son almacenados?
Salida: Identifica dnde se envan los datos, cmo se les da formato
y el medio en que son almacenados?
Describe las caractersticas 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 cdigo, 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 decisin
son difciles de comprender o que las ramificaciones incondicionales resultan
difciles de suprimir, puede ser oportuno volver sobre el diseo. Reexaminar
el diseo para determinar si los problemas que aparecen son inherentes al
diseo o tienen que ver con la traduccin a cdigo. Volver a mirar la forma en
que los datos estn representados y estructurados, los algoritmos elegidos y
la descomposicin adoptada. Las siguientes Meta-Preguntas puede ayudar a
resolver estas situaciones.
Generales.
El componente realiza la funcin o proporciona los datos necesarios?
Si se requiere alguna modificacin menor, es menos trabajo la
modificacin que componer el componente desde el principio?
El componente se encuentra bien documentado de modo que se
comprenda sin necesidad de verificar su implementacin lnea por
lnea?
Edna Martha Miranda Chvez, Sergio Fuenlabrada Velzquez, Mario Alberto Sesma
Martnez
COACHING PARA ESCRIBIR DOCUMENTOS 32
Existe un registro completo de la historia de revisin y prueba de los
componentes que garantice que no tiene defectos?
Si son componentes reutilizables.
El componente reutilizable utiliza parmetros y anticipa condiciones
similares a aquellas en que el sistema invocar estos componentes?
Separa dependencias, de forma que las secciones que
probablemente requieran cambios estn aisladas de las que
probablemente se van a conservar idnticas?
La interfaz del componente es general y esta bien definida?
En caso de defectos, Estn corregidos y documentados?
Se describe las estructuras de datos y algoritmos?
Se encuentran separadas las secciones de comunicacin y
manipulacin de error? Estas secciones son fciles de modificar?
Documentacin interna dentro del programa-
Qu denominacin tiene el componente?
Quin ha escrito el componente?
Dnde va ubicado el componente en el diseo general del sistema?
Cundo fue escrito, revisado o modificado?
Por qu existe el componente?
Cmo utiliza sus estructuras de datos algoritmos y control?
Indica el nombre, tipo y propsito de cada una de las principales
estructuras de datos y variables?
Contiene breves descripciones del flujo lgico, algoritmos y
tratamiento de errores?
Indica cuales son las entradas esperadas y las posibles salidas?
Presenta las ayudas para la prueba y cmo usarla?
Enuncia las extensiones o revisiones esperadas?
Los nombres de variables y enunciados, reflejan su utilizacin y
significado?
Documentacin 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?
Edna Martha Miranda Chvez, Sergio Fuenlabrada Velzquez, Mario Alberto Sesma
Martnez
COACHING PARA ESCRIBIR DOCUMENTOS 33
5.1.4.5.- Meta-preguntas para documentar las pruebas.
La documentacin de pruebas permite controlar la complejidad y la dificultad
inherentes a esta etapa de un proyecto, por lo que la documentacin de la
prueba debe responder a las siguientes Meta-Preguntas.
Objetivos de la prueba.
Cmo se har la gestin de prueba?
Qu esfuerzo tcnico se requiere durante la prueba?
Cul es el plan a seguir y su cronograma correspondiente?
Qu requerimientos a la organizacin se requieren para realizar la
prueba?
Cules son los mtodos de prueba?
Cul es la naturaleza y magnitud de cada prueba?
De qu manera la prueba evaluar por completo la funcin y
rendimiento del sistema?
Cules son las entradas de prueba?
Cules son los procedimientos de prueba especficos?
Especificacin de la prueba.
Cules son los requerimientos probados?
Cules son las funciones probadas?
Qu mtodos se seguirn para la realizacin de la prueba?
Qu condiciones previas y durante la prueba deben estar presentes?
Descripcin de la prueba.
Cules son los datos para la prueba?
Cules son los medios de control de la prueba?
Cul es el procedimiento a seguir para la realizacin de la prueba?
Cul 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 ms pequeas, en qu
orden deben ser realizadas?
Informe de anlisis de prueba.
Cules son los resultados esperados de la prueba?
Si se produce una falla, El informe proporciona la informacin que se
necesita para reproducirla se es necesario?
Edna Martha Miranda Chvez, Sergio Fuenlabrada Velzquez, Mario Alberto Sesma
Martnez
COACHING PARA ESCRIBIR DOCUMENTOS 34
Si se produce una falla, El informe proporciona la informacin que se
necesita para localizar y arreglar el origen del problema?
Cules son los elementos que establecen la confianza en el
rendimiento del software?

Edna Martha Miranda Chvez, Sergio Fuenlabrada Velzquez, Mario Alberto Sesma
Martnez
COACHING PARA ESCRIBIR DOCUMENTOS 35
Bibliografa.
[BONO, 1991] Edward de Bono, Seis sombreros para pensar, Una gua de
pensamiento para gente de accin, Editorial Granica Vergara.
Argentina, pginas 222, ISBN. 950-641-061-5, 1991:
[BONO, 1997] Edward de Bono, Aprender a pensar por ti mismo, Editorial
Paidos. Mxico, pginas 214, ISBN.968-853-358-0, 1997:
[BULAT, 2006] Sergio Bulat, Coaching para escribir, Editorial Paidos, Espaa,
pginas 143, ISBN. 84-493-1879-3, ao 2006.
[BUZAN; 1996] Tony Buzan, El libro de los mapas mentales, cmo utilizar al
mximo las capacidades de la mente, Editorial Urano, Espaa,
pginas 350, ISBN. 84-7953-146-0, 1996.
[CHECKLAND, 1993] Peter Checkland, Pensamiento de sistemas, prctica de
sistemas, Editorial John Wiley & Son/Noriega Editores, Mxico,
pginas 367, ISBN. 968-18-4525-0, 1993.
[CHECKLAND, 1994] Peter Checkland, et al, La metodologa de los sistemas suaves
de accin, Editorial John Wiley & Son/Noriega Editores, Mxico,
pginas, ISBN. , 1994.
[COUCHAERE, 1997] Mara-Jose Couchare, Escriba mejor, y slo lo importante,
Editorial Granica, Espaa, pginas 18, ISBN. 84-7577-540-3, ao
1997.
[KENDAL, 1997] Kenneth E. Kendall, et al. Anlisis y diseo de sistemas,
Editorial Prentice Hall, Mxico, pginas 913, ISBN. 968-880-694-
3. 1997.
[LAWRENCE, 2002] Shari Lawerence Pfleeger, Ingeniera de software, teora y
prctica, Editorial Prentice Hall, Brasil, pginas 759, ISBN 987-
9460-71-5, 2005.
[MALANCHUK, 1997] Maureen Malachuk, Informacin, habilidades para organizarla
y mantener el control, Prentice Hall, Mxico, pginas 128, ISBN
968-880-983-7. 1997
[MCCONNELL, 1997] Steve McConnell, Desarrollo y gestin de proyectos
informticos, Editorial Mc Graw Hill, Espaa, pginas 691,
ISBN. 84-481-1229-6, 1997.
[OCONNOR, 2005] Joseph OConnor, et al, Coaching con PNL, Editorial Urano,
Espaa, pginas 268, ISBN. 84-7953-586-5.
[PRESSMAN, 2002] Roger S. Pressman. Ingeniera de software, un enfoque
prctico, Editorial Mc Graw Hill, Espaa, pginas 601, ISBN. 84-
481-3214-9, 2002.
[SENGER, 1992] Peter Senger, La quinta disciplina, el arte y la prctica de la
organizacin abierta al aprendizaje, Editorial Granica Vergara,
Edna Martha Miranda Chvez, Sergio Fuenlabrada Velzquez, Mario Alberto Sesma
Martnez
COACHING PARA ESCRIBIR DOCUMENTOS 36
Argentina, pginas 492, ISBN 950-641-099-2 1992
[SENGER, 1995] Peter Senger, et al. La quinta disciplina en la prctica,
Editorial Granica, Espaa, pginas 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, pginas
498, ISBN 958-04-5494-9, 2000.
[SOMMERVILLE, 2002] Ian Sommerville. Ingeniera de software, Editorial Addison
Wesley, Mxico, pginas 692, ISBN. 970-26-0206-8. 2002
Edna Martha Miranda Chvez, Sergio Fuenlabrada Velzquez, Mario Alberto Sesma
Martnez
COACHING PARA ESCRIBIR DOCUMENTOS 37
Anexos
Edna Martha Miranda Chvez, Sergio Fuenlabrada Velzquez, Mario Alberto Sesma
Martnez
COACHING PARA ESCRIBIR DOCUMENTOS 38
Lineamientos para la presentacin de documentos
I. Prefacio
Con el objetivo de facilitar la elaboracin documentos proporciona los
lineamientos generales para su preparacin y presentacin.
Estos lineamientos se deben tomar en cuenta desde el primer momento en
que se empieza a recopilar la informacin para el trabajo escrito, con el fin
procurar la ms alta calidad.
II. Estndares para la identificacin 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 configuracin. Para documentos que son
distribuidos a un solo cliente el identificador es defino por el administrador del
proyecto.
III. Estndares para la presentacin de documentos
Estos estndares 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 utilizacin de logotipos y los nombres de
la compaa (si aplica), la utilizacin de color para resaltar la estructura del
documento entre otras recomendaciones. Cada equipo de desarrollo podr
establecer sus propios estndares, aqu se sugieren los siguientes:
El titulo del documento, debe ser como mximo de 80 caracteres
incluyendo espacios, o siete palabras sin abreviaturas.
No se admiten copias de diferente calidad: esto quiere decir que la
impresin y presentacin de cada copia debe ser uniforme (tanto en
calidad como en forma).
La encuadernacin deber ser engargolada.
Se respetarn los mrgenes establecidos, vase ejemplo
Las hojas sern impresas de un solo lado.
La notacin matemtica debe respetarse como lo marcan los
estndares.
Las pginas del texto principal debern numerarse consecutivamente,
as como las ilustraciones y apndices.
La pgina inmediata a la portada debe contener un resumen del
documento con no ms de 300 palabras.
Edna Martha Miranda Chvez, Sergio Fuenlabrada Velzquez, Mario Alberto Sesma
Martnez
COACHING PARA ESCRIBIR DOCUMENTOS 39
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
sern referencias o bibliografa, con la informacin suficiente para
poder remitirse a ellas.
Si el documento es muy extenso, se sugiere que sea encuadernada en
dos volmenes; esto con la finalidad de evitar, que por el nmero de
hojas, el documento se deteriore con mayor facilidad.
Aproximadamente 250 hojas por volumen.
El estilo es uno de los puntos ms importantes en la redaccin de un
documento y uno de los temas ms difciles sobre los cuales se
pueden dictar reglas. De esta forma ingeniero de software debe tener
en cuenta que la claridad y precisin en las ideas es fundamental para
el buen entendimiento y comunicacin con los dems.
Hay que recordar que el documento se califica por la calidad de su
contenido y no por cantidad y extensin.
Existen varios libros sobre tcnicas de investigacin y metodologa,
adems de los de herramientas propuestas en este documento.
Redactar en forma impersonal.
Las abreviaturas deben ser uniformes.
No inventar nuevas palabras o trminos 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 captulos, sub-captulos, etc., de la siguiente manera:
o Para nombres de captulo se usarn como tamao definido 18
puntos.
o Para sub-captulos se utilizar un tamao de 16 puntos.
o Para las secciones el tamao de la letra ser de 14 puntos.
o Finalmente para el texto el tamao de letra utilizado ser de 12
puntos.
Utilizar maysculas y minsculas.
Extensin mnima en cuartillas depender del tipo y amplitud del tema
del documento, el formato en cada cuartilla tendr los mrgenes
superior e inferior 2.5, izquierdo 3.0 cm. y derecho 2.5.
Edna Martha Miranda Chvez, Sergio Fuenlabrada Velzquez, Mario Alberto Sesma
Martnez
COACHING PARA ESCRIBIR DOCUMENTOS 40
La numeracin de las pginas con nmeros arbigos a partir de la
introduccin.
El contenido del documento deber aparecer dividido en captulos
sealados usando el sistema decimal.
El empleo de prrafos para dividir el texto es una regla general en la
elaboracin 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 captulos
del documento y tiene escrito el titulo que antecede, ste se pondr en
la parte media de la hoja (centrado), trtese de la introduccin, de
cada uno de los captulos o de los apndices. A la hoja falsa no se le
folia, pero si se cuenta en la numeracin total.
Los encabezados de cada componente se iniciarn cargados al
margen izquierdo.
El primer prrafo de cada captulo se iniciar respetando el margen
superior de 5 cm., en todas las dems hojas el margen ser de 2.5 cm.,
este primer prrafo se iniciar sin sangra, los subsecuentes sern con
sangra.
IV. Estndares de la estructura del documento.
Se recomienda que el arreglo fsico del documento contenga los siguientes
elementos:
Cubierta y portada
Resumen
Contenido o ndice
Lista de figuras, si las hay
Notacin empleada
Introduccin
Desarrollo, cuerpo principal del texto
Referencias, bibliografa y citas bibliogrficas
Glosario (opcional)
Apndices
Tablas o ilustraciones, a menos que se incluyas en el texto.
A continuacin se describe el contenido de cada uno de los elementos
anteriores.
Edna Martha Miranda Chvez, Sergio Fuenlabrada Velzquez, Mario Alberto Sesma
Martnez
COACHING PARA ESCRIBIR DOCUMENTOS 41
Cubierta y portada
Esta se realiza tanto en la cubierta, como en la portada; la cubierta deber
contener al menos el nombre de la organizacin a quien se desarrolla el
software, logotipos, nombre del documento, participantes, indicar la fecha de
elaboracin y la identificacin del documento y su versin (x.xx), su
distribucin ser de acuerdo a la creatividad y criterio del escritor.
Si por razones de extensin se tienen dos volmenes, deben anotarse en la
cubierta.
Resumen
Es el texto sinttico 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 seala la distribucin temtica del documento, de lo general a lo
especfico, indicando con precisin la pgina en la que inicia cada apartado,
la enumeracin de los captulos y sus partes se hace usando el sistema
decimal.
Todas las pginas que antecedan al desarrollo principal aparecern
numeradas en estilo romano.
Lista de figuras
Es una relacin de figuras, relacionadas en forma numrica ascendente,
indicando su descripcin o titulo de la figura, as como el nmero de pgina
donde se encuentra.
Notacin empleada
Cualquier smbolo empleado en el trabajo ser listado bajo el encabezado de
NOTACIN. Esta lista deber aparecer antes del cuerpo principal del texto.
Introduccin.
Constituye la presentacin del documento, refiere los antecedentes del
mismo, los motivos de su realizacin, el problema de investigacin que se
aborda, el objetivo, la hiptesis 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 seccin de
Documentos de ingeniera de software,
Edna Martha Miranda Chvez, Sergio Fuenlabrada Velzquez, Mario Alberto Sesma
Martnez
COACHING PARA ESCRIBIR DOCUMENTOS 42
Referencias, bibliografa y citas bibliogrficas
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 estndares 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 informacin
Cualquiera de las siguientes formas para citar referencias es correcto:
1. este fenmeno fue observado tambin en el departamento [1]
2. este fenmeno fue observado tambin en el departamento [2]
3. este fenmeno fue observado tambin en el departamento [Smith.
20055]
En el ejemplo 1, las referencias se arreglan por el nmero, 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
nmero corresponde al orden alfabtico de los autores en la bibliografa
general.
En el ejemplo 3, las referencias no se enumeran, slo se agrega el apellido
del autor y el ao de publicacin del documento: de esta forma el usuario
puede remitirse a las fuentes principales, consultando la bibliografa general.
Cita bibliogrfica
Se utiliza cuando se hace referencia textual, la cual se asentar entre
comillas, indicada con numeracin ascendente continua.
La cita se estructura de la siguiente manera:
El nmero, el punto, espacio, el nombre de autor empezando
por el apellido, el titulo de la obra en negrita, un punto, espacio,
y la pgina o pginas de donde se toma la cita. Como en el
ejemplo siguiente:

....El diseo se ha descrito como un proceso multifase en el que se
sintetizan representaciones de la estructura de datos
1
..........
..........
.........
Edna Martha Miranda Chvez, Sergio Fuenlabrada Velzquez, Mario Alberto Sesma
Martnez
COACHING PARA ESCRIBIR DOCUMENTOS 43

1
Pressman. Roger. Ingeniera 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
continuacin la pgina.
Si se tienen dos citas seguidas del mismo autor, la misma obra, pero
diferente pgina, la segunda cita se asienta como lbid., y la pgina (s). Si la
segunda cita es del mismo autor, misma obra y misma pgina se utilizar
slo la abreviatura ldem.
A pie de pgina se asentarn todas las citas tratadas en la cuartilla, es
importante sealar la ventaja de la herramienta nota al pie de los
procesadores de texto, la cual es idnea para este apartado.
Nota. Cualquier nota o aclaracin del texto se marcar con asterisco y se
explicar a pie de pgina, antes de las citas.
Bibliografa
Los elementos necesarios para escribir una referencia son los siguientes:
En libros:
APELLIDOS(S), Nombre(s). Ttulo. Nmero de edicin (se anota a partir
de la segunda). Lugar de edicin: Editorial, ao de publicacin, nmero de
pginas.
Ejemplo:
SHILIMBERT, Louis J. Boundary layer theory. 4 ed. New York: Mc
Graw Hill, 2005. pag. 547
En reportes
APELLIDO(S), Nombres(s). Ttulo, Fuente, No. De reporte. Organizacin,
ao de publicacin.
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). Ttulo del artculo. En: Ttulo de la revista.
Lugar de publicacin. (nmero mes- ao). Pginas que ocupa el artculo
dentro de la revista.
Ejemplo:
KAY, S.E. The element light. En: Aicraft engineering. (no. 9 sept
1980) Pg. 65-70.
Edna Martha Miranda Chvez, Sergio Fuenlabrada Velzquez, Mario Alberto Sesma
Martnez
COACHING PARA ESCRIBIR DOCUMENTOS 44
Referencia personal
APELLIDOS(S), Nombre(s). Comunicacin personal, fecha.
Ejemplo:
PETERSON, W. Wesley. Comunicacin personal, 2 de abril de 1980.

AUTOR (si lo hay). Ttulo. Lugar: Quien publica o genera la pgina, fecha
de consulta, direccin en Internet.
Ejemplo:
LPEZ REGUERA, Jorge. Redes: contenido, transparencias y
animaciones. Chile: Universidad de Concepcin. Departamento de
ingeniera informtica y ciencias de la computacin. Curso redes de
computadoras. 9 de febrero de 1999.
http://www.inf.udec.cl/~jlpez/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), despus de este los autores se
escriben empezando con su nombre de pila, sin maysculas, cuando son
ms de tres se anota [et. al.].
Es importante mencionar la diferencia entre referencias, bibliografa y citas
bibliogrficas. Las referencias son cada uno de los trabajos que se citan
explcitamente en el texto. La bibliografa es la integracin en una lista de
todos los materiales relevantes consultados para la elaboracin del
documento. La cita bibliogrfica es la referencia textual a una parte de un
escrito de un autor.
Glosario
Es la descripcin tcnica de todos los trminos relevantes empleados y se
relacionan en forma alfabtica.
Apndices
Los apndices proporcionan informacin ms detallada de aspectos
particulares presentados en el documento, tales como: pruebas, estadsticas,
programas de computadora, etc. Los apndices se nombran en forma
alfabtica.
Programas de computadora.
A menos que haya una razn de peso, no se recomienda incluir programas
de computadora en el cuerpo principal del trabajo. Es ms recomendable
asignar un apndice en el documento, donde se describan brevemente estos
programas y la forma en que operan.
Notacin matemtica
Edna Martha Miranda Chvez, Sergio Fuenlabrada Velzquez, Mario Alberto Sesma
Martnez
COACHING PARA ESCRIBIR DOCUMENTOS 45
La notacin del lenguaje matemtico debe usarse correctamente, por ejemplo
la expresin:
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 2bRi
+ + 1+ x(y x) (y x) = 0
dy x b Q

Tablas e ilustraciones
Cuando se incluyen grficas la colocacin 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 grfica ocuparn el tamao necesario, as
como las lneas de la grfica.
Se recomienda que el nmero de la figura que se incluye en ttulo de la
grfica, se escriba en el ngulo inferior izquierdo.
V. Estndares para la actualizacin 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
versin del documento e indicar con un nmero la versin (x.xx) y cambiar las
barras en el margen para indicar prrafos modificados y agregados.

También podría gustarte