Re: FAQ de la lista (ejemplo simple)
Javier Mora wrote:
¿En que formato te viene bien?
Cualquiera, lo más sencillo para mí sería que fuesen urls a documentos
del web. No quiero hacer copy&paste al FAQ como ya he explicado antes.
No soy partidario de escribir texto específico para el FAQ.
Quien pueda ayudar escribiendo y aportando documentación que lo haga en
los proyectos de documentación existentes. En el FAQ pondremos la url al
documento. Sí que se puede aportar texto específico si es necesario a la
primera sección del FAQ, aún así me gustaría que quedase lo más breve y
conciso posible.
Como primera aportación, la sección de "Problemas" la dedicaría a
cuestiones de problemas reales, por ejemplo, yo puedo haber configurado
/etc/lilo.conf a partir de ciertos documentos, pero a la hora de ponerlo en
marcha surgen ¿problemas? en el arranque.
No se puede responder a todos los problemas que alguno haya tenido
alguna vez. Para que sea un FAQ deberían aparecer los problemas más
comunes y que más se preguntan en la lista, que a su vez por lógica
deberían ser los que estan peor documentados o, lo que suele pasar, que
la respuesta está un poco oculta. No obstante, es discutible, tal vez
haya cosas que valga la pena incluirlas como por ejemplo un problema
conocido y con la solución demasiado escondida.
Crearía otra sección titulada "¿Cómo haria..." tal cosa
(posiblemente haya un título más apropiado), en la que pondría distintas
categorías (a decidir). Como ejemplo:
- Gestores de arranque
- Combinación de varios kernels
- Módulos
- Correo electrónico
- etc.
Ya te metes en el terreno de los manuales y howtos.
No se si sería oportuno poner un punto de sólo problemas o dentro de
cada categoría de las anteriores poner un punto de problemas. No lo tengo
muy claro.
En cuanto a lo de las categorías, estoy de acuerdo con la sugerencia de
Toni, pero creo que no hace falta definir por adelantado las categorías.
No serviría de nada definir 40 categorías bien estructuradas para
después solo rellenar 5. Soy partidario de primero recoger solo las
preguntas que más aparecen en la lista y después ir clasificandolas en
categorias.
Creo que los FAQs deben ser ligeros para que a la gente no le suponga
mucho esfuerzo leerlo y encontrar lo que busca. Sino empiezan a parecer
manuales. Y para eso mejor trabajar en los manuales que son más
necesarios. Espero que entendais que no quiera duplicar información y
dividir esfuerzos con el FAQ. No vamos a echar a la basura todo el
trabajo que hay hecho por ahí. :)
Muchas gracias por las sugerencias.
Saludos.
Un saludo,
--
Bernardo
Reply to: