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. 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.

Aquí encontrarás una plantilla con una explicación de las secciones a completar.

Requerimientos mínimos

Las siguientes secciones son las mínimas que deben estar incluidas en la Documentación de soporte y Uso:

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 y configurar la herramienta digital. Esta sección está dirigida a desarrolladores.

En otra sub-sección, se deben especificar las dependencias de otras herramientas digitales (librerías, frameworks, acceso a bases de datos y licencias de cada recurso), en caso de ser necesario.

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.