Esta herramienta digital forma parte del catálogo de herramientas del Banco Interamericano de Desarrollo. Puedes conocer más sobre la iniciativa del BID en code.iadb.org
Plantilla de Documentación de Soporte y Uso de herramientas digitales - README.md
Este repositorio está destinado a servir como una plantilla general sobre cómo configurar nuevos repositorios en la organización @ogticrd. Cualquier comentario o recomendación les pedimos generar un issue de consulta o escribirnos directamente a ogtic@gob.do
Nombre de la herramienta
Logo e imagen o gif de la interfaz principal de la herramienta
Tabla de contenidos:
- Descripción y Contexto
- Avisos
- Guía de usuario
- Instalación
- Herramientas
- Licencia
- Versiones
- Información adicional
- Autores
Descripción y Contexto
Asegúrate de empezar este archivo con una breve descripción sobre las funcionalidades y contexto de la herramienta digital. Sé conciso y coherente.
Avisos
En este apartado colocar ciertas consideraciones como:
- Los requisitos del sistema operativo para la compilación (versiones específicas de librerías, software de gestión de paquetes y dependencias, SDKs y compiladores, etc.).
- Las dependencias propias del proyecto, tanto externas como internas (orden de compilación de sub-módulos, configuración de ubicación de librerías dinámicas, etc.).
- Pasos específicos para la compilación del código fuente y ejecución de tests unitarios en caso de que el proyecto disponga de ellos.
Es una buena práctica describir las últimas versiones en las que ha sido probada la herramienta digital.
Guía de usuario
Explica los pasos básicos sobre cómo usar la herramienta digital. Es una buena sección para mostrar capturas de pantalla o gifs que ayuden a entender la herramienta digital.
Instalación
Paso a paso de cómo instalar la herramienta digital. En esta sección es recomendable explicar la arquitectura de carpetas y módulos que componen el sistema.
En algunas ocasiones puede ser necesario instalar componentes que tienen dependencia con la herramienta digital. Si este es el caso revise la sección de Avisos.
Pasos de instalación aquí
Request & Response
API Resources:
GET /example
Response body:
GET /example
Response body:
GET /example
Response body:
Herramientas🛠️
Licencia
Incluye en esta sección una note con el tipo de licencia otorgado a esta herramienta digital. El texto de la licencia debe estar incluído en un archivo LICENSE.md o LICENSE.txt en la carpeta raíz.
Si desconoces qué tipos de licencias existen y cuál es la mejor para cada caso, te recomendamos visitar la página https://choosealicense.com/.
Versiones. 📌
Para ver las versiones disponibles de la herramienta dígital, busca el tags on this repository.
Información adicional
Esta es la sección que permite agregar más información de contexto al proyecto como alguna web de relevancia, proyectos similares o que hayan usado la misma tecnología.
Autores
Nombra a el/los autor/es original/es. Consulta con ellos antes de publicar un email o un nombre personal. Una manera muy común es dirigirlos a sus cuentas de redes sociales.
-
Jonh Doe - Initial work - opticrd
-
Jonh Doe - Maintainer - opticrd
-
Jonh Doe - Continuous Integration - opticrd