UPQROO

Cancn, Quintana Roo

ENSAYO ESTANDAR IEEE 10632001

Mantenimiento de Sistemas

Alumno: Jaime Rangel Ojeda

Cuatrimestre: Sptimo Cuatrimestre
Carrera: Ingeniera en Software
Abstract
When we have already made our
software program is necessary to
make user documentation, why?
Because we have to explain how
it works to final users that are
the persons who will use the final
product.
The standard IEEE 1063 is an
effort
to
develop
a
good
documentation for the users, the
structure it is defined and
oriented to an easily understood.
It must have a description for the
purpose
of
the
document,
information on use for the
software,
guidelines,
style
formats, etc.

An aspect to take into account is

to make this document in the
most detailed way possible,
because if the text is ambiguous
or hard to understand the
purpose of the document it
wouldn't accomplish the goals.
Also the structure it must be
followed in a correct form and
follow
the
instructions
for
describe each part correctly, this
structure is like used in normal
books
but
with
special
considerations because is a user
documentation for a specific
software and the structure its
not going to be the same when
we are talking of content.
Finally if we made all the steps in
this document we will have a

useful document for the personal

of a company or organization.

Introduccin
El ingeniero en software debe de
encargarse de todos los aspectos
de documentacin por ello la
documentacin del usuario es
muy importante ya que este
documento es una gua de ayuda
para los usuarios finales al cual
est enfocado el programa. Si
este
documento
es
bien
redactado y se siguen las
recomendaciones y la estructura
del estndar estamos evitando
posibles dudas por parte del
usuario en el uso del software.
Algo que debe quedar claro por
parte del ingeniero en software
hacia el usuario es cul es el
propsito
del
documento,
detallar cada captulo o subtema
para que el usuario comprenda el
alcance del documento.
Documentar los procedimientos,
pasos y operaciones del uso del
software es otra caracterstica
importante ya que al ser una
gua debe ser explicito el
contenido del mismo y lo ms
detallado posible, por ejemplo si
estamos
usando
trminos
desconocidos en el documento
se necesita tener un glosario en
el documento as el usuario
puede comprender a detalle de
lo que habla el documento.

Finalmente se debe tener en el

documento
todos
aquellos
procedimientos donde puedan
ocurrir errores y describir que
significan los mensajes de error.
Ya que como cualquier software
este no es 100% aprueba de
ellos.

Ensayo
Los componentes del estndar
IEEE
1063-2001
son
muy
similares a una estructura de un
libro de texto comn, pero la
diferencia de este es que
estamos detallando procesos
importantes para el correcto uso
del software, por ello el ingeniero
de software debe detallar el
proceso de uso.
Cuenta
con
la
siguiente
estructura
(algunas
son
obligatorias
y
otras
son
opcionales) claro est que el uso
de este estndar no es una
obligacin,
el
ingeniero
en
software debe adaptarlo segn
sus necesidades.

Datos de identificacin
Tabla de contenido
Lista de ilustraciones
Introduccin
Informacin de uso de la
documentacin
Conceptos de operaciones
Procedimientos
Informacin
de
los
comandos del software
Mensajes
de
error
y
resolucin de problemas

Glosario
Fuentes de informacin
relacionadas
Caractersticas
de
navegacin
ndex
Formas de bsqueda

Este estndar hace nfasis en la

estructura, ya que al ser un
documento gua debe estar bien
ordenado y explicado. Pero que
es el IEEE? El instituto de
Ingenieros
Elctricos
y
Electrnicos
(Institute
of
Electrical
and
Electronics
Engineers, IEEE) fue fundado en
1884
en
los
EEUU.
Esta
asociacin tiene como propsito
el fomento de la innovacin
tecnolgica. Entre sus tareas se
encuentra la regularizacin de
diferentes tecnologas mediante
la
creacin
de
normas
y
estndares. (Julio Barbancho
Concejero, 2014,p.54)1.
La estructura del documento
debe dividirse en captulos,
subdivididos en temas a su vez
subdivididos en subtemas para
cada
pgina.
Por
ello
se
recomienda que en documentos
electrnicos contenga formas de
navegacin como hipervnculos
para mayor accesibilidad por
parte del usuario.
1

Julio Barbancho Concejero, J.

B. (2014). Redes Locales.
Madrid, Espaa: Parainfo.

Contener una introduccin donde

se defina principalmente cual es
el propsito del documento y los
alcances del mismo.
La
informacin
debe
ser
comprensible para cada captulo,
contener
referencias
e
informacin precisa y lo ms
detallada posible. Adems esta
informacin debe ser clasificada
con ttulos y etiquetas que
resalten a que pertenece dicha
informacin.
El documento debe contener
informacin general como lo es
la instalacin de dicho producto
de
software
que
se
est
documentando y los diferentes
procesos que se pueden realizar
con el software. Especificar
cules son los comandos del
software como los atajos del
teclado.
La informacin principal son los
procedimientos y orientacin de
la interfaz grfica de usuario, ya
que aqu se detalla el uso del
software y cules son los pasos a
seguir en cada seccin.
Finalmente Se deben especificar
cules son los mensajes de error
y como resolverlos. Aqu es
posible que se use terminologa
de la ingeniera en software es
por
ello
que
el
estndar
especifica incluir un glosario.

Conclusiones

La correcta redaccin de la
documentacin del usuario es
sumamente importante ya que
funciona
como
una
gua
permanente para el uso y
referencias futuras de ayuda del
software.
Siguiendo una estructura formal
como la de un libro de texto
comn pero haciendo nfasis en
la
estructura
y
correcta
redaccin del texto para ser lo
ms legible y entendible para el
usuario.
Podemos decir que el objetivo de
documentar
el
software
es

especificar el proceso de uso,

excepciones
y
errores
del
software.

Bibliografa
Julio Barbancho Concejero, J. B.
(2014). Redes Locales.
Madrid, Espaa: Parainfo.
Society, I. C. (2001). IEEE Standar
for Software User
Documentation. New York,
USA: Software Engineering
Standars Committee of the
IEEE Computer Society.