Herramientas de usuario

Herramientas del sitio


instrucciones_eddiy:como_redactar_documentacion_diy

Documentación DIY

Importancia de la documentación

La documentación es el núcleo de la aportación que publiques: son las instrucciones que van a permitir a otros montar y construir nuestra solución y poder utilizarla

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. Esto es, tú no vas a estar al lado del que trate de usarla, con lo que el esfuerzo principal por tu parte es prever el mayor número de dificultades que puedas para que cumpla con su objetivo.
    • 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.
    • No está de más que recuerdes que una solución que aportes, cuanto más económica, 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 solución, 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 vídeo respecto a la imagen. Las fotos y esquemas de las etapas de tu solución pueden servir para sortear barreras, y podrás subirlas sin problemas al servidor que aloja EDDIY Perú. Te hemos dejado unas instrucciones aquí. En lo que al video se refiere, bastará con que sigas estas instrucciones
  • En la medida en la que te sea posible, el diálogo con los usuarios de tu solución puede acabar de redondearlo. Pásate de vez en cuando para ver los comentarios y suscríbete a los cambios pulsando en Suscríbete a los cambios de la página en la parte inferior de la pantalla.
/home/eddiyper/public_html/data/pages/instrucciones_eddiy/como_redactar_documentacion_diy.txt · Última modificación: 2016/03/22 15:19 por admin