Documentación

1. Documentación funcional de puesta en producción

Un aspecto a destacar de la mayoría de las aplicaciones hechas por mySociety (FixMyStreet1, Alaveteli2 y Pombola) es el uso de documentación tanto técnica como funcional. Por ejemplo entre las instrucciones que dan de personalización ofrecen una lista de tareas a comprobar, tales cómo formar el grupo impulsor, escoger el nombre de la plataforma, su dominio, traducir al idioma, instalar la aplicación, adaptar la imagen, etc.

image alt text

Figura F.2.7.36 (F.2 Aleveteli): Documentación: como personalizar la instalación

2. Mejora contenidos iniciales post-instalación

En muchas de las aplicaciones estudiadas se facilita la creación de contenidos iniciales de cara a poder comprender mejor la aplicación y los tipos de contenidos soportados. En el caso de algunas, como Decidim y Consul, estos contenidos iniciales (también llamados seeds o semillas en el caso del framework Ruby on Rails), se tratan de contenidos generados automáticamente por una librería basada en "Lorem ipsum", textos sin sentido que sirven para poder visualizar el diseño final a falta de los contenidos reales.

Por otra parte, en el caso de Discourse, esos contenidos iniciales son la propia explicación de la herramienta: cómo personalizarla inicialmente, preguntas frecuentes, textos de bienvenida a ciertas categorías, etc. Esto facilita la entrada de los usuarios iniciales (administradores) a la herramienta, ya que no deben buscar en la documentación de la herramienta sino que directamente se encuentran en la misma.

image alt text

Figura D.1.7 (D.1 Discourse): Página principal con sesión de administrador iniciada

results matching ""

    No results matching ""