¡Esta es una revisión vieja del documento!


Importancia de la documentación

La documentación es el núcleo de un discadiy: 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.
  • 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>sin acabar</note>

<note important>Hay que hablar de la posibilidad de video, y una breve referencia a cómo subir videos a youtube, vimeo u otro servicio equivalente</note>

Este website emplea cookies para el análisis de tráfico de visitas. Si navega por este site, demuestra su conformidad con que se almacenen cookies en su computadora.Más información
como_redactar_documentacion_diy.1283533537.txt.gz · Última modificación: 2010/09/30 13:12 (editor externo)
CC Attribution-Share Alike 4.0 International
www.chimeric.de Valid CSS Driven by DokuWiki do yourself a favour and use a real browser - get firefox!! Recent changes RSS feed Valid XHTML 1.0