[ubuntu-doc-spa] Sobre la inclusión de comos/howtos en la documentación

natacha menjibar natachamenjibar en gmail.com
Lun Oct 8 22:45:50 BST 2007


Hola, saludos a todos:

Este es un tema que me lleva rondando la cabeza bastante tiempo.

Con la intención de crear una documentación mucho más fiable y segura, 
creo que es necesario diferenciar entre documentación básica y comos o 
howtos (tutoriales específicos). Las razones de esta opinión es porque 
normalmente la documentación genérica funciona en todos los computadores 
(a no ser que haya alguna incompatibilidad de hardware. Los comos en 
cambio dependen muy específicamente del hardware y software que haya 
instalado, o incluso de las condiciones de cómo se
instala, y a veces pueden estropear nuestro sistema.

Por otra parte, la verificación de éstos por parte de los documentadores 
es bastante complicada, por lo dicho anteriormente.


Por ello creo que es necesario que en estos últimos se incluya una 
advertencia a los usuarios.


Con mediawiki esto es muy fácil, se incluye una plantilla [1] en los 
artículos y aparecerá la advertencia automáticamente que advertirá a los 
usuarios que deben utilizar éstos artículos con especial cuidado y bajo 
su responsabilidad, ya que no están testeados o no son documentación 
Oficial.

Se incluirían también en una categoría diferente a la documentación 
genérica [2]

A veces la línea entre la documentación genérica y los comos es muy 
fina, pero en la medida de los posible deberíamos controlar este tipo de 
documentación para evitar que usuarios novatos destrocen su sistema, o 
al menos que se avise de que pueden hacerlo (ya sabemos que la gente 
muchas veces nisiquiera lee las advertencias, pero para aquellos que lo 
lean al menos se lo pensarán 2 veces antes de hacer según qué cosas).


De esta manera nos aseguraríamos de que nuestra documentación es fiable, 
pero también daríamos la posibilidad a la gente de incluir sus pequeños 
manuales, y hacer de este modo una documentación más completa y profesional.


Por otra parte, no se si todos estamos de acuerdo en llamar Comos a los 
howtos, es un término que poco a poco se va extendiendo y creo que como 
hispanos debemos fomentar el uso de nuestra lengua y no anglicismos que 
nos llevan a utilizar muchas veces lenguaje que los usuarios noveles no 
entienden.


En el apartado de cómo colaborar se incluiría una explicación exhaustiva 
de este tema para que las personas que quieran añadir tutoriales sepan 
el procedimiento adecuado.

Por favor, opinad sobre este tema ya que me parece bastante importante, 
y un punto decisivo antes “abrir” el wiki a la participación de los 
usuarios y antes de empezar a incluir más contenidos en el.

Saludos


kelp

[1] http://doc.ubuntu-es.org/index.php/Plantilla:Comos
[2] http://doc.ubuntu-es.org/index.php/Categoría:Comos






Más información sobre la lista de distribución Ubuntu-doc-spa