FAQ de Python-es

[Rafael Villar Burke]

Arnau Sanchez wrote:
> Hola,
>
> Hay un tema que surge como el Guadiana en la lista y que hay que coger 
> por los cuernos de una vez: ¡Python-es necesita un FAQ! Ya sé que la 
> gente tira de google y acaba en el archivo, pero eso no invalida que 
> tengamos un documento donde volcar y refinar todo el conocimiento que 
> se puede extraer de la lista.
>
> Creo que el último intento que se hizo fue este:
>
> http://listas.aditel.org/archivos/python-es/2005-May/013374.html
>
> Pero no parece que llegara a nada.
>
> Cuestiones:
>
> Pertinencia: ¿Estamos todos (o al menos una mayoría) de acuerdo en que 
> necesitamos un FAQ? ¿Hay interés en participar?
Personalmente creo que es muy importante tener una FAQ en condiciones. 
Es difícil localizar las respuestas cuando no sabes muy bien cuáles son 
las preguntas interesantes, sobre todo cuando empiezas. Por otro lado, 
la calidad de las respuestas es muy variada y discernir entre las más 
interesantes no es trivial.
> Formato: ¿Wiki?
Puede ser. En pygtk.org estamos usando una aplicación hecha en python, 
por GvR, para gestionar la FAQ. Ha estado en funcionamiento durante años 
sin problemas.
Faqwiz usa RCS para el control de versiones y almacena los contenidos en 
archivos planos de texto desde los que se generan los contenidos web.
Tiene como ventajas sobre un wiki que tiende menos al desorden, al estar 
pensada expresamente para esta tarea, y es muy fácil de manejar.

El código está disponible en el repositorio de subversion de python.org: 
http://svn.python.org/projects/python/trunk/Tools/faqwiz/

Algunas mejoras que sería interesante hacer (ahora que viene el verano a 
lo mejor se anima alguien a contribuir a esta herramienta... :):

- permitir como respaldos del control de versiones CVS/SVN, mercurial / 
git, o, tal vez mejor ahora que se distribuye con python, SQLite.
- traducir la interfaz
- internacionalizar la aplicación. Ahora los mensajes de la interfaz 
están escritas en el código, pero sería interesante poder traducirlo 
usando archivos .po.
- permitir la obtención de los datos en otros formatos: texto plano, 
docbook... Esto último podría permitir generar versiones estáticas en 
HTML o PDF con XSLT.
- crear un formulario para la entrega de la contraseña de acceso a una 
dirección de correo (en pygtk.org simplemente se comenta en el IRC, ya 
que realmente sólo sirve para evitar el spam).
> De dónde venimos: ¿Hay algo ya hecho? ¿Alguien tiene material sobre el 
> que partir o empezamos de cero? seguramente de DotPy y de algún otro 
> sitio más se puede sacar bastante documentación con la que empezar.
Algo para lo que podría ser útil el wiki es para hacer un guión de los 
apartados/capítulos de la FAQ, independientemente de la herramienta que 
se use al final para mantenerla.
> A dónde vamos: ¿Conocéis alguna web donde poner esto? ¿Aditel puede 
> ayudarnos de algún modo?
Lo mejor sería tenerlo alojado en un lugar que pueda tener "garantizada" 
la continuidad. En ese sentido, y hasta donde sé, aditel parece buena 
opción.

Saludos,

Rafael Villar Burke