Dirección y gestión de proyectos y Sistemas Informáticos/Consejos para redactar actividades

Consejos para redactar actividades

Presta atención a estos consejos para crear nuevas actividades dentro de este proyecto de aprendizaje. En principio las actividades ya creadas (correspondientes a trabajos ya desarrollados por otros participantes) deberían sufrir únicamente cambios o ediciones menores (corrección de erratas, mejora en el formato, enriquecimiento con enlaces, etc.).

Para todo lo que no se cubra en esta página se puede recurrir al manual de estilo de la Wikipedia como referencia de autoridad.

Participantes activos

Si colaboras activamente en este proyecto de aprendizaje, es muy importante que te registres en la Wikiversidad. Aunque no es obligatorio estar registrado para modificar páginas, el haberlo hecho previamente te permite "firmar" tus contribuciones y ayuda a poder hacer un mejor seguimiento de lo que cada uno aporta a los distintos proyectos.

Acuérdate también de apuntarte a este proyecto concreto, añadiendo tu firma a las listas de participantes activos tanto de la página principal del proyecto como de todas aquellas actividades en cuya realización colabores.

Políticas

Es importante entender lo que más se valora en este proyecto de aprendizaje, para tratar de centrar la documentación de las actividades en torno a eso, evitando dar mucho detalle sobre cuestiones que son de menor o nulo interés para este proyecto, aunque dichas cuestiones formen parte también de la actividad.

En la disciplina de la Ingeniería del Software se valora principalmente la correcta realización de las actividades de los proyectos, comprendidas en estas dos dimensiones:

1. La púramente técnica, donde se enmarcan actividades estructurales como la especificación de requisitos, el análisis y el diseño del software, con su arquitectura y patrones de diseño habitualmente documentados mediante diagramas UML, la implementación o codificación, las pruebas tanto manuales como automatizadas, etc.
2. La relativa a la gestión del proyecto, donde encontramos actividades protectoras como la organización del equipo de trabajo y su estructura, el mantenimiento del repositorio de software, los cálculos y las estimaciones de esfuerzo, la planificación mediante técnicas como los diagramas de Gantt, etc.

Sin embargo, en este proyecto de aprendizaje versa sobre cuestiones 'de más alto nivel', cuestiones relativas al Gobierno de Servicios de Información, concretamente:

1. Las actividades que se enmarcan en la gestión y el gobierno de la organización que lleva a cabo el proyecto (o los proyectos) de ingeniería, asegurándose de adecuar los objetivos y la estrategia para alcanzar el éxito, aportando valor a los clientes, realizando un apropiado diseño de los servicios y superando sin problemas la transición de las primeras pruebas hasta ofrecer servicios plenamente operativos, mantener esos servicios en activo a lo largo del tiempo, minimizando las incidencias, y realizando una mejora continua en ellos, etc.

Los participantes en este proyecto de aprendizaje pueden modificar cualquiera de las lecciones y actividades del mismo. Sin embargo se recomienda consultar previamente si se desea hacer un cambio significativo en alguna página de una actividad en la que no se haya participado, y también pedir permiso si se desea borrar o mover fragmentos largos de las lecciones.

Modelos

Para documentar las actividades de este proyecto de aprendizaje de manera más uniforme se sugiere el uso de patrones o modelos como el que se presenta a continuación. Estos modelos están basados, aunque vagamente, en las plantillas oficiales del estándar ITIL 2011, disponibles en la conocida como 'ITIL Wiki'.

Para empezar y basándonos en esta plantilla del portafolio de servicios definimos cómo redactar la propuesta de los servicios de información a ofrecer por cada grupo de participantes. La idea es que cada grupo elabore su propio portafolio de servicios, teniendo en cuenta que para cada servicio (en caso de que se ofrezcan varios) se deben documentar una serie de secciones que permitan entender la visión de la corporación que se pretende gobernar.

Modelo de portafolio de servicios

• Nombre
• Estado (dentro del ciclo de vida: propuesto, definido, etc.)
• Tipo (externo para el cliente o interno como infraestructura)
• Propietario\Responsable del servicio
• Clientes actuales que lo estén usando
• Contacto y manera de suscribirse al servicio
• Descripción de resultados deseados (valor añadido, actividades que va a poder realizar el cliente, utilidad y garantía)
• Paquetes (variaciones según el nivel de servicio, por zonas geográficas, u horarias...)
• Coste y precio (según el nivel de servicio, reglas para multas, desistimientos, etc.)
• Dependencias (servicios que dependen de este, y servicios de los que este depende; componentes/elementos de configuración principales de los que dependemos)
• Futuros cambios planificados (referencias a planes relevantes, análisis coste-beneficio, prioridad del cambio, riesgos asociados, planificación temporal e información de estado)
• Referencias
• Glosario (y otros apartados típicos...)

Manual de estilo

Toda la documentación de actividades de este proyecto de aprendizaje, sean más o menos importantes, deberán seguir las indicaciones expresadas en las siguientes subsecciones.

Una recomendación general es redactar subpáginas dentro de la página principal de cada actividad que tengan entre 500 y 1000 palabras y que muestren al menos un elemento gráfico (una fotografía, un diagrama, una tabla, etc.), aunque siempre debe primar aquello que ayude más a explicar debidamente la actividad.

Otra recomendación es hacer que las actividades cuelguen directamente de la raíz de la Wikiversidad, pero dándoles siempre un título suficientemente significativo, para que su contenido sea reconocible y reutilizable por otros proyectos de aprendizaje. Sin embargo todas las 'subpáginas' de una actividad deben colgar directamente de la página principal de dicha actividad, y no de la Wikiversidad.

Idioma

El idioma de todas las lecciones será el español, procurando usar los términos más reconocidos internacionalmente, y evitando localismos propios de un país concreto.

Cabecera de lección

Al principio de la lección deberá incluirse esta cabecera:

Este recurso de aprendizaje es una actividad creada originalmente como caso práctico del proyecto de aprendizaje Dirección y gestión de proyectos y sistemas informáticos.

Puede ser interesante insertar enlaces a lecciones relacionadas, e incluso a otras actividades que puedan ser 'comparadas' de alguna manera con esta.

Secciones de la actividad

Al comienzo de la actividad se escribirá el resumen de la misma en una o dos frases muy concisas.

Después la página principal de la actividad contendrá las siguientes secciones, que conforman la estructura o formato básico que deseamos usar en este proyecto de aprendizaje:

• Introducción (definir los servicios, los roles, etc. de la organización)
• Documentación estratégica (con estudio de mercado, gráficos DAFO/CAPA, etc.)
• Documentación de diseño (no hace falta demasiado formalismo de Ingeniería del Software como casos de uso, diagramas UML, etc.)
• Documentación de transición
• Documentación operativa (informes detalladas de las incidencias, atención al cliente, etc.)
• Documentación de mejora continua
• Conclusiones (a modo de resumen)
• Notas (sólo si las hay)
• Referencias
• Participantes activos
• Categorías

Se recomienda no profundizar más allá del primer nivel de anidamiento entre páginas (es decir la página principal puede tener subpáginas, pero estas a su vez no deberían tener otras subpáginas, aunque sí puedan tener ficheros enlazados o enlaces externos).

Párrafos

Se recomienda que los párrafos tengan más de una frase y oscilen entre las 50 y 100 palabras. Aunque a menudo estará justificado usar párrafos más cortos, para frases sueltas que deben ir aisladas del resto, y en algunas ocasiones incluso se podrá justificar el usar párrafos más largos.

Otra recomendación importante es tratar de resaltar, dentro de los párrafos más largos, alguna palabra en negrita. Siempre tratándose de un resaltado que esté justificado y que sea coherente con la política para negritas y cursivas que usemos en el texto.

Listados y tablas

Serán sencillos y con un formato similar a estos.

Ejemplo de listado (no conviene añadir más de tres niveles de profundidad):

• Primer nivel
  • Segundo nivel
    • Tercer nivel

Ejemplo de tabla (no conviene adornar mucho más las tablas):

Columna 1	Columna 2	Columna 3
Por si necesitas ocupar todas las columnas...
Fila 1	a	b
Fila 2	c	d
Fila 3	e	f
Fila 4	g	h

Figuras, gráficos e imágenes

Ejemplo: Logotipo de la Wikiversidad

Las imágenes o gráficos que se utilicen en este proyecto de aprendizaje deberán haber sido previamente subidas a Wikimedia Commons.

A continuación se enlazarán justo al comienzo de la sección de la actividad que corresponda, habitualmente en modo miniatura (thumbnail) y añadiendo un breve texto descriptivo tal y como ilustra el ejemplo enlazado en esta misma sección.

Ejemplos y otros incisos

Cuando resulte conveniente detallar un ejemplo particular o hacer un inciso en el discurso para ilustrar una actividad, puede crearse una sección específica de 'Ejemplos' para ello. Aunque también es posible insertarlo en mitad de la actividad resaltándolo con el estilo que se muestra a continuación:

Así se hace: Aquí explicaríamos con cierto detalle un ejemplo o inciso situado en mitad de la actividad.

Categorías de actividad

Cada actividad deberá catalogarse como mínimo dentro de las categorías 'Recursos de aprendizaje' y 'Actividades'.