Dirección y gestión de proyectos y sistemas informáticos/Consejos para redactar lecciones

Consejos para redactar lecciones

Presta atención a estos consejos para crear y modificar lecciones dentro de este proyecto de aprendizaje.

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 lecciones en cuya construcción colabores.

Políticas

Es importante entender lo que más se valora en este proyecto de aprendizaje, para tratar de centrar las lecciones en torno a eso, evitando dar mucho detalle sobre cuestiones que son de menor o nulo interés para este proyecto.

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, este proyecto de aprendizaje se interesa principalmente sobre cuestiones 'de más alto nivel', 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.

Manual de estilo

Todas las lecciones 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 lecciones que tengan entre 500 y 1500 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 conseguir el objetivo de la lección.

Otra recomendación es hacer que las lecciones 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. Si una lección tuviera 'subpáginas', estas deberían colgar directamente de la página principal de dicha lección, 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 lección creada originalmente como material didáctico del proyecto de aprendizaje Dirección y gestión de proyectos y sistemas informáticos.

Puede ser interesante insertar enlaces a lecciones relacionadas, bien por estar consideradas como 'previas' a esta o como 'continuación lógica' de esta, así como a 'sublecciones' que de alguna manera detallen más los contenidos de la presente lección. Esto se hará en la sección adecuada de la lección, como veremos a continuación.

Secciones de la lección

Al comienzo de la lección se escribirá el objeto de la misma en una o dos frases muy concisas.

Después la lección contendrá las siguientes secciones, que conforman la estructura o formato básico que deseamos usar en este proyecto de aprendizaje:

• Introducción
• Sección 1 (con el nombre que se desee)
• Sección 2 (con el nombre que se desee)
• ...
• Sección N (con el nombre que se desee)
• Conclusiones (a modo de resumen de la lección)
• Notas (sólo si las hay)
• Lecciones relacionadas
• Referencias
• Participantes (que están activos actualmente o lo estuvieron alguna vez)
• Categorías (cuantas más, mejor)

Se recomienda no profundizar más allá del segundo nivel de anidamiento entre secciones (es decir sección, subsección y subsubsección).

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 lección 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 los contenidos de una lección, puede crearse una sección específica de 'Ejemplos' o 'Casos prácticos' para ello. Aunque también es posible insertarlo en mitad de la lección 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 lección.

Cuestionarios

Como forma de complementar una lección conviene añadir al final una sección de 'Cuestionario de auto-evaluación' con preguntas sencillas sobre sus contenidos. Los formatos de preguntas y respuestas serán los que permiten la extensión Quiz de la Wikiversidad. La respuesta correcta se desplegará al presionar el botón «Enviar», como en este ejemplo:

¿Dónde se deben poner los cuestionarios de auto-evaluación en este proyecto de aprendizaje?

	En ninguna parte, no se admiten
	Repartidos entremedias de los contenidos de la lección
	Al final de la lección, en una sección llamada «Cuestionarios de auto-evaluación»

Categorías de lección

Cada lección deberá catalogarse como mínimo dentro de las categorías 'Recursos de aprendizaje' y 'Lecciones'.