Documentación de Soporte y Uso

La Documentación de Soporte y Uso de una herramienta digital es la puerta de entrada para que otros desarrolladores puedan instalar y reutilizar la herramienta. Es importante hacer un esfuerzo por documentar lo más claro y conciso posible.

Normalmente se escribe en formato markdown y se usa el nombre README.md. Debe estar visible en la carpeta principal de la herramienta digital. Aquí encontrarás una plantilla que te ayudará en este proceso.

La Documentación de Soporte y Uso sirve para:

• Desarrolladores - Aprenden a instalar y modificar la herramienta digital.
• Usuarios finales - Aprender a usar la herramienta digital.

Requerimientos mínimos

Las siguientes secciones deben estar incluidas en la Documentación de soporte y Uso de las herramientas digitales:

Descripción y contexto

Descripción de las funcionalidades, el contexto donde fue desarrollado y los problemas de desarrollo que ayudó a resolver.

Guía de usuario

Paso a paso dirigido al usuario final sobre cómo empezar a usar la herramienta digital.

Guía de instalación

Instrucciones de instalación para reutilizar la herramienta digital. En esta sección

Como una subsección se deben especificar las dependencias de otras herramientas digitales (librerías, frameworks, acceso a bases de datos y licencias de cada recurso).

Autores

Mención a algún punto de contacto de los autores originales. Esto evita perder el rastro al creador de la herramienta

Licencia

Permisos que se otorgan a terceros para reutilizar la herramienta digital. El archivo con la licencia como tal debe estar en un archivo llamado license.txt o licencia.txt.

Este enlace (en inglés) te puede ayudar a saber qué herramienta digital otorgar a tu herramienta digital.