Tool documentation template
Abstract
What is this tool for? What are the most interesting features?
Introduction
Provide more context about the background of this tool or service. What problem is it trying to solve? How does it contribute to the ecosystem? Why should a user invest time in learning about this tool or service, and what benefits do they gain from using it?
User Guide
This section explains how the tool or service is used from an end-user perspective. What should the user take into account when running the tool? Are there any prerequisites, such as dependency installation or registration? If the tool requires datasets as input, specify the requirements for these datasets, including the expected data format, column types, and any other relevant details.
Known limitations and issues
Be sure to mention any known limitations of the tool or service (if applicable), as well as any issues that are known and will be addressed in the future.
References
Useful links and additional references.