-
Notifications
You must be signed in to change notification settings - Fork 301
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.
Este repositorio contiene una plantilla de README.md para ayudar a completar la Documentación de Soporte y Uso.
Las siguientes secciones son las mínimas que deben estar incluidas en la Documentación de soporte y Uso:
Descripción de las funcionalidades, el contexto donde fue desarrollado y los problemas de desarrollo que ayudó a resolver.
Paso a paso dirigido al usuario final sobre cómo empezar a usar la herramienta digital.
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.
Mención a algún punto de contacto de los autores originales. Esto evita perder el rastro al creador de la herramienta
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.