- Todo sobre EDDIY
- Participa
- Soluciones
- Peticiones realizadas
Diferencias
Muestra las diferencias entre dos versiones de la página.
| Ambos lados, revisión anterior Revisión previa Próxima revisión | Revisión previa | ||
|
como_redactar_documentacion_diy [2010/09/17 11:50] g.azagra |
como_redactar_documentacion_diy [2012/02/01 15:45] (actual) |
||
|---|---|---|---|
| Línea 3: | Línea 3: | ||
| ===== Importancia de la documentación ===== | ===== Importancia de la documentación ===== | ||
| - | La documentación es el núcleo de un [[que_es_discadiy# | + | La documentación es el núcleo de un [[todo_sobre_eddiy: |
| ===== Buenas prácticas en la generación de documentación ===== | ===== Buenas prácticas en la generación de documentación ===== | ||
| Línea 9: | Línea 9: | ||
| * El objetivo es que se beneficie el máximo número de personas y familias posibles. No temas nunca a explicar algo demasiado sencillo u obvio. Más vale una explicación de más que de menos en este caso. | * El objetivo es que se beneficie el máximo número de personas y familias posibles. No temas nunca a explicar algo demasiado sencillo u obvio. Más vale una explicación de más que de menos en este caso. | ||
| * El **orden es esencial**. Si el lector no tiene dificultades con la lógica y el sentido de lo que le explicas en tu manual, avanzará más rápido. | * El **orden es esencial**. Si el lector no tiene dificultades con la lógica y el sentido de lo que le explicas en tu manual, avanzará más rápido. | ||
| - | * No está de más que recuerdes que un discadiy, cuanto más económico, | + | * No está de más que recuerdes que un discadiy, cuanto más económico, será accesible a un mayor número de personas. |
| De igual manera, si haces referencia a dónde se pueden encontrar los componentes y piezas que pueden hacer falta para tu discadiy, ayudarás a tus lectores a superar una barrera más - que, en ocasiones, puede llegar a ser importante. | De igual manera, si haces referencia a dónde se pueden encontrar los componentes y piezas que pueden hacer falta para tu discadiy, ayudarás a tus lectores a superar una barrera más - que, en ocasiones, puede llegar a ser importante. | ||
| - | * Una imagen vale más que mil palabras, y otro tanto le sucede al video respecto a la imagen. Las fotos y esquemas de las etapas de tu discadiy pueden servir para sortear barreras, y podrás subirlas sin problemas al servidor que aloja [[http:// | + | * Una imagen vale más que mil palabras, y otro tanto le sucede al video respecto a la imagen. Las fotos y esquemas de las etapas de tu discadiy pueden servir para sortear barreras, y podrás subirlas sin problemas al servidor que aloja [[http:// |
| * En la medida en la que te sea posible, el diálogo con los usuarios de tu discadiy puede acabar de redondearlo. Pásate de vez en cuando para ver los comentarios y suscríbete a los cambios pulsando en '' | * En la medida en la que te sea posible, el diálogo con los usuarios de tu discadiy puede acabar de redondearlo. Pásate de vez en cuando para ver los comentarios y suscríbete a los cambios pulsando en '' | ||
