Documentación del proyecto: Wiki

De Vitalinux
Saltar a: navegación, buscar




Introducción

Toda la documentación del proyecto se queda reflejada en la wiki

La visualización es abierta y también está abierta la posibilidad de que cualquier usuario registrado pueda editar páginas o crear nuevas páginas que sirvan para mejorar el proyecto.

Mediawiki es un sistema ampliamete usado para documentar en Internet. Wikipedia se basa por ejemplo en éste motor

Estructura

Los contenidos que podemos encontrar nada más entrar en la wiki son

  • Noticias del proyecto (vinculadas a las noticias de soporte
  • Manuales y ayuda. Un índice con acceso a los principales materiales
  • Descripcion del proyecto
  • Área de descargas. Todas las imágenes isos necesarias y archivos importantes para descargas lo encontraremos aquí
  • Mapa "actualizado" del despliegue

Las páginas con información simplemente son direcciones web (dentro de la wiki) con un nombre que identifica la página.

Podemos incluso en éste sentido estructurar las páginas que creemos usando la notación clásica de subidrectorios

Búsqueda: Muchas veces lo mejor será usar el motor de búsqueda que incorpora la propia wiki para poder encontrar las páginas con la documentación deseada

Registro

El registro deberá ser llevado a cabo por un administrador.

Tarea: Registrar a todos los nuevos coordinadores del proyecto

Creación y Modificación

Crear una página wiki es muy sencillo. Si indicamos una URL/paǵina que no existe, mediawiki nos invitará a crearla de nuevo. Para su edición podemos optar por:

  • Crear/Editar: abrirá un editor tipo wysiwyg. Si la página ya se ha editado y contiene elementos complejos, puede fallar la carga de éste edito
edicion wiki editor
  • Crear/Editar fuente. En éste caso optaremos por usar un editor plano. Puede ser más complejo al principio, pero es muy potente si queremos reutilizar código ya hecho de otros documentos o páginas.
edicion wiki simple

Puede resultar de interés tener a mano el documento de Formato

Logolupa.png

¡¡Importante!!

¿Y si modifico/modifican algo que no debo?

Para eso tenemos el control de cambios, la Protección y el seguimiento/vigilar la página, que nos permite volver atrás en cualquier momento


control de cambios

Subida de imágenes

Hay que tener en cuenta que las imágenes se deben subir, dar unos derechos de liberación (si son nuestras, si tienen algún tipo de licencia...), y por último describir la imágen (nombre, descripción y fecha de creación). Podemos usar dos métodos:

  • Simple -> Usando el botón en la edición de fuente
  • Múltiple -> Podemos subir varias imágnes a la vez usando la opción disponible en las herramientas del menú de la izda, donde dice Subir Archivo

Avanzado

  • Podemos crear páginas que contengan otras páginas. Las páginas de éste manual importan los índices, las FAQs...
  • Plantillas que nos permiten generar partes comunes. Por ejemplo, la plantilla de Importante
  • Por defecto si hay varios encabezados, mediawiki genera un índice al principio de la página, pero si queremos que lo genere siempre podemos usar el código <nowiki>