Language
Ruby
Tool Type
Web app, Manual
License
AM331-A3
Version
1.0.0
Inter-American Development Bank
The IDB Digital Tools Publishing Guide provides a comprehensive set of good practices for documenting, evaluating and licensing digital tools. It establishes the legal and technological standards necessary to ensure that these tools are accessible, reusable and redistributable from anywhere in the world. It was created to cover the need to share knowledge freely and securely, ensuring continuous improvement in publication processes. By legally promoting the use of good practices, the standard of shared knowledge is raised, benefiting a global community of users.
It resolves the need for a standardized framework for the publication of digital tools, ensuring the accessibility and legality of shared knowledge globally.
Publication Guidelines: The guide offers comprehensive guidelines and best practices for publishing digital tools, including documentation, code hosting, and licensing. Transparency: It promotes transparency in digital tool development by encouraging clear documentation, source code availability, and open licensing. Accessibility: The guide emphasizes the importance of making digital tools accessible to a wide range of users, including those with disabilities. Usability: It provides recommendations for enhancing the usability and user experience of digital tools. Customization: Authors and developers can adapt the guide's recommendations to meet the specific publication needs of their digital tools. Documentation: Comprehensive documentation available in the guide assists authors and developers in effectively publishing their digital tools.
Hosted on GitHub Pages and based on Jekyll. Uses open standards and open-source tools to generate static websites and document IDB's digital tools.
Connect with the Development Code team and discover how our carefully curated open source tools can support your institution in Latin America and the Caribbean. Contact us to explore solutions, resolve implementation issues, share reuse successes or present a new tool. Write to [email protected]
This image shows a guide for publishing digital tools, with sections on documenting, evaluating, and licensing to promote use, sustainability, and legal preparedness.
Documentation: should include Description, User Guide, Installation, Authors, and Licenses. Ideal: How to Contribute, Code of Conduct, Badges, Version, and Acknowledgments. Useful links: Markdown Guide.
This image displays a text excerpt describing a guide for publishing digital tools using Jekyll on GitHub, including a brief installation guide with command-line instructions.
Contains the source code and documentation of the guide, facilitating contributions and tracking changes.
Provides a standard structure for documenting digital tools, aligned with publishing guidance.