Re: [Health-es] Proceso de revisión y mejora de documentación en español

[Luis Falcon]

Hola Cecilia y equipo !
On Wed, 24 Sep 2014 17:10:41 -0300
Maria Cecilia Santos Popper <address@hidden> wrote:

> Hola Mauricio!
> Gracias por los aportes!
> Creo que una semana para recibir la documentación es buen período de
> tiempo.
> 
> Respecto de que instrumento utilizar para escribir documentación
> técnica, me estaba preguntando que utilizar. Al final opté por el
> viejo y querido txt pero obviamente no es un entorno colaborativo.
> Podríamos incursionar en Sphinx con Markdown (no RST?) y armar un
> repo github para publicar allí todos los borradores? O podríamos
> utilizar la Wiki directamente. Tal vez en este punto nos sirva tu
> experiencia o la experiencia de otros para obtener mejores resultados.
> 
Creo que el txt es lo mejor para el wikibook. En mi opinión, lo mejor
sería tenerlo todo en el mismo wikibook. El poner borradores en otros
entornos creo que a la larga genera dispersión de la documentación.

Usar el Wikibook y sus revisiones es lo más fácil y todos
sabemos que ahí estará lo último.

Abrazos !

> 
> 
> 2014-09-23 19:59 GMT-03:00 Mauricio Baeza
> <address@hidden>:
> 
> >  On Tue, 2014-09-23 at 17:59 -0300, Maria Cecilia Santos Popper
> > wrote:
> >
> > address@hidden:
> >
> >  Durante el Encuentro Latinoamericano desarrollado el pasado Sábado
> > 20 en Entre Ríos (Argentina) se esableció la necesidad de iniciario
> > un proceso de revisión y mejora de la documentación de GNU Health,
> > con especial "urgencia" en mejorar la versión en español.
> >
> >  Es por ello que me he ofrecido como voluntaria para coordinar esta
> > tarea.
> >
> >  Creo que se podría dividir esta tarea en tres actividades
> > separadas: 1) compilar y consolidar toda la información actualmente
> > disponible, 2) segmentar la documentación por perfiles (una
> > documentación para usuarios finales, otra para administradores y
> > otra para desarrolladores, 3)Realizar una sección de FAQs
> >
> >  Para empezar por la tarea 1 creo que la mejor manera de organizar
> > el trabajo es la siguiente (aunque desde ya, todas las sugerencias
> > serán bienvenidas).
> >
> >  1. Compilar toda la documentación en español circulante (tanto la
> > oficial publicada en las Wikis, como la no oficial que puedan
> > utilizar todos uds. en sus implementaciones individuales). La idea
> > sería compilar y evaluar toda la documentación disponible y
> > consensuar una versión consolidada con toda la comunidad
> > hispano-parlante. Desde ya que la colaboración con la documentación
> > que posea cada uno es voluntaria, pero sería importante contar con
> > la mayor cantidad de "versiones" que reflejen diferentes formas de
> > hacer las cosas.
> >
> >  Por lo tanto, los invito a que me envíen (sugiero hacerlo en forma
> > privada para evitar sobrecargar la lista) aquella documentación con
> > la que quieran colaborar en este proceso.
> >
> >  Desde ya, que toda otra sugerencia y colaboración será mas que
> > bienvenida.
> >
> >  Saludos!
> >
> >  Cecilia
> >
> > --
> >
> >  Lic. Cecilia Santos Popper
> >
> >
> > Hola Cecilia...
> > Hola a todos...
> > Si, hace mucha falta este trabajo de revisión y mejora de la
> > documentación...
> >
> > Una búsqueda rápida de documentación para GNU Health en varios
> > buscadores devolvía casi siempre el wikibook que todos conocemos:
> > http://en.wikibooks.org/wiki/GNU_Health por lo que creo que hay
> > mucho por hacer, ojalá que varios de los compañeros hayan
> > documentado su experiencia al instalar y usar por lo que es
> > interesante esta iniciativa... la lista no tiene mucho trafico, por
> > lo que creo que en primera instancia podemos seguirla usando, en
> > cuanto crezca un poco el flujo se puede pensar en una forma alterna
> > de comunicación...
> >
> > Tengo algo de experiencia de escribir documentación técnica y he
> > usado casi de todo, txt, html, odt, wiki y últimamente estoy muy
> > contento con Sphinx/Markdown que te permite de una forma sencilla
> > tener excelente documentación.
> >
> > Por supuesto para la revisión colaborativa se requiere un entorno
> > colaborativo; Wiki, Github, Seafile, etc...
> >
> > Me parece correcta la estrategia que propones, para el punto 1, creo
> > esperar un tiempo prudente (¿1 semana?) para ver quien tiene algo
> > más de documentación, si no, partir del Wikibook que tiene mucha
> > información rescatable...
> >
> > Para el punto 2, yo lo dividiría en: Instalación, Administración y
> > Uso, que es casi lo mismo que tu tienes, el punto de Instalación me
> > parece prioritario, sin sistema instalado no se puede avanzar en
> > otros puntos y ha sido un tema que produce muchas preguntas en esta
> > lista...
> >
> > Quedo a la espera de más comentarios de la comunidad y al
> > seguimiento de este importante tema...
> >
> > Un abrazo
> >
> > Mauricio Baeza
> >
> >
> 
>