- Todo sobre EDDIY
- Participa
- Soluciones
- Peticiones realizadas
Diferencias
Muestra las diferencias entre dos versiones de la página.
|
como_redactar_documentacion_diy [2010/08/31 21:03] juanluis |
como_redactar_documentacion_diy [2012/02/01 15:45] |
||
|---|---|---|---|
| Línea 1: | Línea 1: | ||
| - | ===== Importancia de la documentación ===== | ||
| - | La documentación es el núcleo de un [[que_es_discadiy# | ||
| - | ===== Buenas prácticas en la generación de documentación ===== | ||
| - | |||
| - | * El principio más importante: no vas a estar al lado del que la lea cuando trate de ponerla en práctica. **Tiene que defenderse por sí sola**. | ||
| - | * 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. | ||
| - | |||
| - | <note warning> | ||
