• Author / Uploaded
• Jaime Rangel Ojeda

• Categories
• Ciencia y Tecnología
• Software
• Ingeniería
• Tecnología
• Ciencia

Citation preview

UPQROO Cancún, Quintana Roo

ENSAYO ESTANDAR IEEE 10632001 Mantenimiento de Sistemas

Alumno: Jaime Rangel Ojeda Cuatrimestre: Séptimo Cuatrimestre Carrera: Ingeniería 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 it’s 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.

Introducción El ingeniero en software debe de encargarse de todos los aspectos de documentación por ello la documentación del usuario es muy importante ya que este documento es una guía 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 estándar 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 cuál es el propósito del documento, detallar cada capítulo o subtema para que el usuario comprenda el alcance del documento. Documentar los procedimientos, pasos y operaciones del uso del software es otra característica importante ya que al ser una guía debe ser explicito el contenido del mismo y lo más detallado posible, por ejemplo si estamos usando términos 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 estándar IEEE 1063-2001 son muy similares a una estructura de un libro de texto común, 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 estándar no es una obligación, el ingeniero en software debe adaptarlo según sus necesidades.         

Datos de identificación Tabla de contenido Lista de ilustraciones Introducción Información de uso de la documentación Conceptos de operaciones Procedimientos Información de los comandos del software Mensajes de error y resolución de problemas

    

Glosario Fuentes de información relacionadas Características de navegación Índex Formas de búsqueda

Este estándar hace énfasis en la estructura, ya que al ser un documento guía debe estar bien ordenado y explicado. ¿Pero que es el IEEE? “El instituto de Ingenieros Eléctricos y Electrónicos (Institute of Electrical and Electronics Engineers, IEEE) fue fundado en 1884 en los EEUU. Esta asociación tiene como propósito el fomento de la innovación tecnológica. Entre sus tareas se encuentra la regularización de diferentes tecnologías mediante la creación de normas y estándares”. (Julio Barbancho Concejero, 2014,p.54)1. La estructura del documento debe dividirse en capítulos, subdivididos en temas a su vez subdivididos en subtemas para cada página. Por ello se recomienda que en documentos electrónicos contenga formas de navegación como hipervínculos para mayor accesibilidad por parte del usuario. 1

Julio Barbancho Concejero, J. B. (2014). Redes Locales. Madrid, España: Parainfo.

Contener una introducción donde se defina principalmente cual es el propósito del documento y los alcances del mismo. La información debe ser comprensible para cada capítulo, contener referencias e información precisa y lo más detallada posible. Además esta información debe ser clasificada con títulos y etiquetas que resalten a que pertenece dicha información. El documento debe contener información general como lo es la instalación de dicho producto de software que se está documentando y los diferentes procesos que se pueden realizar con el software. Especificar cuáles son los comandos del software como los atajos del teclado. La información principal son los procedimientos y orientación de la interfaz gráfica de usuario, ya que aquí se detalla el uso del software y cuáles son los pasos a seguir en cada sección. Finalmente Se deben especificar cuáles son los mensajes de error y como resolverlos. Aquí es posible que se use terminología de la ingeniería en software es por ello que el estándar especifica incluir un glosario.

Conclusiones

La correcta redacción de la documentación del usuario es sumamente importante ya que funciona como una guía permanente para el uso y referencias futuras de ayuda del software. Siguiendo una estructura formal como la de un libro de texto común pero haciendo énfasis en la estructura y correcta redacción del texto para ser lo más 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.

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