Cambios previstos en la documentación de plone.org

6 messages Options
Embed this post
Permalink
Israel Saeta Pérez

Cambios previstos en la documentación de plone.org

Reply Threaded More More options
Print post
Permalink
Como ya os comenté en un mensaje anterior, hemos tenido una reunión en la que se han tomado decisiones sobre una serie de temas. A falta del resumen oficial de JoAnna Springsteen, os presento el mío propio:
  • La documentación se dividirá en parte dos partes:
    • Una oficial, en la que se seguirán procesos de revisión, actualización y control de calidad dirigidos por los editores, pero que puede ser escrita por cualquier miembro de la comunidad de Plone.
    • Una abierta de estilo wiki, con páginas que cualquiera podrá editar sin pasar por el proceso de revisión de la documentación oficial. Se diferenciará claramente de la oficial y se encontrará en un subdominio del tipo algo.plone.org.
  • Se tiene la intención de usar Sphinx para la documentación de referencia de los módulos que componen Plone. Se llevará a cabo una experiencia piloto con algún módulo para ver qué tal funciona.
  • La documentación oficial se intentará organizar en manuales sobre cada tema (uso básico, theming, formularios, etc.), cada uno con una introducción rápida primero y luego una guía comprensiva sobre el tema. Se intentará encontrar un lugar en los manuales para toda documentación nueva que se escriba.
  • Se eliminará la división del Plone Help Center actual por tipo de contenido en la parte oficial, es decir, adiós a las URLs tipo plone.org/documentation/tutorial, plone.org/documentation/howto, etc.
  • Se intentará que los PLIPs incluyan información para facilitar la tarea de documentar los cambios que introducen. Estamos en contacto con el framework-team para conseguirlo.
  • Se eliminarán los comentarios de los artículos oficiales de documentación. Los errores y mejoras de un artículo se registrarán y se administraran con el sistema Trac general de Plone, como bugs en la documentación.
  • Se eligieron tres cargos especiales en el equipo de documentación:
    • Veda Williamson, responsable de asuntos políticos y de presentación (theming principalmente).
    • Steve McMahon, responsable técnico y enlace con la Plone Foundation.
    • JoAnna Springsteen, pastora de nuestro rebaño de editores.
Por otra parte, Aleksandr Vladimirskiy (aka shurik) ha dimitido como editor de la sección "Users, Authentication and Permissions". Cualquier ayuda será bienvenida.

-- israel

_______________________________________________
Plone-ConoSur mailing list
[hidden email]
http://lists.plone.org/mailman/listinfo/plone-conosur
Israel Saeta Pérez
Santiago Videla

Re: Cambios previstos en la documentación de plone.org

Reply Threaded More More options
Print post
Permalink
Buenas,

Suena interesante y prometedor, felicitaciones.

Por estos dias ando navegando por los mares de Grok y no tanto Plone, pero espero hacerme algun tiempo para dar una mano o escribir alguito sobre algo... :)

Quizas algo relacionado con Grok/Plone, se que Martin Aspelli estuvo o esta haciendo algunas cositas y me parece que puede ayudar bastante a los recien llegados al estilo Zope3 en Plone

Saludos

2008/12/3 Israel Saeta Pérez <[hidden email]>
Como ya os comenté en un mensaje anterior, hemos tenido una reunión en la que se han tomado decisiones sobre una serie de temas. A falta del resumen oficial de JoAnna Springsteen, os presento el mío propio:
  • La documentación se dividirá en parte dos partes:
    • Una oficial, en la que se seguirán procesos de revisión, actualización y control de calidad dirigidos por los editores, pero que puede ser escrita por cualquier miembro de la comunidad de Plone.
    • Una abierta de estilo wiki, con páginas que cualquiera podrá editar sin pasar por el proceso de revisión de la documentación oficial. Se diferenciará claramente de la oficial y se encontrará en un subdominio del tipo algo.plone.org.
  • Se tiene la intención de usar Sphinx para la documentación de referencia de los módulos que componen Plone. Se llevará a cabo una experiencia piloto con algún módulo para ver qué tal funciona.
  • La documentación oficial se intentará organizar en manuales sobre cada tema (uso básico, theming, formularios, etc.), cada uno con una introducción rápida primero y luego una guía comprensiva sobre el tema. Se intentará encontrar un lugar en los manuales para toda documentación nueva que se escriba.
  • Se eliminará la división del Plone Help Center actual por tipo de contenido en la parte oficial, es decir, adiós a las URLs tipo plone.org/documentation/tutorial, plone.org/documentation/howto, etc.
  • Se intentará que los PLIPs incluyan información para facilitar la tarea de documentar los cambios que introducen. Estamos en contacto con el framework-team para conseguirlo.
  • Se eliminarán los comentarios de los artículos oficiales de documentación. Los errores y mejoras de un artículo se registrarán y se administraran con el sistema Trac general de Plone, como bugs en la documentación.
  • Se eligieron tres cargos especiales en el equipo de documentación:
    • Veda Williamson, responsable de asuntos políticos y de presentación (theming principalmente).
    • Steve McMahon, responsable técnico y enlace con la Plone Foundation.
    • JoAnna Springsteen, pastora de nuestro rebaño de editores.
Por otra parte, Aleksandr Vladimirskiy (aka shurik) ha dimitido como editor de la sección "Users, Authentication and Permissions". Cualquier ayuda será bienvenida.

-- israel

_______________________________________________
Plone-ConoSur mailing list
[hidden email]
http://lists.plone.org/mailman/listinfo/plone-conosur




--
Santiago Videla
www.revolucionesweb.com.ar
http://www.linkedin.com/in/svidela

Sigue la mata dando de que hablar siempre abajo y a la izquierda donde el pensamiento que se hace corazón resplandece con la palabra sencilla y humilde que l@s tod@s somos.

_______________________________________________
Plone-ConoSur mailing list
[hidden email]
http://lists.plone.org/mailman/listinfo/plone-conosur
spanish

Re: Cambios previstos en la documentación de plone.org

Reply Threaded More More options
Print post
Permalink
In reply to this post by Israel Saeta Pérez
Israel Saeta Pérez escribió:
> Como ya os comenté en un mensaje anterior, hemos tenido una reunión en
> la que se han tomado decisiones sobre una serie de temas. A falta del
> resumen oficial de JoAnna Springsteen, os presento el mío propio:

Las cosas que entiendo me parecen muy bien. Del resto, ni idea. Pero
agradezco sinceramente vuestra dedicación altruista. Abrazos: Manuel

_______________________________________________
Plone-ConoSur mailing list
[hidden email]
http://lists.plone.org/mailman/listinfo/plone-conosur
spanish

Re: Cambios previstos en la documentación de plone.org

Reply Threaded More More options
Print post
Permalink
Manuel Gualda Caballero escribió:
> Israel Saeta Pérez escribió:
>  
>> Como ya os comenté en un mensaje anterior, hemos tenido una reunión en
>> la que se han tomado decisiones sobre una serie de temas. A falta del
>> resumen oficial de JoAnna Springsteen, os presento el mío propio:

Un par de sugerencias de un principiante:

1.- Sería interesante que los usuarios registrados pudiéramos valorar la
utilidad de la documentación. Imagino que así la más útil para la
mayoría de la gente aparecería en los primeros puestos dentro de cada
categoría si el visitante eligiera esta opción de ordenación. Esto
podría ser un buen complemento al orden que por razones técnicas y
pedagógicas estimen conveniente los especialistas.

2.- Entiendo las razones por las que el esfuerzo de documentación se
centraliza en inglés. Aunque sugeriría que para ayudar a conseguir el
objetivo que entiendo se persigue con esta decisión (accesibilidad del
conocimiento al mayor número posible de personas), se intente que la
redacción sea lo más sencilla posible. En todos los idiomas hay muchas
maneras de decir una misma cosa, desde la más sencilla, hasta la más
enrevesada. Si se quiere que los no especialistas en inglés entiendan el
mayor número posible de explicaciones, lo ideal sería optar por la
sencillez en la redacción.

Abrazos:

Manuel

_______________________________________________
Plone-ConoSur mailing list
[hidden email]
http://lists.plone.org/mailman/listinfo/plone-conosur
Israel Saeta Pérez

Re: Cambios previstos en la documentación de plone.org

Reply Threaded More More options
Print post
Permalink
2008/12/7 Manuel Gualda Caballero wrote:
Un par de sugerencias de un principiante:

1.- Sería interesante que los usuarios registrados pudiéramos valorar la
utilidad de la documentación. Imagino que así la más útil para la
mayoría de la gente aparecería en los primeros puestos dentro de cada
categoría si el visitante eligiera esta opción de ordenación. Esto
podría ser un buen complemento al orden que por razones técnicas y
pedagógicas estimen conveniente los especialistas.
 
Esto tiene mucho (muchísimo) sentido en la parte "collective" de la documentación, pero no tanto en la parte oficial, ya que si sólo hay un manual de cada tema (formularios, archetypes, etc.), como queremos que haya, no hay nada que ordenar.

2.- Entiendo las razones por las que el esfuerzo de documentación se
centraliza en inglés. Aunque sugeriría que para ayudar a conseguir el
objetivo que entiendo se persigue con esta decisión (accesibilidad del
conocimiento al mayor número posible de personas), se intente que la
redacción sea lo más sencilla posible. En todos los idiomas hay muchas
maneras de decir una misma cosa, desde la más sencilla, hasta la más
enrevesada. Si se quiere que los no especialistas en inglés entiendan el
mayor número posible de explicaciones, lo ideal sería optar por la
sencillez en la redacción.

Esto es complicado, porque no me veo rechazando el documento de alguien por estar escrito en un inglés complejo. Por supuesto, intentamos que todos los documentos sean lo más claros posibles, y damos algunas pistas para conseguirlo.

De todas formas, estoy seguro de que muchos documentos están escritos por personas cuya lengua madre no es el inglés, así que no creo que se use un vocabulario ni una gramática especialmente complejo. Aun así, pondré especial atención a que la redacción sea sencilla cuando revise los nuevos documentos.


¡Muchas graciasa por tu interés y tus aportaciones! Las opiniones de los que se llaman a sí mismos principiantes son muy importantes para nosotros. ;-)

-- israel


_______________________________________________
Plone-ConoSur mailing list
[hidden email]
http://lists.plone.org/mailman/listinfo/plone-conosur
Israel Saeta Pérez
spanish

Re: Cambios previstos en la documentación de plone.org

Reply Threaded More More options
Print post
Permalink
Israel Saeta Pérez escribió:

> 2008/12/7 Manuel Gualda Caballero wrote:
>
>     Un par de sugerencias de un principiante:
>
>     1.- Sería interesante que los usuarios registrados pudiéramos valorar la
>     utilidad de la documentación. Imagino que así la más útil para la
>     mayoría de la gente aparecería en los primeros puestos dentro de cada
>     categoría si el visitante eligiera esta opción de ordenación. Esto
>     podría ser un buen complemento al orden que por razones técnicas y
>     pedagógicas estimen conveniente los especialistas.
>
>  
> Esto tiene mucho (muchísimo) sentido en la parte "collective" de la
> documentación, pero no tanto en la parte oficial, ya que si sólo hay un
> manual de cada tema (formularios, archetypes, etc.), como queremos que
> haya, no hay nada que ordenar.

Muy bien.

>     2.- Entiendo las razones por las que el esfuerzo de documentación se
>     centraliza en inglés. Aunque sugeriría que para ayudar a conseguir el
>     objetivo que entiendo se persigue con esta decisión (accesibilidad del
>     conocimiento al mayor número posible de personas), se intente que la
>     redacción sea lo más sencilla posible. En todos los idiomas hay muchas
>     maneras de decir una misma cosa, desde la más sencilla, hasta la más
>     enrevesada. Si se quiere que los no especialistas en inglés entiendan el
>     mayor número posible de explicaciones, lo ideal sería optar por la
>     sencillez en la redacción.
>
>
> Esto es complicado, porque no me veo rechazando el documento de alguien
> por estar escrito en un inglés complejo.

Lo entiendo perfectamente. Una buena alternativa sería que los usuarios
registrados pudiéramos valorar la facilidad de comprensión de cada
documento y señalar de alguna forma aquellas partes que más trabajo nos
cuesta comprender. No es necesario que estas evaluaciones sean públicas,
pero si estuvieran a vuestra disposición, las medias resultantes podrían
ser de gran utilidad, tanto para el correspondiente editor, como para el
equipo de coordinación de estos recursos (y, lógicamente, a posteriori,
para todos los usuarios de Plone). Creo que los procesos de evaluación
colectiva son muy importantes para poder localizar las cosas a mejorar.

> Por supuesto, intentamos que
> todos los documentos sean lo más claros posibles, y damos algunas pistas
> para conseguirlo
> <http://plone.org/documentation/tutorial/creating-documentation-for-plone.org/writing>.

Perfecto: a eso me refería (la ignorancia me ha hecho sugerir algo que
ya se está haciendo...).

> De todas formas, estoy seguro de que muchos documentos están escritos
> por personas cuya lengua madre no es el inglés, así que no creo que se
> use un vocabulario ni una gramática especialmente complejo. Aun así,
> pondré especial atención a que la redacción sea sencilla cuando revise
> los nuevos documentos.
>
> ¡Muchas graciasa por tu interés y tus aportaciones! Las opiniones de los
> que se llaman a sí mismos principiantes son muy importantes para
> nosotros. ;-)

Gracias a vosotros.

\ ;-)

Abrazos:

Manuel

> -- israel
>
>
> ------------------------------------------------------------------------
>
> _______________________________________________
> Plone-ConoSur mailing list
> [hidden email]
> http://lists.plone.org/mailman/listinfo/plone-conosur

_______________________________________________
Plone-ConoSur mailing list
[hidden email]
http://lists.plone.org/mailman/listinfo/plone-conosur