Aplicar las buenas prácticas profesionales,

UNIDAD VIRTUAL 2 Descripción general de la documentación

Descripción general de la documentación 1. Descripción general de la documentación Según sea la actividad de la organización y el tipo en que se clasifica, se realizan diversos procesos y procedimientos operativos que gobiernan el funcionamiento empresarial. La documentación es la forma principal de comunicar estos procesos y procedimientos a los empleados, clientes, proveedores, etc.

Los objetivos de la documentación en una entidad u organización suelen ser: a) Comunicación de una información. b) Evidencia de la conformidad. c) Compartir conocimientos.

En ISO 9000:2005 se tiene la definición de documento, dice que un documento es la información y su medio de soporte. De acuerdo con ISO9001, los documentos los podemos encontrar en cualquier formato o soporte, como, por ejemplo: 

En papel.



Soporte electrónico.



En una fotografía.



En una muestra patrón.

1

Aplicar las buenas prácticas profesionales,

En el caso de un profesional de tecnologías de la información, debe tener presente que, entre los propósitos de la documentación para el departamento de TI, se incluyen los siguientes:

Describir

Estandarizar

Establecer

Reducir

Cumplir

Capacitar

Productos, software, hardware

Procedimientos y practicas

Reglas y restricciones

Confusión y errores

Regulaciones y leyes

Nuevos empleados o clientes

Proporcionar descripciones detalladas sobre cómo funcionan los productos, el software y el hardware mediante el uso de todo tipo de herramienta como, por ejemplo, diagramas, descriptores técnicos, páginas de manuales y artículos de base de conocimientos. Estandarizar los procedimientos y prácticas para que puedan repetirse con precisión en el futuro. La estandarización, también es conocida como normalización, consiste en la adaptación de un determinado proceso, o de muchos procesos, a una serie de normas o reglas de referencia; consideradas como estándar o modelo. Establecer reglas y restricciones sobre el uso de los activos de la organización, incluidas las políticas de uso aceptable de Internet, la red y el equipo. Consiste en desarrollar el marco de actuación apropiado para salvaguardar la información de la organización. Reducir la confusión y los errores, lo que ahorra tiempo y recursos. La indiferencia al efecto dañoso de la mala gestión de archivos y documentos es extremadamente peligrosa. Las pérdidas derivadas de esta negligencia son silenciosas. Existen riesgos financieros para aquellas organizaciones, empresas colectivas e individuales que no poseen y posponen la formulación de estrategias eficientes de gestión de la información y documentación. No conocer los riesgos financieros de esta postura o bien subestimar los errores en la gestión de documentos suele ser catastrófico. Según la investigación de una empresa norteamericana, cada documento almacenado incorrectamente genera, directa e indirectamente, unos 900 quetzales de pérdida. 2

Aplicar las buenas prácticas profesionales,

Cumplir con las regulaciones gubernamentales o del sector. Esto es obedecer las leyes y tener al día, en buen estado y en orden los documentos de la organización, sean digitales o de papel. Capacitar a nuevos empleados o clientes. Al tener un histórico de las actividades y acciones implementadas, se puede proporcionar información relevante al personal de reciente ingreso y a los consumidores.

Mantener la documentación actualizada es tan importante como crearla. Las actualizaciones de las políticas y los procedimientos son inevitables, especialmente en el entorno de cambio constante de la tecnología de la información. Al establecer un plazo estándar para revisar los documentos, los diagramas y las políticas de cumplimiento, se garantiza que la información correcta esté disponible cuando sea necesaria. El lenguaje unificado de modelado o UML, es el lenguaje de modelado de sistemas de software más conocido y utilizado en la actualidad. Es un lenguaje gráfico para visualizar, especificar, construir y documentar un sistema.

1.1 Documentación del departamento de TI Mantener actualizada la documentación es un reto o desafío incluso para los departamentos de tecnología en información que se encuentran muy bien administrados. La documentación de TI puede presentarse en diferentes formas:

a. Diagrama Es un gráfico en el que se simplifica y esquematiza la información sobre un proceso o un sistema. Puede ser simple o complejo, con pocos o muchos elementos. Se trata de un resumen completo, que sirve para conocer e interpretar información de manera simple y visual.

Además de estar respaldado por el Object Management Group, la importancia que reviste UML, es que cada uno de sus Diagramas, dependiendo de la herramienta utilizada para estos fines, permiten documentar un sistema, aplicación o proceso, de forma clara y precisa.

3

Aplicar las buenas prácticas profesionales,

Diagrama Casos de Usos. Son utilizados para acopiar los requisitos de determinado Sistema, que puede incluir influencias externas e internas. Tales requisitos, en su mayoría, son requisitos de Diseño. Por lo tanto, cuando se analiza un sistema para identificar sus funcionalidades, son los Casos de Uso (figuras en forma elípticas) y los Actores (Entidades o Roles)

los

interactúan sistema.

que en

el Los

Diagramas Casos de Usos,

son

considerados en los análisis de alto de nivel de un sistema.

Diagrama Actividades. Se utilizan para describir aspectos Dinámicos de un Sistema. Es básicamente un diagrama de flujo, que representa las secuencias de una actividad a otra. Por ejemplo, la actividad puede ser descrita como una Operación del Sistema. Lo anterior quiere decir que el flujo de control se extrae de una operación a otra. Este flujo puede ser secuencial, ramificado o concurrente. Utiliza todo tipo de controles de flujo mediante el uso de diferentes elementos.

4

Aplicar las buenas prácticas profesionales,

Diagrama Despliegue. Se utiliza para visualizar la topología de los componentes físicos de un sistema, en el que se despliegan los componentes de un software. Estos diagramas se componen de nodos y relaciones. Tales diagramas los utilizan Ingenieros de Sistemas y Analistas de Sistemas. Los propósitos

de

los

diagramas

de

despliegue son: 

Visualizar la Topología de Hardware de un Sistema.



Describir

los

Componentes

de

Hardware que se utilizan para implementar los Componentes del Software. 

Describir Nodos de procesamiento en Tiempo de Ejecución.

Diagrama Objetos. Representa las instancias del proyecto en desarrollo. Refiere un ejemplo de una clase y es utilizado para ilustrar un punto de datos en la aplicación. Los diagramas de objetos (según UML) hacen uso de una notación similar a los diagramas de clases y se utilizan para ilustrar la instancia de una clase en un determinado momento. Pueden ayudar a explicar las Clases y Herencias. En ocasiones se preparan durante el proceso de planificación de clases, para ayudar a las partes interesadas, para quienes los diagramas de clases resultan demasiado abstractos.

5

Aplicar las buenas prácticas profesionales,

Diagrama Secuencias. Incluye módulos o clases que sean parte de una aplicación o programa y las llamadas que se realizan en cada uno de ellos para ejecutar determinada tarea. Los diagramas de secuencia son utilizados para definir las acciones que es posible efectuar en la aplicación. El nivel de detalles a exhibir, ha de ser coherente con lo que se pretenda

ilustrar;

ejemplo:

la

etapa

por de

desarrollo en la que se encuentra un Proyecto. Los detalles de este diagrama dependerán de la etapa en la que se esté trabajando, lo que se quiera comunicar y a quién

se

le

está

comunicando.

Diagrama Colaboración. Hacen uso de los elementos de diagramas de secuencia y/o diagramas de actividades para ilustrar el flujo de la ejecución de una aplicación. Es de mucha utilidad en casos complejos ya que los objetos son exhibidos como iconos. Las flechas representan mensajes que se envían. También se pueden utilizar

esquemas

de

numeración. Sin que importe el tipo de numeración que se utilice, es posible hacer uso del mismo tipo de control, de información,

que

sería

mostrado en un diagrama de secuencias. 6

Aplicar las buenas prácticas profesionales,

Diagrama Componentes. Pretende representar la estructura física del código. Un componente de software corresponde a un aspecto físico en un sistema. Ejemplos de componentes son: Archivos de Data, Tablas, Documentos, etc.

Los contenidos, de

este tipo de Diagramas son: Componentes, fases y relaciones. También es posible que aparezcan otro tipo de símbolos. Los diagramas de componentes son simbolizados, principalmente, por rectángulos que a su vez

contiene

otros

dos

rectángulos

menores

superpuestos, en su lado izquierdo. También debe incluir el nombre del componente.

Diagrama Paquetes. Tienen por misión exhibir cómo están organizados paquetes, perfiles y relaciones. Es útil cuando se desea recopilar clases relacionadas para que se les pueda hacer referencia, de un modo más conciso, si se exhibe una ilustración de nivel superior en la arquitectura de un determinado proyecto. A menudo, se utilizan decenas de diagramas de clases; por lo tanto, los paquetes constituyen una eficiente

forma

de

organizarlos. Son utilizados frecuentemente cuando se quiere mostrar la organización de alto nivel, de un proyecto de aplicaciones. Suelen ser muy útiles cuando lo que se pretende

es

organizar

y

documentar sub-proyectos de carácter re-utilizable.

7

Aplicar las buenas prácticas profesionales,

Diagrama Estados. Identifica los estados y transiciones de un objeto, conforme avanza su ciclo de vida. Exhiben el flujo de control entre estados, cómo se producen cambios entre tales estados. Disponen de un método que permite mostrar el comportamiento de un objeto y documentar cómo éste

responde

eventos,

en

incluidos

determinados estímulos

externos/internos. Cuando se esté planificando la lógica de un objeto de empresa, como pudiera ser el caso en un proceso de facturación, los estados de una factura podrían ser: emitida, cancelada o vencida.

b. Manuales Estos documentos contienen toda la información sobre los recursos utilizados por un proyecto. Explica todo el trabajo que se ha realizado al desarrollarlo, llevando una descripción muy bien detallada sobre las características físicas y técnicas de cada elemento.

Puede descargar un ejemplo de manual de soporte técnico en el siguiente link https://cutt.ly/lOZE1ZY O puede escanear el QR de arriba.

8

Aplicar las buenas prácticas profesionales,

c. Configuraciones. Los objetivos de estos documentos son crear una base de datos donde se identifiquen todos los activos de TI de la organización, brindar información pertinente sobre las configuraciones para apoyar otros procesos, definir una base sólida para la gestión de incidentes, la gestión de problemas y la gestión de cambios, comparar la información almacenada referente a los activos de TI; con la infraestructura y corregir las diferencias. Sin un estándar de configuración documentado establecido, una organización no puede garantizar la seguridad, el rendimiento del servicio o el cumplimiento adecuados sin realizar revisiones manuales que requieren mucho tiempo.

d. Código fuente Es el conjunto de líneas de texto con los pasos que debe seguir la computadora para ejecutar un cargador, como por ejemplo el código fuente de una página web, que está escrito en lenguaje de 9

Aplicar las buenas prácticas profesionales,

marcado HTML o en JavaScript, u otros lenguajes de programación web, y que es posteriormente ejecutado por el navegador web para visualizar dicha página cuando es visitada. Se entiende entonces que es todo texto legible por un ser humano y redactado en un lenguaje de programación determinado. El objetivo del código fuente es crear normas y disposiciones claras para el ordenador y que este sea capaz de traducirlas a su propio lenguaje. De este modo, el texto fuente es la base de los programas y de las páginas web.

En general, la documentación de TI corresponde a una de cuatro categorías generales: 

Políticas



Operaciones



Proyectos



Documentación de usuarios.

10

Aplicar las buenas prácticas profesionales,

1.1.1

Documentos de Políticas

Se refieren a los textos que contienen políticas de uso aceptable que describen cómo se utiliza la tecnología dentro de la organización; políticas de seguridad que describen todos los aspectos de la seguridad de la información, incluidas las políticas de contraseñas y los métodos de respuesta ante incidentes de seguridad; políticas de cumplimiento normativo que describen todas las normativas legales a nivel de gobiernos nacionales, locales y de la industria que se aplican

POLÍTICAS

a la organización; políticas y procedimientos de recuperación tras desastres que proporcionan planes detallados sobre qué se debe hacer para restaurar los servicios en caso de una interrupción. Las regulaciones o leyes, nacionales, departamentales, locales y del sector pueden tener requisitos de documentación más allá de lo que suele estar documentado en los registros de la empresa. Las políticas regulatorias y de cumplimiento a menudo especifican qué datos deben recopilarse y cuánto tiempo se los debe conservar. Algunas de las regulaciones pueden tener implicaciones en los procesos y procedimientos internos de la empresa y requieren que se lleven registros exhaustivos sobre cómo se accede a los datos y cómo se los utiliza. El incumplimiento de las leyes y regulaciones puede acarrear consecuencias graves, como multas, el despido y la cárcel. Es importante saber cómo se aplican las leyes y regulaciones a la organización que pertenece y al trabajo que realiza.

1.1.2

Documentos de Operaciones y planificación

Los documentos de planificación y estrategia de TI detallan los objetivos a corto y largo plazo del departamento, propuestas para futuros proyectos y aprobaciones, presentaciones y minutas o anotaciones de reuniones, presupuestos y registros de compras, administración del inventario que incluye inventario de hardware y software, las licencias y los métodos de administración como el uso de etiquetas de identificación de recursos y códigos de barras.

11

Aplicar las buenas prácticas profesionales,

1.1.3

Documentos del Proyecto

Incluyen las solicitudes de usuarios, de cambios, actualizaciones o nuevos servicios; diseño de software y requisitos funcionales, incluidos los diagramas de flujo y código fuente; diagramas lógicos y físicos de topología de la red,

especificaciones

de

equipos

y

configuraciones de dispositivos; formularios de administración de cambios; formularios de prueba y aceptación del usuario.

1.1.4

Documentación del usuario Estos documentos comprenden las descripciones de características, funciones y funcionamiento del software, el hardware y los servicios proporcionados por el departamento de TI, también incluyen el manual de usuario final para hardware y software, la base de datos de casos de soporte técnico con resoluciones de informes y artículos de la base de datos que permiten la búsqueda y preguntas frecuentes.

Actividad: Observe el siguiente vídeo. Reflexione y comente con sus compañeros los beneficios de una adecuada documentación y el proceso que implica.

https://youtu.be/uxLwxvnG2NY

En Resumen: La documentación del departamento de TI es una parte importantísima que debe conocer el profesional o técnico de tecnologías de la información debido a que permite tener un histórico de procedimientos, técnicas, configuraciones, solicitudes, soluciones y otras actividades realizadas. Esta documentación debe estar clasificada, ordenada y disponible para su consulta

12

Aplicar las buenas prácticas profesionales,

inmediata. Así mismo se actualizará constantemente para incluir nuevos documentos y cumplir con nuevas leyes de gobierno o normas de la empresa.

Para comprobar el aprendizaje de la sesión 1 por favor escanear el siguiente código QR. Debe tener una cámara y una aplicación de escaneo QR para realizarlo. Si no lo posee puede escribir la siguiente dirección en su navegador de internet: https://cutt.ly/ROVZbdu

1. Proceso de control de cambios El control de los cambios en un entorno de TI puede ser difícil. Los cambios pueden ser tan pequeños como reemplazar una impresora, o tan importantes como actualizar todos los servidores empresariales con la versión más reciente del sistema operativo. La mayoría de las empresas y organizaciones más grandes tienen procedimientos de administración de cambios para garantizar que las instalaciones y las actualizaciones se lleven a cabo sin problemas.

13

Aplicar las buenas prácticas profesionales,

Un proceso de control de cambios permite a los gerentes de proyectos enviar solicitudes a las partes interesadas para su revisión, que luego se aprueban o rechazan. Es un proceso importante para ayudar a gestionar grandes proyectos con muchas piezas en movimiento. Cuando se trata de gestionar varios proyectos, las cosas pueden ponerse difíciles. Desde la coordinación de los cronogramas de trabajo hasta el seguimiento de objetivos y resultados. Sin embargo, si existe un proceso de control de cambios, se podrá enviar solicitudes de cambios de proyectos de manera muy sencilla. El proceso de control de cambios es esencial para iniciativas a gran escala en las que los compañeros de equipo de varios departamentos trabajan juntos. Un plan de gestión de cambios consiste en el plan general para coordinar el cambio. Mientras que el control de cambios es un documento formal donde se solicita el cambio.

Un buen proceso de administración de cambios puede evitar que el funcionamiento empresarial se vea afectado negativamente por las actualizaciones, los reemplazos y las reconfiguraciones, que son habituales en las operaciones de TI. Generalmente, la administración de cambios comienza con una solicitud de cambio efectuada por una parte interesada o por la misma organización de TI. La mayoría de los procesos de administración de cambios incluyen lo siguiente:

a. Identificación. Para realizarla debe responderse a las siguientes interrogantes: ¿Cuál es el cambio? ¿Por qué se necesita? ¿Quiénes son las partes interesadas?

Determinar a detalle en qué consiste el cambio, qué recursos o elementos requiere, la razón por la que es importante realizarlo, quién lo solicita, quién lo recibe, a quienes impacta o afecta.

14

Aplicar las buenas prácticas profesionales,

b. Evaluación. Consiste en determinar el nivel de impacto en el proceso, también se refiere a establecer los recursos económicos y tecnológicos que requiere y por último identificar cuáles son los problemas que pueden derivar de la implementación del cambio o la no implementación del mismo. Las siguientes preguntas pueden ayudar a determinar estos factores: ¿Qué procesos de negocios se ven afectados por este cambio? ¿Cuáles son los costos

y

los

recursos

necesarios

para

la

implementación? ¿Cuáles son los riesgos asociados con la concreción (o no) de este cambio?

c. Planificación. Todo cambio debe llevar el acompañamiento de una detallada definición de cada paso con el fin de cumplir pequeños logros encaminados a cumplir el objetivo del cambio. Planificar permite prevenir problemas que se pudieran presentar o, en su defecto, tener tiempo para solucionar y sobreponerse ante cualquier contratiempo que surja fuera de lo establecido. Al planificar se puede apoyar en las siguientes preguntas que le orientaran en el proceso: ¿Cuánto tiempo llevará implementar este cambio? ¿Habrá un tiempo de inactividad? ¿Cuál es el proceso de retroceso o recuperación si el cambio fracasa?

d. Aprobación. Algunos cambios costosos o complejos que afectan el funcionamiento empresarial básico pueden requerir la aprobación de un comité o una junta de cambios para que se inicie la implementación. Debe constar que la autoridad responsable de autorizar el cambio lo apruebe totalmente para ello responder estas preguntas sirve de guía: ¿Quién debe autorizar este cambio? ¿Se ha obtenido la aprobación para avanzar con el cambio?

15

Aplicar las buenas prácticas profesionales,

e. Implementación. Es la realización del cambio en una especificación técnica o algoritmos como un programa, componente software, u otro sistema de cómputo. Muchas implementaciones son dadas según una especificación o un estándar. Por ejemplo, un navegador web respeta en su implementación, las especificaciones recomendadas según el World Wide Web Consortium, y

las

herramientas

desarrollo

del

de

software

contienen implementaciones

de

lenguajes de programación. Esta fase responde a las siguientes preguntas: ¿Cómo se notifica a las partes interesadas? ¿Cuáles son los pasos para completar el cambio y cómo se pondrán a prueba los resultados?

f.

Aceptación. Es la fase donde se verifica que se cumplan las condiciones requeridas en la solicitud de cambio. Para orientar este proceso se pueden responder las siguientes preguntas: ¿Cuáles son los criterios de aceptación y quién es responsable de aceptar los resultados del cambio?

16

Aplicar las buenas prácticas profesionales,

g. Documentación: Todos los resultados del proceso se registran en un documento de solicitud de cambio o control de cambio que se convierte en parte de la documentación de TI. Para esta última fase debe responder: ¿Qué actualizaciones se requieren para cambiar los registros, los pasos de implementación o los documentos de TI debido a este cambio? De manera que se afecte el documento relacionado y no algún otro que no sea relevante. Ejemplo de una hoja de trabajo de control de cambios.

17

Aplicar las buenas prácticas profesionales,

Actividad. Observe el siguiente vídeo y responda en qué consiste la matriz de 5W y 2H.

https://youtu.be/9VcNmz8Kh4M

En Resumen: En toda organización siempre se requerirán cambios, para poder implementarlos de una manera adecuada se debe seguir el orden indicado anteriormente. Iniciando con una solicitud de cambios a la cual sigue la identificación, evaluación, planificación, aprobación, implementación y aceptación. No olvidando que parte fundamental y final del proceso de control de cambios es realizar la actualización de la documentación para que quede reflejado el historial de procesos modificados y se pueda medir el impacto, así como hacer una proyección de los recursos utilizados.

Para comprobar el aprendizaje de la sesión 2 por favor escanear el siguiente código QR. Debe tener una cámara y una aplicación de escaneo QR para realizarlo. Si no lo posee puede escribir la siguiente dirección en su navegador de internet: https://cutt.ly/DOBs93d

18

Aplicar las buenas prácticas profesionales,

Bibliografía Álvarez, E. B. (2015). https://sites.google.com/site/docutecni/home. Obtenido de https://sites.google.com/site/docutecni/tecnologias/uml/diagramas-uml Benavides, C. (30 de Mayo de 2018). https://calidadparapymes.com. Obtenido de https://calidadparapymes.com/control-de-cambios-en-iso-90012015/control-de-cambios/ Bigelow, S. J. (Agosto de 2021). https://www.computerweekly.com/. Obtenido de https://www.computerweekly.com/es/definicion/Gestion-de-la-configuracion Caballero, L. T. (1996). Gestionar el cambio. Barcelona: Universidad de Barcelona. CISCO. (01 de febrero de 2022). netacad.com. Obtenido de https://www.netacad.com/ Cisco. (01 de Febrero de 2022). transfermultimedia. Obtenido de http://transfermultimedia.com/ciscoit/course/module11/11.1.1.2/11.1.1.2.html Duno, R. R. (2019). Cambio Organizacional. México: Lulu.com. Nuevas Normas ISO. (10 de noviembre de 2014). nueva-iso-9001-2015.com. Obtenido de https://www.nueva-iso-9001-2015.com/2014/11/iso-9001-documentacion/ Team Asana. (09 de Junio de 2021). asana.com. Obtenido de https://asana.com/es/resources/change-control-process Zimmermann, A. (2000). Gestión del cambio organizacional. Quito, Ecuador: Abya-Yala.

19